@amritk/mjst 0.13.0 → 0.13.2

package/AI.md

@@ -0,0 +1,56 @@
+# @amritk/mjst (the `mjst` CLI) — notes for AI coding agents
+
+The command-line entry point to mjst: generate TypeScript parsers, validators,
+and types from JSON Schema, plus `lint` and `compile-api` subcommands. Full
+reference is [README.md](./README.md); config options are in
+[config.schema.json](./config.schema.json).
+
+> Pre-alpha: generated output and flags change without notice pre-1.0. This
+> package ships **only a `mjst` binary** — there are no JS exports. For the
+> programmatic API import `@amritk/generate-parsers` etc. instead.
+
+## The three commands
+
+```bash
+# 1. Codegen (default command)
+mjst --schema ./schema.json --out-dir ./generated
+
+# 2. Lint JSON/YAML against JSON Schema + style rules
+mjst lint "**/*.{yaml,json}" -r .lint.yaml
+
+# 3. Compile an @amritk/api routes module to a fused, eval-free handler
+mjst compile-api ./routes.ts --out ./dist/handler.ts
+```
+
+## Codegen gotchas
+
+1. **You must pass an output.** `--out-dir <dir>` **or** `--out-file <file>` —
+   omitting both errors. `--out-file` only works with `--types-only`.
+2. **`--import-ext` defaults to `ts`, not `js`.** Generated imports carry literal
+   `.ts` extensions, so plain `tsc` needs `allowImportingTsExtensions`. Use
+   `--import-ext js` or `--build` for directly-compilable output.
+   `--import-ext ts` + `--build` is a hard error.
+3. **Flags accept kebab or camel** (`--out-dir` ≡ `--outDir`). **Config-file
+   keys are camelCase** (`outDir`, `schemaDir`, `typesOnly`, …), validated
+   against `config.schema.json`. CLI flags always override the config file.
+4. **The root type name comes from the schema `title`/filename**, not
+   `Document`. Override with `--root-type <name>` (single-schema only; rejected
+   with `--schema-dir`).
+5. **Non-JSON input** (`--input typebox|zod|valibot|effect`) works for a single
+   `--schema`; `--schema-dir` only accepts `json`.
+
+## Common flags
+
+`--schema` / `--schema-dir`, `--out-dir` / `--out-file`, `--input`,
+`--validators`, `--examples`, `--types-only`, `--build`, `--strict`,
+`--strip-unknown`, `--readonly`, `--import-ext ts|js`, `--config <path>`,
+`--resolve-remote` / `--allowed-hosts` (SSRF-guarded remote `$ref`s).
+
+## Lint gotchas
+
+- `-F`/`--fail-severity` (default `error`) sets the exit-code threshold
+  (`0` clean, `1` findings at/above threshold, `2` usage error).
+- With no `-r`, a `.lint.{yaml,yml,json,js,mjs}` ruleset is auto-discovered by
+  walking up from each file.
+
+Install: `bun add -d @amritk/mjst` (or `npx mjst …`).

package/dist/lint/resolver.js

@@ -1,6 +1,7 @@
 import { readFileSync } from "node:fs";
 import { resolve as resolvePath } from "node:path";
-import { createDocument, DiagnosticSeverity, resolveSourceOriginFromMap } from "@amritk/lint";
+import { createDocument, resolveSourceOriginFromMap } from "@amritk/lint";
+import { DiagnosticSeverity } from "@amritk/lint/types";
 import { resolveRefs, resolveRefsFromFile } from "@amritk/resolve-refs";
 import { parse as parseYaml } from "@amritk/yaml";
 import { hasExternalRefs } from "../has-external-refs.js";

package/dist/lint/ruleset-loader.d.ts

@@ -1,4 +1,4 @@
-import { type RulesetDefinition } from '@amritk/lint';
+import type { RulesetDefinition } from '@amritk/lint/types';
 /** Loads a ruleset definition from a YAML, JSON, or JS/MJS file. */
 export declare const loadRuleset: (path: string) => Promise<RulesetDefinition>;
 /** Walks up from a directory looking for a `.lint.*` ruleset file. */

package/dist/lint/run.js

@@ -1,6 +1,7 @@
 import { readFile } from "node:fs/promises";
 import { dirname, isAbsolute, resolve } from "node:path";
-import { DiagnosticSeverity, lintDocument, validateRuleset } from "@amritk/lint";
+import { lintDocument, validateRuleset } from "@amritk/lint";
+import { DiagnosticSeverity } from "@amritk/lint/types";
 import fg from "fast-glob";
 import yargs from "yargs";
 import { createLintResolver } from "./resolver.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@amritk/mjst",
-  "version": "0.13.0",
+  "version": "0.13.2",
   "description": "Generate TypeScript parsers and type definitions from JSON Schemas.",
   "type": "module",
   "license": "MIT",
@@ -27,7 +27,8 @@
     "mjst": "./dist/cli.js"
   },
   "files": [
-    "dist"
+    "dist",
+    "AI.md"
   ],
   "publishConfig": {
     "access": "public"
@@ -41,16 +42,16 @@
     "generate-readme": "bun run ./scripts/generate-readme.ts"
   },
   "dependencies": {
-    "@amritk/adapters": "0.3.3",
-    "@amritk/api": "0.5.0",
-    "@amritk/generate-examples": "0.5.3",
-    "@amritk/generate-parsers": "0.17.0",
-    "@amritk/generate-validators": "0.11.9",
-    "@amritk/generate-markdown": "0.4.3",
-    "@amritk/helpers": "0.13.3",
-    "@amritk/lint": "0.3.3",
-    "@amritk/resolve-refs": "0.4.3",
-    "@amritk/yaml": "0.3.3",
+    "@amritk/adapters": "0.3.4",
+    "@amritk/api": "0.6.1",
+    "@amritk/generate-examples": "0.5.4",
+    "@amritk/generate-parsers": "0.17.1",
+    "@amritk/generate-validators": "0.11.10",
+    "@amritk/generate-markdown": "0.4.4",
+    "@amritk/helpers": "0.13.4",
+    "@amritk/lint": "0.4.0",
+    "@amritk/resolve-refs": "0.4.4",
+    "@amritk/yaml": "0.3.4",
     "fast-glob": "^3.3.2",
     "yargs": "^17.7.2"
   },