TLint

Validation engine for Trento Checks DSL.

Usage

$ tlint -h
tlint 0.9.5

USAGE:
    tlint <SUBCOMMAND>

OPTIONS:
    -h, --help       Print help information
    -V, --version    Print version information

SUBCOMMANDS:
    help    Print this message or the help of the given subcommand(s)
    lint
    show

TLint accepts standard input (until EOF):

$ cat check.yml | target/debug/tlint lint
  156F64   - expectations - List must not be empty

Or you can use the positional argument to directly let TLint pick a file.

$ tlint lint check.yml
  156F64   - expectations - List must not be empty

If you need to, you can opt out of some validation rules via the --rule option. This can be useful when you want to skip the link validation.

Running TLint as a container image

Currently, if you do not want to build TLint yourself, the most convenient solution is to run TLint as a container image.

You can put this useful alias into your shell configuration:

alias tlint='docker run --rm -i -v ${PWD}:/data ghcr.io/trento-project/tlint:latest'

Development

Looking to build TLint from source, run its test suite, or work on the browser-based playground? See:

  • docs/TLint: the tlint CLI/library: building, testing, linting, project layout, and the container image.

  • docs/TLint web: the WebAssembly build and the browser playground at www/: building, project layout, and its container image.