@daml-tools/daml-fmt 0.4.2 → 0.6.0

package/README.md

@@ -41,21 +41,23 @@ imports; use `--preserve-import-order` when package identity stability matters.
 
 ## Documentation
 
-The workspace docs split task guides, reference, and design background:
+The workspace documentation is organized under
+[`docs`](https://github.com/stevennevins/daml-tools/blob/main/docs/README.md):
 
-- [Format Daml source](../../docs/how-to/format-daml.md) for CLI usage patterns
-- [Verify a formatter change](../../docs/how-to/verify-formatter-change.md) for
+- [Format Daml source](https://github.com/stevennevins/daml-tools/blob/main/docs/how-to/format-daml.md) for CLI usage patterns
+- [Verify a formatter change](https://github.com/stevennevins/daml-tools/blob/main/docs/how-to/verify-formatter-change.md) for
   corpus, baseline, and audit commands
-- [CLI reference](../../docs/reference/cli.md) for options and exit codes
-- [Crate reference](../../docs/reference/crates.md) for features, binaries, and
+- [CLI reference](https://github.com/stevennevins/daml-tools/blob/main/docs/reference/cli.md) for options and exit codes
+- [Crate reference](https://github.com/stevennevins/daml-tools/blob/main/docs/reference/crates.md) for features, binaries, and
   public API
-- [Formatter verification model](../../docs/explanation/formatter-verification.md)
+- [Formatter verification model](https://github.com/stevennevins/daml-tools/blob/main/docs/explanation/formatter-verification.md)
   for the token/desugar/idempotence safety story
 
 ## Build & install
 
-daml-fmt depends only on the [`daml-parser`](https://crates.io/crates/daml-parser) crate (the shared
-lexer + offside layout + parser), never on `daml-lint`. Both live in the
+daml-fmt depends only on the [`daml-parser`](https://crates.io/crates/daml-parser) and
+[`daml-syntax`](https://crates.io/crates/daml-syntax) crates (the shared lexer, layout,
+and source-map pipeline), never on `daml-lint`. Both live in the
 [daml-tools](https://github.com/stevennevins/daml-tools) workspace, so a normal
 workspace checkout has everything it needs.
 
@@ -89,6 +91,36 @@ cat Foo.daml | daml-fmt                            # stdin -> stdout
 
 Exit codes: 0 ok, 1 `--check` found unformatted files, 2 error.
 
+## Library API
+
+`daml-fmt` is also a Rust library. The primary entry points are
+`format_source` (defaults) and `format_source_with_options`. Use
+`try_format_source` / `try_format_source_with_options` when callers need a typed
+[`FormatError`] instead of a byte-faithful passthrough on malformed input.
+`source_diagnostics` and `lex_diagnostics` return typed [`FormatDiagnostic`] values.
+
+```rust
+use daml_fmt::{
+    format_source, format_source_with_options, try_format_source, FormatOptions, ImportOrder,
+};
+
+let formatted = format_source("module M where\nfoo : Int\nfoo = 1\n");
+
+let preserved = format_source_with_options(
+    "module M where\nimport DA.List\nimport DA.Optional\n\nx = []\n",
+    FormatOptions::new().with_import_order(ImportOrder::Preserve),
+);
+
+let checked = try_format_source("module M where\nfoo: Int\nfoo = 1\n").expect("valid source");
+assert_eq!(checked, formatted);
+```
+
+`ImportOrder` is `#[non_exhaustive]` for forward-compatible `match` arms.
+`FormatOptions` uses private fields: construct options with `Default`/`new()` and
+`with_*` helpers so new switches can ship with defaults without breaking callers.
+
+See [crate reference](https://github.com/stevennevins/daml-tools/blob/main/docs/reference/crates.md) for the full public API.
+
 ## Workspace-Only Tests
 
 These commands require a full repository checkout. The published crate excludes
@@ -120,7 +152,7 @@ Review-oriented full-corpus audit packets:
 npm run audit                       # writes target/daml-fmt-audit
 ```
 
-See `docs/audit-workflow.md` for the 25-sample subagent review workflow.
+See [audit workflow](https://github.com/stevennevins/daml-tools/blob/main/crates/daml-fmt/docs/audit-workflow.md) for the 25-sample subagent review workflow.
 
 The structural candidate metric (edit candidates over modeled constructs):
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@daml-tools/daml-fmt",
-  "version": "0.4.2",
+  "version": "0.6.0",
   "description": "A canonical code formatter for the Daml smart-contract language, built on daml-parser",
   "keywords": [
     "daml",
@@ -9,6 +9,7 @@
     "code-formatter",
     "smart-contracts"
   ],
+  "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-fmt-darwin-arm64": "0.4.2",
-    "@daml-tools/daml-fmt-linux-arm64": "0.4.2",
-    "@daml-tools/daml-fmt-linux-x64": "0.4.2",
-    "@daml-tools/daml-fmt-win32-x64": "0.4.2"
+    "@daml-tools/daml-fmt-darwin-arm64": "0.6.0",
+    "@daml-tools/daml-fmt-linux-arm64": "0.6.0",
+    "@daml-tools/daml-fmt-linux-x64": "0.6.0",
+    "@daml-tools/daml-fmt-win32-x64": "0.6.0"
   },
   "publishConfig": {
     "access": "public"