jbzoo/CSV Blueprint - Lint and validate by schemas
Strict and flexible schema-based CSV file validation with the ability to report as GitHub Annotations in your PRs.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| csv | Specify the path(s) to the CSV files you want to validate. This can include a direct path to a file or a directory to search with a maximum depth of 10 levels. Examples: p/file.csv; p/*.csv; p/**/*.csv; p/**/name-*.csv; **/*.csv | yes | — |
| schema | Specify the path(s) to the schema file(s), supporting YAML, JSON, or PHP formats. Similar to CSV paths, you can direct to specific files or search directories with glob patterns. Examples: p/file.yml; p/*.yml; p/**/*.yml; p/**/name-*.yml; **/*.yml | yes | — |
| report | Report format. Available options: text, table, github, gitlab, teamcity, junit. | yes | table |
| apply-all | Apply all schemas (also without `filename_pattern`) to all CSV files found as global rules. Available options: auto: If no glob pattern (*) is used for --schema, the schema is applied to all found CSV files. yes: Apply all schemas to all CSV files, Schemas without `filename_pattern` are applied as a global rule. no: Apply only schemas with not empty `filename_pattern` and match the CSV files. | yes | auto |
| quick | Quick mode. It will not validate all rows. It will stop after the first error. | yes | no |
| skip-schema | Skip schema validation. If you are sure that the schema is correct, you can skip this check. | yes | no |
| extra | Extra options for the CSV Blueprint. Only for debugging and profiling. Available options: Add flag `--parallel` if you want to validate CSV files in parallel. Add flag `--dump-schema` if you want to see the final schema after all includes and inheritance. Add flag `--debug` if you want to see more really deep details. Add flag `--profile` if you want to see profiling info. Add details with `-vvv`. Verbosity level: Available options: `-v`, `-vv`, `-vvv` ANSI output. You can disable ANSI colors if you want with `--no-ansi`. | — | options: --ansi |
Outputs
no outputs