@amritk/mjst 0.18.0 → 0.19.0

package/README.md

@@ -394,7 +394,7 @@ The exit code is `0` on success, `1` when compilation fails (unloadable module,
 <td align="center"><code>false</code></td>
 </tr>
 <tr>
-<td colspan="4">Allow generated files to overwrite files that already exist in the output destination. By default a collision with a file mjst did not generate (a hand-written index.ts, say) aborts the run before anything is written, because the generator would otherwise replace it — and, under build, delete it along with the other intermediate sources. Regenerating never needs this flag: each run records what it wrote in a .mjst-manifest.json at the root of the output directory, and anything listed there is replaced freely.</td>
+<td colspan="4">Deprecated and ignored. Generated files always replace whatever is at their path, so this flag no longer does anything; it is still accepted so existing scripts and config files keep running. Reverting an unwanted replacement is version control's job. Compilation under build still only removes the intermediate sources the run itself generated.</td>
 </tr>
 <tr>
 <td>⚠️ <code>logWarnings</code></td>

package/dist/cli-config.d.ts

@@ -85,15 +85,11 @@ export type CliConfig = {
      */
     readonly build?: boolean;
     /**
-     * When true, generated files may overwrite files that already exist in the
-     * output destination. By default a collision with a file mjst did not generate
-     * (a hand-written `index.ts`, say) aborts the run rather than silently
-     * replacing it — and with `build`, deleting it afterwards. Regeneration does
-     * not need this: each run records what it wrote in a `.mjst-manifest.json` at
-     * the root of the output directory, and reclaims those paths freely. With
-     * `outFile` the "output directory" is the directory holding that file, so the
-     * manifest lands beside it — generated examples and the `build` output already
-     * do.
+     * @deprecated No longer has any effect, and is accepted only so existing
+     * scripts and config files keep running. Generated files always replace
+     * whatever is at their path; version control is where an unwanted replacement
+     * shows up and gets reverted. `build` still only ever deletes the intermediate
+     * sources the run itself committed.
      */
     readonly force?: boolean;
     /**

package/dist/cli.js

@@ -67,7 +67,7 @@ const commitOrDiscard = async (writer, stageAll) => {
   return writer.commit();
 };
 const runExamples = async (config, outputDir, tasks) => {
-  const writer = await createOutputWriter(outputDir, config.force);
+  const writer = await createOutputWriter(outputDir);
   const written = await commitOrDiscard(writer, async () => {
     for (const task of tasks) {
       await emitExamples({
@@ -156,7 +156,7 @@ const runSingle = async (config, schemaPath, outputDir) => {
   const rootTypeName = config.rootType ?? deriveRootTypeName(schema, schemaBaseName(schemaPath));
   console.log(`Root type: ${rootTypeName}`);
   const files = await buildSchema(schema, rootTypeName, void 0, config.typesOnly, config.logWarnings, config.strict, helpersMode, void 0, config.readonly, config.stripUnknown, config.typeSuffix, resolveImportExt(config), config.caseInsensitive, void 0, config.unknownKeys);
-  const writer = await createOutputWriter(outputDir, config.force);
+  const writer = await createOutputWriter(outputDir);
   const written = await commitOrDiscard(writer, async () => {
     for (const file of files) {
       const isHelper = file.filename.startsWith("_helpers/");
@@ -186,7 +186,7 @@ const runSingleFile = async (config, schemaPath, outFilePath) => {
   console.log(`Root type: ${rootTypeName}`);
   const files = await buildSchema(schema, rootTypeName, void 0, config.typesOnly, config.logWarnings, config.strict, config.helpers ?? "package", void 0, config.readonly, config.stripUnknown, config.typeSuffix, resolveImportExt(config), config.caseInsensitive, void 0, config.unknownKeys);
   const combined = combineGeneratedFiles(files);
-  const writer = await createOutputWriter(outputDir, config.force);
+  const writer = await createOutputWriter(outputDir);
   const written = await commitOrDiscard(writer, async () => {
     await writer.stage(basename(outFilePath), config.banner ? resolveBanner(config.banner) + combined : combined);
   });
@@ -214,7 +214,7 @@ const runRecursive = async (config, schemaDir, outputDir) => {
   await ensureOutputDir(outputDir);
   const helpersMode = resolveHelpersMode(config, outputDir);
   const sharedHelpers = /* @__PURE__ */ new Map();
-  const writer = await createOutputWriter(outputDir, config.force);
+  const writer = await createOutputWriter(outputDir);
   const exampleTasks = [];
   const stageAll = async () => {
     for (const schemaFile of schemaFiles) {
@@ -279,7 +279,7 @@ const runAsyncApi = async (config, documentPath, outputDir) => {
   await ensureOutputDir(outputDir);
   const helpersMode = resolveHelpersMode(config, outputDir);
   const sharedHelpers = /* @__PURE__ */ new Map();
-  const writer = await createOutputWriter(outputDir, config.force);
+  const writer = await createOutputWriter(outputDir);
   const exampleTasks = [];
   const contractIssues = [];
   let contractMessageCount = 0;
@@ -385,6 +385,9 @@ const run = async () => {
     console.error("Error: provide only one of --out-dir or --out-file, not both.");
     process.exit(1);
   }
+  if (config.force) {
+    console.warn("Warning: --force is deprecated and does nothing; generated files always replace what is at their path.");
+  }
   if (config.rootType !== void 0 && !ROOT_TYPE_PATTERN.test(config.rootType)) {
     console.error(`Error: invalid --root-type "${config.rootType}". Expected a TypeScript identifier (letters, digits, _ or $, not starting with a digit).`);
     process.exit(1);

package/dist/create-output-writer.d.ts

@@ -3,22 +3,21 @@
  * final location under a temporary name, and only once the whole set is on disk
  * are the temporaries renamed into place.
  *
- * Two failure modes drive the design:
+ * The failure mode it exists for is **partial trees**. Writing straight to the
+ * final paths meant a failure halfway through (a `_helpers` path occupied by a
+ * regular file, a full disk) left some generated files behind and others missing
+ * — a tree that compiles against a schema that no longer exists. Staging first
+ * means the run either lands completely or leaves the destination as it found it.
+ * Renaming is not one atomic operation across the whole set, but every rename
+ * happens after all the risky work (generating, creating directories, writing
+ * bytes) has already succeeded, so it is the cheapest place to get the guarantee.
  *
- * 1. **Partial trees.** Writing straight to the final paths meant a failure
- *    halfway through (a `_helpers` path occupied by a regular file, a full disk)
- *    left some generated files behind and others missing — a tree that compiles
- *    against a schema that no longer exists. Staging first means the run either
- *    lands completely or leaves the destination as it found it. Renaming is not
- *    one atomic operation across the whole set, but every rename happens after
- *    all the risky work (generating, creating directories, writing bytes) has
- *    already succeeded, so it is the cheapest place to get the guarantee.
- * 2. **Clobbering hand-written files.** A generated name can collide with a file
- *    the user wrote (`index.ts` is the common one), which used to be overwritten
- *    without a word — and then, under `--build`, deleted along with the other
- *    intermediate sources. A file is only replaced when a previous run claimed it
- *    (see {@link MANIFEST_FILENAME}) or `--force` says so, and `--build` is only
- *    ever handed the paths this run actually committed.
+ * A generated path that already exists is simply replaced. The writer keeps no
+ * record of what it produced last time: an output directory is generated output,
+ * and version control is where a user sees — and reverts — a replacement they did
+ * not want. What the writer still guarantees is that `--build` only ever deletes
+ * intermediate sources this run committed, so nothing that was already sitting in
+ * the output directory is removed.
  */
 export type OutputWriter = {
     /**
@@ -34,7 +33,10 @@ export type OutputWriter = {
 /**
  * Creates an {@link OutputWriter} rooted at `rootDir`.
  *
+ * Still async with nothing to await: it read the previous run's manifest here
+ * until that was removed, and every call site already awaits it. Keeping the
+ * signature leaves room for setup that does need I/O.
+ *
  * @param rootDir - Output root. Every write must resolve inside it.
- * @param force - Overwrite pre-existing files instead of refusing (`--force`).
  */
-export declare const createOutputWriter: (rootDir: string, force?: boolean) => Promise<OutputWriter>;
+export declare const createOutputWriter: (rootDir: string) => Promise<OutputWriter>;

package/dist/create-output-writer.js

@@ -1,23 +1,8 @@
-import { readFile, rename, rm, stat, writeFile } from "node:fs/promises";
-import { dirname, join, relative, resolve, sep } from "node:path";
+import { rename, rm, writeFile } from "node:fs/promises";
+import { dirname, resolve, sep } from "node:path";
 import { ensureOutputDir } from "./ensure-output-dir.js";
-const MANIFEST_FILENAME = ".mjst-manifest.json";
-const pathExists = async (path) => stat(path).then(() => true, () => false);
-const readManifest = async (root) => {
-  const raw = await readFile(join(root, MANIFEST_FILENAME), "utf-8").catch(() => void 0);
-  if (raw === void 0)
-    return /* @__PURE__ */ new Set();
-  try {
-    const parsed = JSON.parse(raw);
-    const files = Array.isArray(parsed.files) ? parsed.files : [];
-    return new Set(files.filter((file) => typeof file === "string").map((file) => resolve(root, file)));
-  } catch {
-    return /* @__PURE__ */ new Set();
-  }
-};
-const createOutputWriter = async (rootDir, force = false) => {
+const createOutputWriter = async (rootDir) => {
   const root = resolve(rootDir);
-  const owned = await readManifest(root);
   const staged = [];
   const stamp = `${process.pid}-${Date.now().toString(36)}`;
   const stage = async (relativePath, content) => {
@@ -25,9 +10,6 @@ const createOutputWriter = async (rootDir, force = false) => {
     if (targetPath !== root && !targetPath.startsWith(root + sep)) {
       throw new Error(`Refusing to write "${relativePath}": it resolves outside the output directory ${root}.`);
     }
-    if (!force && !owned.has(targetPath) && await pathExists(targetPath)) {
-      throw new Error(`Refusing to overwrite ${targetPath}: it already exists and was not generated by mjst. Move it aside, choose another output directory, or pass --force to overwrite it.`);
-    }
     const tempPath = `${targetPath}.mjst-${stamp}-${staged.length}.tmp`;
     await ensureOutputDir(dirname(targetPath));
     await writeFile(tempPath, content, "utf-8");
@@ -36,12 +18,6 @@ const createOutputWriter = async (rootDir, force = false) => {
   const commit = async () => {
     for (const file of staged) {
       await rename(file.tempPath, file.targetPath);
-      owned.add(file.targetPath);
-    }
-    if (staged.length > 0) {
-      const files = [...owned].map((path) => relative(root, path)).sort();
-      await writeFile(join(root, MANIFEST_FILENAME), `${JSON.stringify({ version: 1, files }, null, 2)}
-`, "utf-8");
     }
     return staged.map((file) => file.relativePath);
   };

package/dist/emit-examples.d.ts

@@ -11,10 +11,9 @@ export type EmitExamplesOptions = {
     /**
      * The run's writer, rooted at the output destination. Examples used to be
      * written straight to disk with `mkdir` + `writeFile`, which meant the one
-     * output tree mjst emits that skipped the ownership check — a hand-written
-     * `examples/index.ts` was overwritten without a word. Taking the writer instead
-     * of a directory makes that impossible to reintroduce: there is no path here
-     * that does not go through staging, the manifest, and `--force`.
+     * output tree mjst emits that skipped staging entirely — a failure part-way
+     * through left a half-written `examples/` tree behind. Taking the writer
+     * instead of a directory makes that impossible to reintroduce.
      */
     readonly writer: OutputWriter;
     /**

package/dist/help-text.d.ts

@@ -4,4 +4,4 @@
  * documents these flags (config.schema.json) is not shipped in the published
  * package; the help-text test cross-checks that every flag is listed.
  */
-export declare const HELP_TEXT = "mjst \u2014 generate TypeScript parsers and type definitions from JSON Schemas\n\nUsage:\n  mjst --schema <path> --out-dir <dir> [options]\n  mjst --schema-dir <dir> --out-dir <dir> [options]\n  mjst --schema <path> --out-file <file> --types-only [options]\n\nSubcommands (each with its own flags and --help):\n  mjst lint <files>                       Lint JSON/YAML documents against a ruleset\n  mjst compile-api <module> --out <file>  Compile @amritk/api route contracts into a fetch-handler module\n\nInput:\n  --schema <path>       Schema to process: a JSON Schema file, or a module when --input is set\n  --schema-dir <dir>    Directory of JSON Schemas, processed recursively (instead of --schema)\n  --input <format>      Schema source format: json (default), typebox, zod, valibot, effect, avro,\n                        or asyncapi (an AsyncAPI 2.x/3.0 document, JSON or YAML)\n  --export <name>       Which export of the schema module to use when --input names a module format\n\nOutput:\n  --out-dir <dir>       Output directory for the generated files\n  --out-file <file>     Single-file output instead of a directory (requires --types-only)\n  --types-only          Generate type definitions only, without parser functions\n  --validators          Also emit validateX/isX validators into a validators/ subdir\n  --examples            Also emit fast-check arbitraries + example values under examples/\n  --message-contracts   Also emit @amritk/api channel contracts under contracts/ (--input asyncapi only)\n  --discriminator <p>   Property naming which message a frame is, for --message-contracts (default: type)\n  --build               Compile the generated files to .js/.d.ts (implies --import-ext js)\n  --force               Overwrite pre-existing files in the output destination\n  --import-ext <ext>    Extension on generated relative imports: ts (default) or js\n  --helpers <mode>      Runtime helpers: package or embedded (default: auto-detect from package.json)\n  --root-type <name>    Root type name for a single --schema run (default: schema title or filename)\n  --type-suffix <s>     Suffix appended to every $ref-derived type name\n  --banner [text]       Prepend a header comment to every generated file\n  --readonly            Emit deeply readonly type definitions\n\nValidation:\n  --strict              Throw on type/shape mismatches instead of coercing to defaults\n  --strip-unknown       Silently drop undeclared input keys at every nesting level\n  --case-insensitive    Normalize mis-cased enum/const strings to their exact casing\n  --log-warnings        console.warn on input keys not declared in the schema\n  --unknown-keys <s>    How closed objects are proven free of undeclared keys:\n                        count-keys (default, fastest on Bun) or count-enumerable (fastest on Node)\n\nReference resolution:\n  --resolve-remote      Fetch http(s) $refs while resolving cross-file/remote refs (off by default)\n  --allowed-hosts <h>   Restrict remote $ref fetches to these hosts (comma-separated; implies --resolve-remote)\n  --allow-private-hosts Permit remote $refs to private/loopback hosts (SSRF guard, off by default)\n  --allowed-roots <d>   Extra directories a local $ref may resolve into, on top of the schema's own\n                        (comma-separated; relative to the current directory)\n\nMisc:\n  --config <path>       JSON config file with the same keys; CLI flags take precedence\n  --version, -v         Print the CLI version\n  --help, -h            Print this help\n\nDocs: https://github.com/amritk/mjst/tree/main/packages/cli#readme\n";
+export declare const HELP_TEXT = "mjst \u2014 generate TypeScript parsers and type definitions from JSON Schemas\n\nUsage:\n  mjst --schema <path> --out-dir <dir> [options]\n  mjst --schema-dir <dir> --out-dir <dir> [options]\n  mjst --schema <path> --out-file <file> --types-only [options]\n\nSubcommands (each with its own flags and --help):\n  mjst lint <files>                       Lint JSON/YAML documents against a ruleset\n  mjst compile-api <module> --out <file>  Compile @amritk/api route contracts into a fetch-handler module\n\nInput:\n  --schema <path>       Schema to process: a JSON Schema file, or a module when --input is set\n  --schema-dir <dir>    Directory of JSON Schemas, processed recursively (instead of --schema)\n  --input <format>      Schema source format: json (default), typebox, zod, valibot, effect, avro,\n                        or asyncapi (an AsyncAPI 2.x/3.0 document, JSON or YAML)\n  --export <name>       Which export of the schema module to use when --input names a module format\n\nOutput:\n  --out-dir <dir>       Output directory for the generated files\n  --out-file <file>     Single-file output instead of a directory (requires --types-only)\n  --types-only          Generate type definitions only, without parser functions\n  --validators          Also emit validateX/isX validators into a validators/ subdir\n  --examples            Also emit fast-check arbitraries + example values under examples/\n  --message-contracts   Also emit @amritk/api channel contracts under contracts/ (--input asyncapi only)\n  --discriminator <p>   Property naming which message a frame is, for --message-contracts (default: type)\n  --build               Compile the generated files to .js/.d.ts (implies --import-ext js)\n  --force               Deprecated; ignored (generated files always overwrite)\n  --import-ext <ext>    Extension on generated relative imports: ts (default) or js\n  --helpers <mode>      Runtime helpers: package or embedded (default: auto-detect from package.json)\n  --root-type <name>    Root type name for a single --schema run (default: schema title or filename)\n  --type-suffix <s>     Suffix appended to every $ref-derived type name\n  --banner [text]       Prepend a header comment to every generated file\n  --readonly            Emit deeply readonly type definitions\n\nValidation:\n  --strict              Throw on type/shape mismatches instead of coercing to defaults\n  --strip-unknown       Silently drop undeclared input keys at every nesting level\n  --case-insensitive    Normalize mis-cased enum/const strings to their exact casing\n  --log-warnings        console.warn on input keys not declared in the schema\n  --unknown-keys <s>    How closed objects are proven free of undeclared keys:\n                        count-keys (default, fastest on Bun) or count-enumerable (fastest on Node)\n\nReference resolution:\n  --resolve-remote      Fetch http(s) $refs while resolving cross-file/remote refs (off by default)\n  --allowed-hosts <h>   Restrict remote $ref fetches to these hosts (comma-separated; implies --resolve-remote)\n  --allow-private-hosts Permit remote $refs to private/loopback hosts (SSRF guard, off by default)\n  --allowed-roots <d>   Extra directories a local $ref may resolve into, on top of the schema's own\n                        (comma-separated; relative to the current directory)\n\nMisc:\n  --config <path>       JSON config file with the same keys; CLI flags take precedence\n  --version, -v         Print the CLI version\n  --help, -h            Print this help\n\nDocs: https://github.com/amritk/mjst/tree/main/packages/cli#readme\n";

package/dist/help-text.js

@@ -25,7 +25,7 @@ Output:
   --message-contracts   Also emit @amritk/api channel contracts under contracts/ (--input asyncapi only)
   --discriminator <p>   Property naming which message a frame is, for --message-contracts (default: type)
   --build               Compile the generated files to .js/.d.ts (implies --import-ext js)
-  --force               Overwrite pre-existing files in the output destination
+  --force               Deprecated; ignored (generated files always overwrite)
   --import-ext <ext>    Extension on generated relative imports: ts (default) or js
   --helpers <mode>      Runtime helpers: package or embedded (default: auto-detect from package.json)
   --root-type <name>    Root type name for a single --schema run (default: schema title or filename)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@amritk/mjst",
-  "version": "0.18.0",
+  "version": "0.19.0",
   "description": "Generate TypeScript parsers and type definitions from JSON Schemas.",
   "type": "module",
   "engines": {
@@ -53,7 +53,7 @@
     "@amritk/api": "^0.16.3",
     "@amritk/asyncapi": "^0.2.0",
     "@amritk/generate-examples": "^0.8.3",
-    "@amritk/generate-parsers": "^0.21.1",
+    "@amritk/generate-parsers": "^0.22.0",
     "@amritk/generate-validators": "^0.16.1",
     "@amritk/helpers": "^0.20.0",
     "@amritk/lint": "^0.5.3",