Sign inSign up

canembed/cstylecheck

By canembed

•Updated 14 days ago

Image
0

5.3K

canembed/cstylecheck repository overview

⁠CStyleCheck

Embedded C Style Compliance Checker for GitHub Actions, pre-commit hooks, and Docker. Implements Barr-C:2018 and MISRA-C complementary rules across 73 rule IDs.

Tests Docker

📖 Full documentation and source⁠

⁠Quick start

# Mount your project at /repo and scan all C/H files
docker run --rm \
  -v "$(pwd):/repo" \
  dermot-murphy/cstylecheck:latest \
  --config /app/rules.yml \
  /repo/source/**/*.c /repo/source/**/*.h

Use --include for reliable glob expansion inside the container:

docker run --rm \
  -v "$(pwd):/repo" \
  dermot-murphy/cstylecheck:latest \
  --config /app/rules.yml \
  --include "/repo/source/**/*.c" \
  --include "/repo/source/**/*.h"

Windows CMD:

docker run --rm -v "C:/MyProject:/repo" dermot-murphy/cstylecheck:latest ^
  --config /app/rules.yml ^
  --include "/repo/source/**/*.c" --include "/repo/source/**/*.h"

⁠GitHub Actions

# .github/workflows/cstylecheck.yml
- uses: dermot-murphy/CStyleCheck@v1
  with:
    config: src/rules.yml
    include: |
      source/**/*.c
      source/**/*.h
    fail-on: error
    sarif-file: results/cstylecheck.sarif

- name: Upload to GitHub Code Scanning
  uses: github/codeql-action/upload-sarif@v3
  if: always()
  with:
    sarif_file: results/cstylecheck.sarif

⁠pre-commit

# .pre-commit-config.yml
repos:
  - repo: https://github.com/dermot-murphy/CStyleCheck
    rev: v1.6.1
    hooks:
      - id: cstylecheck
        args:
          - --config
          - rules.yml

⁠Key CLI flags

FlagPurpose
--config FILEYAML rule config (default: rules.yml)
--include GLOBSource glob to scan (repeatable)
--exclude GLOBPath/directory to exclude (repeatable)
--output-format FORMATtext (default), json, sarif, or html
--summaryPrint per-file violation summary table
--github-actionsEmit ::error/::warning annotations
--warnings-as-errorsPromote all warnings to errors
--baseline-file FILESuppress violations in saved baseline
--write-baseline FILEWrite current violations as baseline
--fixAuto-fix safe mechanical violations in-place
--dry-runWith --fix: show diff without writing
--per-dir-configWalk upward for .cstylecheck.yml overrides
--initInteractive config wizard
--preset PRESETPre-built config (barr-c, minimal, misra)
--verbosePrint file being scanned
--exit-zeroAlways exit 0 (warning-only CI steps)

Exit codes: 0 clean · 1 errors found · 2 config/invocation error.

⁠Rule categories (73 rule IDs)

CategoryRule IDs
Constants / macrosconstant.case constant.min_length constant.max_length constant.prefix macro.case macro.min_length macro.max_length macro.prefix macro.trailing_semicolon macro.multistatement_wrapper
Variablesvariable.global.case variable.global.prefix variable.global.g_prefix variable.static.case variable.static.prefix variable.static.s_prefix variable.local.case variable.local.prefix variable.parameter.case variable.parameter.prefix variable.parameter.p_prefix variable.min_length variable.max_length variable.pointer_prefix variable.pp_prefix variable.bool_prefix variable.handle_prefix variable.no_numeric_in_name variable.prefix_order
Functionsfunction.prefix function.style function.min_length function.max_length function.static_prefix
Typestypedef.case typedef.suffix enum.type_case enum.type_suffix enum.member_case enum.member_prefix struct.tag_case struct.tag_suffix struct.member_case
Include guardsinclude_guard.missing include_guard.format
Namingnaming.identifier_length naming.no_single_char_identifiers
Miscmisc.copyright_header misc.eof_comment misc.line_length misc.indentation misc.magic_number misc.unsigned_suffix misc.lowercase_l_suffix misc.yoda_condition misc.block_comment_spacing misc.comment_ratio misc.whitespace_ratio misc.declared_not_defined misc.function_length misc.function_doc_header misc.assert_density misc.null_statement_comment misc.declaration_spacing misc.file_length misc.reserved_header_name misc.non_ascii_source misc.octal_constant misc.trigraph misc.constant_comparison
Otherreserved_name spell_check sign_compatibility

⁠Inline suppression

uint32_t g_counter = 42;  // cstylecheck: disable=variable.global.g_prefix

// cstylecheck: disable-next-line=misc.magic_number
uint8_t mask = 0xA5;

// cstylecheck: disable=misc.unsigned_suffix
uint32_t raw_a = 1;
uint32_t raw_b = 2;
// cstylecheck: enable=misc.unsigned_suffix

⁠Baseline suppression (legacy codebases)

# Record all existing violations once
python src/cstylecheck.py --write-baseline .cstylecheck-baseline.json \
    --include "source/**"

# CI now only fails on NEW violations
python src/cstylecheck.py --baseline-file .cstylecheck-baseline.json \
    --include "source/**"

⁠Output formats

⁠JSON
docker run --rm -v "$(pwd):/repo" dermot-murphy/cstylecheck:latest \
  --output-format json --include "/repo/source/**" \
  | python -c "import sys,json; d=json.load(sys.stdin); print(d['summary'])"
⁠SARIF (GitHub Code Scanning)
docker run --rm -v "$(pwd):/repo" dermot-murphy/cstylecheck:latest \
  --output-format sarif --include "/repo/source/**" \
  --log /repo/results.sarif
⁠HTML report
docker run --rm -v "$(pwd):/repo" dermot-murphy/cstylecheck:latest \
  --output-format html --include "/repo/source/**" \
  --log /repo/report.html

⁠Image tags

TagDescription
latestLatest main branch build
1.6.1 / 1.6 / 1Specific semantic version
sha-<short>Exact commit SHA

Images are available for linux/amd64 and linux/arm64.

⁠Dictionary files (runtime override)

The image ships default dictionaries at /app/. Override at runtime:

docker run --rm -v "$(pwd):/repo" dermot-murphy/cstylecheck:latest \
  --keywords-file /repo/my_keywords.txt \
  --stdlib-file   /repo/my_stdlib.txt   \
  --spell-dict    /repo/my_words.txt    \
  /repo/source/**/*.c

⁠Links

Tag summary

Content type

Image

Digest

sha256:2d98ab3cc…

Size

78.6 MB

Last updated

14 days ago

docker pull canembed/cstylecheck