Rules¶
Rules are off by default. To turn one on, add it to the rules list in your config. On top of its own options, every rule accepts name, severity, description, includes and excludes. Rules marked in the Autofix column are fixed by odcslint check --fix.
| Rule | What it checks | Autofix |
|---|---|---|
allowed_values |
A field only uses allowed values: owners, domains, statuses, tenants, types, classifications, tags or custom properties | |
deprecated_fields |
No deprecated ODCS fields are used | |
file_naming |
File names follow a pattern and/or match the contract id or name |
|
has_description |
Contracts, schema objects or properties have a description | |
id_format |
The contract id is a UUID or matches a pattern |
|
naming_convention |
Schema object and property names follow a naming convention | |
primary_key |
primaryKey and primaryKeyPosition are consistent |
|
property_order |
Primary keys come first and metadata columns last | |
required_fields |
Fields are present and non-empty | |
required_tags |
Tags are present | |
unique_names |
Schema object or property names are unique |
odcslint rules prints the same list in your terminal.