odcslint

A fast, Rust-powered linter for Open Data Contract Standard (ODCS) contracts. Full documentation: feliblo.github.io/odcslint

• Fast validation against the official ODCS schema
  • 40-3,200× faster than datacontract lint (see the benchmarks)
• Custom business rules in simple YAML, with autofix
  • approved owners and known domains
  • column order: primary keys first, metadata columns last
  • naming conventions, required fields and tags

Installation

uv tool install odcslint     # as a standalone tool
uv add --dev odcslint        # as a dev dependency of your project

pip install odcslint

brew install feliblo/tap/odcslint

curl -LsSf https://github.com/feliblo/odcslint/releases/latest/download/odcslint-installer.sh | sh

powershell -ExecutionPolicy Bypass -c "irm https://github.com/feliblo/odcslint/releases/latest/download/odcslint-installer.ps1 | iex"

repos:
  - repo: https://github.com/feliblo/odcslint
    rev: v0.2.0
    hooks:
      - id: odcslint-fix   # or `odcslint` to only check

- uses: feliblo/odcslint@v0.2.0
  with:
    paths: contracts/

cargo install --git https://github.com/feliblo/odcslint

Quickstart

odcslint init           # write a starter odcslint.yml
odcslint check          # check every *.odcs.yaml below the current directory
odcslint check --fix    # apply fixes in place
odcslint upgrade        # move contracts to the newest ODCS version

$ odcslint check contracts/
contracts/orders.odcs.yaml
  13:17  error    approved_owners  team member username `mallory` is not allowed; allowed values: alice, bob
  20:9   error    property_order   expected `order_id` at position 1 of `orders`, found `_loaded_at` [*]

contracts/payments.odcs.yaml
  6:1  error    schema  unexpected property `owner`

Found 3 errors and 0 warnings (2 files checked). 1 finding marked [*] can be fixed with `odcslint check --fix`.

Enable rules in odcslint.yml:

rules:
  - type: property_order          # primary keys first, metadata columns last (fixable)
  - type: allowed_values
    field: team.members.username
    role: owner
    values: [alice, bob]

See the rules and configuration docs for everything else.

Acknowledgements

odcslint stands on the work of the Bitol community and the LF AI & Data Foundation, who develop and maintain the Open Data Contract Standard in the open. Their JSON Schemas are embedded in odcslint, and their examples and negative tests make up much of its test suite. Thank you to everyone who contributes to the standard.

License

odcslint is released under the MIT license. The embedded ODCS JSON Schemas are © The Bitol Contributors and licensed under Apache-2.0 (see licenses/).