dermot-murphy/CStyleCheck
Embedded C Style Compliance Checker (Barr-C / MISRA-C complementary)
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| config | Path to the YAML rule configuration file, relative to the workspace root. | no | src/rules.yml |
| include | Newline- or space-separated glob patterns for source files to scan. Defaults to source/**/*.c and source/**/*.h. | no | source/**/*.c source/**/*.h |
| exclude | Newline- or space-separated glob patterns to exclude from scanning. | no | "" |
| options-file | Path to an options file read via --options-file. Options in the file are applied before any other arguments so explicit inputs always win. | no | "" |
| defines | Path to a project defines file (--defines). | no | "" |
| aliases | Path to a module alias map file (--aliases). | no | "" |
| exclusions | Path to a per-file rule exclusion YAML (--exclusions). | no | "" |
| copyright | Path to a plain-text file containing the copyright block comment template (--copyright). When supplied, every C source file must begin with this block comment (followed by one blank line). The year on the '(C) Copyright YEAR' line may differ from the template. | no | "" |
| baseline-file | Path to a baseline JSON file produced by --write-baseline. Violations present in the baseline are suppressed so CI only fails on new ones. | no | "" |
| warnings-as-errors | Promote all warnings and info-level messages to errors. | no | false |
| fail-on | Minimum severity level that causes the action to exit with code 1. Accepted values: error | warning | info | never. 'error' �� fail only if there are error-level violations (default). 'warning' — fail if there are errors or warnings. 'info' — fail on any violation. 'never' — always exit 0 (useful for annotation-only steps). | no | error |
| sarif-file | If set, CStyleCheck also writes a SARIF 2.1.0 file to this path. Intended for upload to GitHub Code Scanning via github/codeql-action/upload-sarif. | no | "" |
| args | Verbatim extra arguments appended to the cstylecheck command line. Use this as an escape hatch for any flag not exposed as a dedicated input. | no | "" |
Outputs
| name | description |
|---|---|
| violations | Total number of violations (all severity levels combined). |
| errors | Number of error-level violations. |
| warnings | Number of warning-level violations. |
| info | Number of info-level violations. |
| sarif-file | Absolute path to the SARIF output file, if sarif-file input was given. |