@daml-tools/daml-lint 0.6.2 → 0.8.0

package/README.md

@@ -20,18 +20,18 @@ that fail to parse degrade to partial structure with a diagnostic on stderr
 
 The workspace docs split task guides, reference, and design background:
 
-- [Scan Daml source](../../docs/how-to/scan-daml.md) for CLI usage patterns
-- [Write a custom rule](../../docs/tutorials/write-a-daml-lint-custom-rule.md)
+- [Scan Daml source](https://github.com/stevennevins/daml-tools/blob/main/docs/how-to/scan-daml.md) for CLI usage patterns
+- [Write a custom rule](https://github.com/stevennevins/daml-tools/blob/main/docs/tutorials/write-a-daml-lint-custom-rule.md)
   for a guided first external rule
-- [Custom rule contract](../../docs/reference/daml-lint-custom-rule-contract.md)
+- [Custom rule contract](https://github.com/stevennevins/daml-tools/blob/main/docs/reference/daml-lint-custom-rule-contract.md)
   for the JavaScript runtime contract and TypeScript types
-- [CLI reference](../../docs/reference/cli.md) for options, output formats, and
+- [CLI reference](https://github.com/stevennevins/daml-tools/blob/main/docs/reference/cli.md) for options, output formats, and
   exit codes
-- [Crate reference](../../docs/reference/crates.md) for features and public
+- [Crate reference](https://github.com/stevennevins/daml-tools/blob/main/docs/reference/crates.md) for features and public
   modules
-- [Rule authoring model](../../docs/explanation/daml-lint-rule-authoring.md)
+- [Rule authoring model](https://github.com/stevennevins/daml-tools/blob/main/docs/explanation/daml-lint-rule-authoring.md)
   for why TypeScript authoring is bundled to JavaScript
-- [Workspace architecture](../../docs/explanation/workspace-architecture.md)
+- [Workspace architecture](https://github.com/stevennevins/daml-tools/blob/main/docs/explanation/workspace-architecture.md)
   for how `daml-lint` uses `daml-parser`
 
 ## Detectors
@@ -81,7 +81,7 @@ The default features build the published CLI and custom-rule engine:
 
 ```toml
 [dependencies]
-daml-lint = "0.2"
+daml-lint = "0.8"
 ```
 
 Library consumers that only need parser lowering and the rule-facing IR can
@@ -89,16 +89,16 @@ avoid the CLI parser and QuickJS runtime:
 
 ```toml
 [dependencies]
-daml-lint = { version = "0.2", default-features = false }
+daml-lint = { version = "0.8", default-features = false }
 ```
 
 The `js-runtime` feature enables the QuickJS-backed runtime used by shipped
-built-ins. The `custom-rules` feature enables loading user-provided rule files
-through `--rules` when the runtime is also enabled. Shipped built-ins are
-authored in TypeScript and embedded as generated JavaScript; no TypeScript
+built-ins. The `custom-rules` feature implies `js-runtime` and enables loading
+user-provided rule files through `--rules` and configured plugin packages.
+Shipped built-ins are authored in TypeScript and embedded as generated JavaScript; no TypeScript
 toolchain is required at runtime. The shipped detectors are registered through
 `create_builtin_detectors()` rather than exposed as individual Rust detector
-modules. The `cli` feature exists for the `daml-lint` binary.
+modules. The `cli` feature enables the `daml-lint` binary and implies `js-runtime`.
 
 ## Usage
 
@@ -216,8 +216,9 @@ Statements carry a typed expression AST: `stmt.Let.value`,
 `stmt.Other.expr` are `Expr` nodes — tagged unions like
 `{ BinOp: { op: "/", lhs, rhs, span } }` with a 1-based `span` on every
 node (see the `Expr` type in the .d.ts). Type-bearing fields carry `TypeNode`
-trees such as `{ Con: { name: "Party", qualifier: null, span } }` and
-`{ App: { head, args, span } }`; type spans include `line`/`column`,
+trees such as `{ Con: { name: "Party", qualifier: null, span } }`,
+`{ App: { head, args, span } }`, and `{ Lit: { kind: "Text", value: "cid", span } }`
+for type-level literals (for example `HasField "cid"`); type spans include `line`/`column`,
 JavaScript string offsets (`start`/`end`, suitable for
 `m.source.slice(start, end)`), and parser byte offsets
 (`byte_start`/`byte_end`). Compatibility-only raw-text fields and rendered
@@ -315,13 +316,26 @@ provenance and licensing.
 ## Public API Stability
 
 `daml-lint` is pre-1.0. The CLI exit codes and documented feature flags are the
-stable user contract for 0.2.x. The rule-facing IR is intentionally public for
+stable user contract for 0.7.x. The rule-facing IR is intentionally public for
 custom rules and library users, but it may gain structure in 0.x minor releases;
 custom rules should check `ir_version` and match typed nodes rather than raw
 source substrings. Detector result types such as `Finding`, `Severity`, and
 `DetectError` are non-exhaustive; use their documented fields/accessors and keep
 wildcard arms when matching enums. Patch releases should remain compatible.
 
+Breaking updates introduced in this branch:
+
+- `Severity` no longer implements `Ord`/`PartialOrd`; use `rank()` or
+  `meets_or_exceeds()` for risk-based ordering and thresholds.
+- `Severity::from_str` now returns `SeverityParseError` instead of `()`.
+- Public IR/report DTO structs are `#[non_exhaustive]`; construct through
+  parser lowering or documented constructors such as `Finding::new`.
+- `parse_daml_with_diagnostics` now returns a named `ParseResult` with fields
+  (`module`, `diagnostics`) instead of a tuple.
+- Rule setting values are now canonical only: `off`, `critical`, `high`,
+  `medium`, `low`, `info` (legacy `warn`/`error` and numeric shortcuts
+  `0`/`1`/`2` are intentionally rejected).
+
 ## License
 
 AGPL-3.0-only. See [LICENSE](LICENSE).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@daml-tools/daml-lint",
-  "version": "0.6.2",
+  "version": "0.8.0",
   "description": "Static analysis scanner for Daml smart contracts",
   "keywords": [
     "daml",
@@ -9,6 +9,7 @@
     "smart-contracts",
     "security"
   ],
+  "homepage": "https://github.com/stevennevins/daml-tools",
   "license": "AGPL-3.0-only",
   "author": "Steven Nevins",
   "repository": {
@@ -22,10 +23,10 @@
     "node": ">=18"
   },
   "optionalDependencies": {
-    "@daml-tools/daml-lint-darwin-arm64": "0.6.2",
-    "@daml-tools/daml-lint-linux-arm64": "0.6.2",
-    "@daml-tools/daml-lint-linux-x64": "0.6.2",
-    "@daml-tools/daml-lint-win32-x64": "0.6.2"
+    "@daml-tools/daml-lint-darwin-arm64": "0.8.0",
+    "@daml-tools/daml-lint-linux-arm64": "0.8.0",
+    "@daml-tools/daml-lint-linux-x64": "0.8.0",
+    "@daml-tools/daml-lint-win32-x64": "0.8.0"
   },
   "publishConfig": {
     "access": "public"