lawspec 0.2.0 → 0.2.1

package/README.md

@@ -8,28 +8,35 @@ WebAssembly with a Node CLI and an asynchronous, typed JavaScript API.
 
 ## Install and try it
 
-The checkout includes the npm package in `npm/`. Build an installable archive:
+Install [LawSpec from npm](https://www.npmjs.com/package/lawspec):
 
 ```sh
-npm pack ./npm
-npm install --save-dev ./lawspec-0.2.0.tgz
+npm install --save-dev lawspec@0.2.1
+npx lawspec --version
 ```
 
-No Haskell toolchain is needed to install or run the npm package. Node 22+ and the
-selected target's build tools are required. The reference platforms are macOS
-and Linux. Stable releases are available as the `lawspec` package on npm.
+Node 22+ and the selected target's build tools are required. No Haskell toolchain
+is needed to install or run LawSpec. The reference platforms are macOS and Linux.
+Use `npx lawspec` to run the locally installed CLI.
 
-From an empty application directory, use the installed `lawspec` command:
+To try it in a **new, empty directory**, initialize the starter before installing
+local dependencies so LawSpec can create its `package.json` and test script:
 
 ```sh
-lawspec init --target javascript
-npm install
-lawspec check
-lawspec explain 'example.atoi_codec::itoa and then atoi yields a'
-lawspec doctor
-lawspec generate
+mkdir lawspec-example
+cd lawspec-example
+npm exec --package=lawspec@0.2.1 -- lawspec init --target javascript
+npm install --save-dev lawspec@0.2.1
+npx lawspec check
+npx lawspec explain 'example.atoi_codec::itoa and then atoi yields a'
+npx lawspec doctor
+npx lawspec generate
 ```
 
+In an existing project, install LawSpec first, then run
+`npx lawspec init --target javascript`. Existing build files are preserved;
+apply the printed dependency and test-runner setup instructions before generation.
+
 Implement `src/example/atoi_codec.mjs`, then run `npm test`:
 
 ```javascript
@@ -192,7 +199,7 @@ This expands to `for all (x :: Int32) . render (x) = referenceRender (x)`.
 The example inherits the input name `x` from the prelude. Both functions are
 user-owned adapter functions; either may delegate to your existing code.
 
-[The complete example](examples/specs/equivalent.lawspec) compares decimal
+[The complete example](https://github.com/brain-fuel/lawspec/blob/v0.2.1/examples/specs/equivalent.lawspec) compares decimal
 renderers and two implementations that clamp negative integers to zero. For
 JavaScript, their adapters can be:
 
@@ -247,6 +254,10 @@ by the JS shim.
 
 ## Build and verify
 
+For contributors working from a repository checkout, build a local archive with
+`npm pack ./npm` and install it with `npm install --save-dev ./lawspec-0.2.1.tgz`.
+The package payload lives in `npm/`.
+
 ```sh
 stack test
 # With wasm32-wasi-cabal and wasm32-wasi-ghc installed:

package/bin/lawspec.mjs

@@ -153,13 +153,13 @@ async function init() {
 async function main() {
   if (!verb || ["help", "--help", "-h"].includes(verb)) {
     output(
-      "LawSpec 0.2.0\nUsage: lawspec init --target <language> [--project <directory>]\n       lawspec check | doctor | explain <unit>::<law> | generate\nOptions: --config <path>, --target <language>, --json\nGeneration: --dry-run, --check\nTargets: " +
+      "LawSpec 0.2.1\nUsage: lawspec init --target <language> [--project <directory>]\n       lawspec check | doctor | explain <unit>::<law> | generate\nOptions: --config <path>, --target <language>, --json\nGeneration: --dry-run, --check\nTargets: " +
         targets.join(", "),
     );
     return;
   }
   if (verb === "--version") {
-    output("0.2.0");
+    output("0.2.1");
     return;
   }
   if (positional.length > (verb === "explain" ? 1 : 0))

package/build.json

@@ -17,10 +17,10 @@
     "wasm/lawspec-wasm.cabal"
   ],
   "digests": {
-    "package.yaml": "f8d2b6bbf4308890903787813994500d4843cd08ee5bc1ae3808a49461d51380",
+    "package.yaml": "2cc5254bf0c1de94adbb98ee193dd45f5d8e5efced9ce255508112ccbca96793",
     "src/LawSpec/Api.hs": "00b1e4bc81231ebd387f10652463904084ebf9c3c4486fd2c2217a6d4dbfc157",
     "src/LawSpec/Compile.hs": "c1727ba7d6ece9725567f9561d341d8660b3293ff845c2de1d936ebdd2cd5fc6",
-    "src/LawSpec/Emit.hs": "24edca3a078ea10349b3a229b56464c37bfd5303c688a11ed45f9479ce3b7bd1",
+    "src/LawSpec/Emit.hs": "4e223dfc975c5b66021e7a012a063edd159fe38ca12df7d009aa3de472a2e646",
     "src/LawSpec/Gen.hs": "b283001bc18971ddb2159f2ec7e51ac58aa7e191b52577006140694b09a06987",
     "src/LawSpec/Model.hs": "8f501e134cd1480261ae8bb9e3df8255efd38a02eb883468c6bc2c342e200970",
     "src/LawSpec/Parser.hs": "f546502c6eedb0a4ccd30d11e3b017aedf5a7145080ea58cfd34753fd9b509c6",
@@ -30,8 +30,8 @@
     "wasm/app/Exports.hs": "4ecbdac8faa2449e6fc61b93c82e6278fa14374154f29b4dacf0eef433f06a47",
     "wasm/cabal.project": "021e560afdc5eb4cb7169e7119ecb8f92c9ee170245af909c94b612941bff5cc",
     "wasm/cabal.project.freeze": "733dbed3d2ecccb26e874fd58f136296dad772184deb1658c196b5d54a0814dc",
-    "wasm/lawspec-wasm.cabal": "48a9a7587f183565043e313e20e531c72d2eeb4ec706a1052ff0e7b461961002",
-    "npm/core.wasm": "fe4048e604bbdf5ddbecf9ea2e9b27ac60161788fff35524cbcf9825e2e8faeb",
+    "wasm/lawspec-wasm.cabal": "139de82d2d6063eb82fc86438a82e59d9b9315318009cad199f488bca14cb56d",
+    "npm/core.wasm": "943abf2084a7395ef6c5441ef4fd93aa0d57e581a0e71723bf6187afa2c3b48c",
     "npm/core_jsffi.js": "88d136efe92f7cff5758c8fec8d9b6bbc9707fe37741cebeeb415fe34ce3d72b",
     "npm/api.mjs": "d6df654600172131ac66a55b86876fc29cde2a76a0a63bbefff3183488a4837b",
     "npm/index.d.ts": "8003304d88dbb01a07bd3dbdc4d680a193db1ec323c5712b9860e166ca9cc94b"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "lawspec",
-  "version": "0.2.0",
+  "version": "0.2.1",
   "description": "State the law once. Check it everywhere.",
   "license": "MIT",
   "type": "module",