recipe-tmlanguage 0.3.0 → 0.3.1

package/README.md

@@ -7,14 +7,15 @@ TextMate grammar for the [recipe] pharmacological notation language,
 **generated** from the same JavaScript vocabulary modules that drive
 `tree-sitter-recipe`'s parser.
 
-Ships as `dist/recipe.tmLanguage.json` for consumption by Shiki, VS Code,
-Sublime Text, Atom, `vscode-textmate`, and anything else that speaks
-TextMate.
+Ships as `recipe.tmLanguage.json` (the package's main export) — load it in
+Shiki, a VS Code language extension, Monaco (via `monaco-textmate`), or any
+other `vscode-textmate` host.
 
 ## Why generate, not author
 
-The parser's vocabulary (`FREQUENCY`, `TIMING`, `ROUTE`, …, `UNITS`) lives in
-plain `readonly string[]` modules under
+The parser's vocabulary (`FREQUENCY`, `TIMING`, `ROUTE`, …, `UNITS`, plus the
+Dutch patient-prose frequency vocab in `grammar/dutch`) lives in plain
+`readonly string[]` modules under
 `tree-sitter-recipe/grammar/`. Authoring a parallel TextMate grammar by hand
 would mean copying those lists into regex alternations and re-copying them
 every time the parser is touched. Drift guaranteed.
@@ -56,22 +57,32 @@ grammar.
 
 ```text
 recipe-tmlanguage/
-├── cli.ts              # DreamCLI entry — `recipe-tmlang generate|verify`
+├── bin/
+│   └── recipe-tmlang.ts    # DreamCLI entry — `recipe-tmlang generate|verify`
 ├── src/
-│   ├── grammar.ts      # pure: vocab → TextMate grammar object
-│   └── verifier.ts     # pure: tokenize fixtures, check scope assertions
-└── dist/
-    └── recipe.tmLanguage.json
+│   ├── grammar.ts          # pure: vocab → TextMate grammar object
+│   └── verifier.ts         # pure: tokenize fixtures, check scope assertions
+├── recipe.tmLanguage.json  # generated grammar (the main export)
+└── recipe.tmLanguage.ts    # typed re-export of the JSON
 ```
 
-## Setup
+## Install
 
-`tree-sitter-recipe` is pulled in via Bun's link mechanism. Run once in the
-sibling repo, then link here:
+```sh
+bun add recipe-tmlanguage        # or: npm install recipe-tmlanguage
+```
+
+The grammar is pre-generated in the package — no build step for consumers.
+
+## Develop
+
+`tree-sitter-recipe` is a regular npm dependency now, so a plain install is
+all the setup there is:
 
 ```sh
-cd ../tree-sitter-recipe && bun link
-cd ../recipe-tmlanguage && bun link tree-sitter-recipe && bun install
+bun install
+bun run generate     # rebuild recipe.tmLanguage.json
+bun run verify       # check scopes against the upstream fixtures
 ```
 
 ## CLI
@@ -79,16 +90,16 @@ cd ../recipe-tmlanguage && bun link tree-sitter-recipe && bun install
 Powered by [DreamCLI][dreamcli] — no hand-rolled argparse.
 
 ```sh
-bun cli.ts --help
+npx recipe-tmlanguage --help   # or: bunx recipe-tmlanguage --help
 ```
 
 ### `generate`
 
 ```sh
-bun cli.ts generate                       # → dist/recipe.tmLanguage.json
-bun cli.ts generate --out foo.json        # custom path
-bun cli.ts generate --indent 2 --quiet    # 2-space indent, silent
-bun cli.ts generate --json                # machine-readable result on stdout
+npx recipe-tmlanguage generate                    # → recipe.tmLanguage.json
+npx recipe-tmlanguage generate --out foo.json     # custom path
+npx recipe-tmlanguage generate --indent 2 --quiet # 2-space indent, silent
+npx recipe-tmlanguage generate --json             # machine-readable on stdout
 ```
 
 ### `verify`
@@ -100,34 +111,23 @@ Fixtures and the Oniguruma WASM are located via package `exports` — no
 relative paths to maintain.
 
 ```sh
-bun cli.ts verify
-bun cli.ts verify --json                  # { pass, total, failures[] }
-bun cli.ts verify --max-failures 0        # print every failure
+npx recipe-tmlanguage verify
+npx recipe-tmlanguage verify --json           # { pass, total, failures[] }
+npx recipe-tmlanguage verify --max-failures 0 # print every failure
 ```
 
-Current status: **148 / 149** fixture assertions pass. The single failing
-assertion (`expanded.recipe:22:23`) points one column past the end of a
-23-character source line — a fixture off-by-one, not a grammar defect.
-
-### Drop into Shiki
+Current status: **149 / 149** fixture assertions pass.
 
-```ts
-import grammar from "recipe-tmlanguage/dist/recipe.tmLanguage.json";
-import { createHighlighter } from "shiki";
+### Use with Shiki
 
-const shiki = await createHighlighter({
-	themes: ["github-dark"],
-	langs: [grammar],
-});
-
-const html = shiki.codeToHtml(source, {
-	lang: "recipe",
-	theme: "github-dark",
-});
-```
+Don't register the raw JSON yourself — its grammar name is `Recipe`, which
+won't match a `lang: "recipe"` lookup. Reach for [`recipe-shiki`][recipe-shiki]
+instead: it wraps this grammar in a `LanguageRegistration` with the canonical
+lang `recipe` (and alias `rx`).
 
-The scope names are standard TextMate, so any Shiki theme paints recipe
-blocks immediately.
+For any other `vscode-textmate` host, load `recipe.tmLanguage.json` directly —
+grammar name `Recipe`, scope `source.recipe`. The scopes are standard TextMate,
+so any theme paints recipe blocks immediately.
 
 ## License
 
@@ -138,5 +138,6 @@ blocks immediately.
 [jsr]: https://jsr.io/@kjanat/recipe-tmlanguage
 [npm]: https://npm.im/recipe-tmlanguage
 [recipe]: https://github.com/kjanat/tree-sitter-recipe
+[recipe-shiki]: https://github.com/kjanat/recipe-shiki
 
 <!-- markdownlint-disable-file no-hard-tabs -->

package/bin/recipe-tmlang.ts

@@ -21,9 +21,8 @@ import type { Out } from "dreamcli";
 import { buildGrammar, serializeGrammar } from "#grammar";
 import { verify } from "#verifier";
 
-import pkg from "#pkg" with { type: "json" };
+import { homepage, repository, version } from "#pkg" with { type: "json" };
 
-const { homepage, repository, version } = pkg;
 const DEFAULT_OUT = `${resolve(import.meta.dirname, "..")}/recipe.tmLanguage.json`;
 
 const TS_RX_DIR = resolve(dirname(fileURLToPath(import.meta.resolve("tree-sitter-recipe/package.json"))));

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "recipe-tmlanguage",
-	"version": "0.3.0",
+	"version": "0.3.1",
 	"description": "TextMate grammar for the recipe (.recipe) pharmacological notation language.",
 	"keywords": [
 		"dreamcli",
@@ -27,14 +27,11 @@
 	},
 	"exports": {
 		".": "./recipe.tmLanguage.json",
-		"./dist/*": "./dist/*",
 		"./package.json": "./package.json"
 	},
 	"main": "./recipe.tmLanguage.json",
 	"module": "./recipe.tmLanguage.json",
-	"bin": {
-		"recipe-tmlang": "bin/recipe-tmlang.ts"
-	},
+	"bin": "bin/recipe-tmlang.mjs",
 	"directories": {
 		"lib": "/src",
 		"bin": "/bin"
@@ -48,12 +45,13 @@
 		"/LICENSE"
 	],
 	"scripts": {
+		"bundle": "tsdown",
 		"check": "biome check",
 		"cli": "run recipe-tmlang",
 		"fmt": "dprint fmt",
 		"generate": "run recipe-tmlang generate",
 		"lint": "biome lint",
-		"prepack": "bun generate",
+		"prepack": "bun run generate && bun run bundle",
 		"recipe-tmlang": "bun bin/recipe-tmlang.ts",
 		"typecheck": "tsc --noEmit",
 		"verify": "run recipe-tmlang verify"
@@ -69,6 +67,7 @@
 		"@types/bun": "^1.3.14",
 		"dprint": "^0.54.0",
 		"runner-run": "^0.14.3",
+		"tsdown": "^0.22.3",
 		"typescript": "^6.0.3"
 	},
 	"packageManager": "bun@1.3.14",