@daml-tools/lint-plugin 0.3.2 → 0.3.4

package/README.md

@@ -1,7 +1,7 @@
 # @daml-tools/lint-plugin
 
-TypeScript types and starter templates for external `daml-lint --rules`
-custom rule plugin authors.
+TypeScript types and starter templates for external `daml-lint` custom rule
+plugin authors.
 
 Install it with TypeScript and esbuild in your rule project:
 
@@ -14,7 +14,24 @@ 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`.
+it to `daml-lint --rules` or exposing it from a plugin package.
+
+Installed plugin packages expose bundled rules from `package.json`:
+
+```json
+{
+  "name": "daml-lint-plugin-template",
+  "damlLint": {
+    "rules": {
+      "template-requires-ensure": "dist/template-requires-ensure.js"
+    }
+  }
+}
+```
+
+Consumers enable installed rules from `.daml-lint.json` 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.

package/dist/index.d.ts

@@ -282,6 +282,9 @@ export type DamlLintRuleModule = {
 export type DamlLintReportTarget = { span: Span } | { span: SrcPos } | number;
 
 declare global {
+  /** Per-rule options from `.daml-lint.json`. Defaults to `{}`. */
+  var CONFIG: unknown;
+
   var __daml_lint_rule: DamlLintRuleModule | undefined;
 
   /** Report a finding at a node's span, or at an explicit 1-based line number.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@daml-tools/lint-plugin",
-  "version": "0.3.2",
+  "version": "0.3.4",
   "description": "TypeScript contract and starter templates for daml-lint custom rule plugins",
   "license": "AGPL-3.0-only",
   "repository": {

package/templates/project/.daml-lint.json

@@ -0,0 +1,7 @@
+{
+  "pluginPaths": ["."],
+  "plugins": ["template-requires-ensure"],
+  "rules": {
+    "template-requires-ensure/template-requires-ensure": "medium"
+  }
+}

package/templates/project/README.md

@@ -1,20 +1,31 @@
 # daml-lint plugin starter
 
-This project shows the minimal TypeScript flow for a `daml-lint --rules`
-custom rule plugin.
+This project shows the minimal TypeScript flow for a `daml-lint` custom rule
+plugin loaded through `.daml-lint.json`.
 
 ```sh
 npm install
 npm run check
 npm run build
-daml-lint fixtures/missing-ensure.daml --rules dist/template-requires-ensure.js --fail-on info
-daml-lint fixtures/with-ensure.daml --rules dist/template-requires-ensure.js --fail-on info
+npm run lint:missing
+npm run lint:clean
 ```
 
 The first scan reports one `template-requires-ensure` finding. The second scan
 has no finding from the custom rule.
 
+The package manifest exposes bundled rule files under `damlLint.rules`.
+`.daml-lint.json` uses `pluginPaths: ["."]` so the project can resolve itself
+before it is published. After publishing, consumers install the package and
+enable rules by `plugin/rule` ID.
+
 The runtime still discovers top-level metadata constants and visitor
 `function` declarations. The `globalThis.__daml_lint_rule` assignment gives
 TypeScript a single rule object to validate, but it is not the only runtime
 discovery mechanism.
+
+For a one-off script test, the bundled JavaScript can still be passed directly:
+
+```sh
+daml-lint fixtures/missing-ensure.daml --rules dist/template-requires-ensure.js --fail-on info
+```

package/templates/project/package.json

@@ -6,11 +6,16 @@
   "scripts": {
     "check": "tsc --noEmit",
     "build": "esbuild src/template-requires-ensure.ts --bundle --format=esm --target=es2020 --outfile=dist/template-requires-ensure.js",
-    "lint:missing": "daml-lint fixtures/missing-ensure.daml --rules dist/template-requires-ensure.js --fail-on info",
-    "lint:clean": "daml-lint fixtures/with-ensure.daml --rules dist/template-requires-ensure.js --fail-on info"
+    "lint:missing": "daml-lint fixtures/missing-ensure.daml --fail-on info",
+    "lint:clean": "daml-lint fixtures/with-ensure.daml --fail-on info"
+  },
+  "damlLint": {
+    "rules": {
+      "template-requires-ensure": "dist/template-requires-ensure.js"
+    }
   },
   "devDependencies": {
-    "@daml-tools/lint-plugin": "^0.3.2",
+    "@daml-tools/lint-plugin": "^0.3.4",
     "esbuild": "^0.28.1",
     "typescript": "^6.0.3"
   }