@daml-tools/lint-plugin

TypeScript types and starter templates for external daml-lint custom rule plugin authors.

Install it with TypeScript and esbuild in your rule project:

npm pkg set type=module
npm install --save-dev @daml-tools/daml-lint @daml-tools/lint-plugin typescript esbuild

Author rules in TypeScript, keep top-level const NAME, const SEVERITY, an optional const DESCRIPTION, and top-level visitor function declarations, then assign the same values to globalThis.__daml_lint_rule so TypeScript can validate the rule object. Bundle the rule to one JavaScript file before passing it to daml-lint --rules or exposing it from a plugin package.

Installed plugin packages expose bundled rules from package.json:

{
  "name": "daml-lint-plugin-template",
  "damlLint": {
    "rules": {
      "template-requires-ensure": "dist/template-requires-ensure.js"
    }
  }
}

Consumers enable installed rules from daml.yaml under daml-tools.lint.rules with plugin/rule IDs. Rule options from [severity, options] settings are available as global CONFIG.

Runtime helper functions are intentionally not exported. The package is the public rule-facing IR contract and starter templates for plugin projects.