Docs menu

Reference

The lexlint.yml schema

The JSON Schema lexlint.yml validates against, published at its own $id.

Where it lives

The schema is published at https://lexlint.io/schema/lexlint.schema.json and that address is its $id. The plugin validates against its own bundled copy, so the file is read locally and nothing fetches this address at run time.

Fields

The top level of the schema, one row per field. What each one declares is on The app profile.

FieldTypeRequiredWhat it declares
versionintegeryesMust be 1.
appobjectyesAn object with name (required), repo, scope.
profileobjectyesYour declaration. LexLint never infers this from your code.
lintobjectnoWritten by the lint, except work_items, which triage writes. Yours to edit: work_items, and state, where, note and handled_by on a finding. A re-run carries all of those across and refreshes the rest.