@ts-kizuna/cli 1.49.5

package/LICENSE.MD

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2026 Sondre Ørland
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,21 @@
+# @ts-kizuna/cli
+
+The `kizuna` CLI extracts the deprecations declared on your contract into `.kizuna/deprecations.json`, which the OpenAPI and client generators read at generate time.
+
+## Installation
+
+```sh
+pnpm add -D @ts-kizuna/cli
+```
+
+## Usage
+
+Prepend it to your dev and build scripts, so the generators always read current data:
+
+```sh
+kizuna deprecations src/contract/index.ts
+```
+
+## Documentation
+
+[Deprecations](https://ts-kizuna.com/docs/deprecations)

package/dist/cli.cjs

@@ -0,0 +1,61 @@
+#!/usr/bin/env node
+const require_lint_deprecations = require("./lint-deprecations-CmqMnr7K.cjs");
+let node_path = require("node:path");
+let node_util = require("node:util");
+//#region src/cli.ts
+const usage = `Usage: kizuna deprecations <contract.ts...> [--output <dir>] [--export <name>] [--dts <dir>]
+
+Writes deprecations.json into .kizuna, keyed per contract. Generators read it at
+generate time and apply the deprecations.
+
+A contract path may be suffixed with the export to read: src/workspace.ts:workspaceContract.
+
+Optional:
+  --output <dir>   Output directory. Default: .kizuna
+  --export <name>  Default export name when none is suffixed. Default: contract
+  --dts <dir>      Re-inject schema-field JSDoc into emitted .d.ts files in <dir>,
+                   so docs survive publishing and reach z.infer consumers.
+`;
+const die = (message, code = 1) => {
+	process.stderr.write(`${message}\n`);
+	process.exit(code);
+};
+const main = async () => {
+	const argv = process.argv.slice(2);
+	if (argv[0] !== "deprecations") die(usage, argv[0] ? 1 : 0);
+	const { values, positionals } = (0, node_util.parseArgs)({
+		args: argv.slice(1),
+		options: {
+			output: { type: "string" },
+			export: { type: "string" },
+			dts: { type: "string" }
+		},
+		allowPositionals: true,
+		strict: true
+	});
+	if (positionals.length === 0) die("Missing contract path(s)\n\n" + usage);
+	const defaultExport = values.export ?? "contract";
+	const outDir = (0, node_path.resolve)(process.cwd(), values.output ?? ".kizuna");
+	const contracts = [];
+	for (const positional of positionals) {
+		const [pathPart, exportName = defaultExport] = positional.split(":");
+		const contractPath = (0, node_path.resolve)(process.cwd(), pathPart);
+		const contract = await require_lint_deprecations.loadContract(contractPath, exportName) ?? die(`No \`${exportName}\` (or default) export found at ${contractPath}`);
+		contracts.push({
+			contract,
+			contractPath
+		});
+	}
+	for (const { contractPath } of contracts) for (const warning of require_lint_deprecations.lintDeprecations(contractPath)) process.stderr.write(`Warning: ${warning.file}:${warning.line} ${warning.message}\n`);
+	const written = require_lint_deprecations.writeKizunaDeprecations(contracts, outDir);
+	process.stderr.write(`Wrote ${written}\n`);
+	if (values.dts !== void 0) {
+		const dtsDir = (0, node_path.resolve)(process.cwd(), values.dts);
+		const fields = /* @__PURE__ */ new Map();
+		for (const { contractPath } of contracts) for (const [name, map] of require_lint_deprecations.collectExportedSchemaDocs(contractPath)) fields.set(name, map);
+		const result = require_lint_deprecations.patchDeclarationDocs(dtsDir, fields);
+		process.stderr.write(`Patched JSDoc on ${result.injections} field(s) across ${result.filesChanged} of ${result.filesScanned} .d.ts file(s) in ${dtsDir}\n`);
+	}
+};
+main().catch((error) => die(`Error: ${error instanceof Error ? error.message : String(error)}`));
+//#endregion

package/dist/cli.d.cts

@@ -0,0 +1 @@
+export { };

package/dist/cli.d.mts

@@ -0,0 +1 @@
+export { };

package/dist/cli.mjs

@@ -0,0 +1,62 @@
+#!/usr/bin/env node
+import { a as patchDeclarationDocs, i as writeKizunaDeprecations, n as loadContract, o as collectExportedSchemaDocs, t as lintDeprecations } from "./lint-deprecations-Dx9WRFQa.mjs";
+import { resolve } from "node:path";
+import { parseArgs } from "node:util";
+//#region src/cli.ts
+const usage = `Usage: kizuna deprecations <contract.ts...> [--output <dir>] [--export <name>] [--dts <dir>]
+
+Writes deprecations.json into .kizuna, keyed per contract. Generators read it at
+generate time and apply the deprecations.
+
+A contract path may be suffixed with the export to read: src/workspace.ts:workspaceContract.
+
+Optional:
+  --output <dir>   Output directory. Default: .kizuna
+  --export <name>  Default export name when none is suffixed. Default: contract
+  --dts <dir>      Re-inject schema-field JSDoc into emitted .d.ts files in <dir>,
+                   so docs survive publishing and reach z.infer consumers.
+`;
+const die = (message, code = 1) => {
+	process.stderr.write(`${message}\n`);
+	process.exit(code);
+};
+const main = async () => {
+	const argv = process.argv.slice(2);
+	if (argv[0] !== "deprecations") die(usage, argv[0] ? 1 : 0);
+	const { values, positionals } = parseArgs({
+		args: argv.slice(1),
+		options: {
+			output: { type: "string" },
+			export: { type: "string" },
+			dts: { type: "string" }
+		},
+		allowPositionals: true,
+		strict: true
+	});
+	if (positionals.length === 0) die("Missing contract path(s)\n\n" + usage);
+	const defaultExport = values.export ?? "contract";
+	const outDir = resolve(process.cwd(), values.output ?? ".kizuna");
+	const contracts = [];
+	for (const positional of positionals) {
+		const [pathPart, exportName = defaultExport] = positional.split(":");
+		const contractPath = resolve(process.cwd(), pathPart);
+		const contract = await loadContract(contractPath, exportName) ?? die(`No \`${exportName}\` (or default) export found at ${contractPath}`);
+		contracts.push({
+			contract,
+			contractPath
+		});
+	}
+	for (const { contractPath } of contracts) for (const warning of lintDeprecations(contractPath)) process.stderr.write(`Warning: ${warning.file}:${warning.line} ${warning.message}\n`);
+	const written = writeKizunaDeprecations(contracts, outDir);
+	process.stderr.write(`Wrote ${written}\n`);
+	if (values.dts !== void 0) {
+		const dtsDir = resolve(process.cwd(), values.dts);
+		const fields = /* @__PURE__ */ new Map();
+		for (const { contractPath } of contracts) for (const [name, map] of collectExportedSchemaDocs(contractPath)) fields.set(name, map);
+		const result = patchDeclarationDocs(dtsDir, fields);
+		process.stderr.write(`Patched JSDoc on ${result.injections} field(s) across ${result.filesChanged} of ${result.filesScanned} .d.ts file(s) in ${dtsDir}\n`);
+	}
+};
+main().catch((error) => die(`Error: ${error instanceof Error ? error.message : String(error)}`));
+//#endregion
+export {};

package/dist/index.cjs

@@ -0,0 +1,8 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const require_lint_deprecations = require("./lint-deprecations-CmqMnr7K.cjs");
+exports.collectExportedSchemaDocs = require_lint_deprecations.collectExportedSchemaDocs;
+exports.createDeprecationMap = require_lint_deprecations.createDeprecationMap;
+exports.lintDeprecations = require_lint_deprecations.lintDeprecations;
+exports.loadContract = require_lint_deprecations.loadContract;
+exports.patchDeclarationDocs = require_lint_deprecations.patchDeclarationDocs;
+exports.writeKizunaDeprecations = require_lint_deprecations.writeKizunaDeprecations;

package/dist/index.d.cts

@@ -0,0 +1,71 @@
+import { DeprecationMap } from "@ts-kizuna/core/generator";
+import { Contract } from "@ts-kizuna/core";
+
+//#region src/schema-exports.d.ts
+/**
+ * Maps every exported schema reachable from `entryPath` to the verbatim JSDoc
+ * block on each of its fields, keyed by the exported const name (and, for
+ * aliased re-exports, by the original declared name too).
+ *
+ * Walks the whole reachable graph, both the entry's re-exports and every file
+ * it imports, so a schema defined in its own module and used via `import`
+ * (rather than re-exported from the contract entry) is still collected.
+ *
+ * Used to patch emitted `.d.ts` files, where a `z.ZodObject<{...}>` shape is
+ * keyed by the `declare const` name rather than a route or schema `meta.id`.
+ */
+declare const collectExportedSchemaDocs: (entryPath: string) => Map<string, Map<string, string>>;
+//#endregion
+//#region src/dts-jsdoc.d.ts
+interface PatchResult {
+  filesScanned: number;
+  filesChanged: number;
+  injections: number;
+}
+/**
+ * Re-injects the JSDoc blocks from {@link collectExportedSchemaDocs} onto Zod
+ * schema shape properties in the `.d.ts` files under `distDir`. Declaration emit
+ * drops the comments an author wrote on schema fields; this restores them, full
+ * descriptions, `@deprecated`, `@example`, etc., so they reach `z.infer`
+ * consumers in other repos. Skips properties that already have JSDoc. Idempotent.
+ */
+declare const patchDeclarationDocs: (distDir: string, exportFieldMap: Map<string, Map<string, string>>) => PatchResult;
+//#endregion
+//#region src/deprecation-parser.d.ts
+/**
+ * Parses a contract's `@deprecated` JSDoc tags into a {@link DeprecationMap}.
+ */
+declare const createDeprecationMap: (contractPath: string) => DeprecationMap;
+interface ContractSource {
+  contract: Contract;
+  contractPath: string;
+}
+/**
+ * Parses each contract's `@deprecated` tags and writes them to
+ * `<outDir>/deprecations.json`, keyed by contract fingerprint. Generators read
+ * the entry matching the contract they generate. Returns the written path.
+ */
+declare const writeKizunaDeprecations: (contracts: ContractSource[], outDir: string) => string;
+//#endregion
+//#region src/load-contract.d.ts
+/**
+ * Imports a contract module with jiti (so a `.ts` entry works without a build
+ * step) and returns the named export (default `contract`) or the default export.
+ * Returns undefined when neither is present.
+ */
+declare const loadContract: (contractPath: string, exportName?: string) => Promise<Contract | undefined>;
+//#endregion
+//#region src/lint-deprecations.d.ts
+interface DeprecationLintWarning {
+  file: string;
+  line: number;
+  message: string;
+}
+/**
+ * Warns about JSDoc that would silently disable a deprecation, a misspelled
+ * `@deprecated` tag, or more than one on the same comment. Scans the contract
+ * source and the files it imports.
+ */
+declare const lintDeprecations: (entryPath: string) => DeprecationLintWarning[];
+//#endregion
+export { type ContractSource, type DeprecationLintWarning, type PatchResult, collectExportedSchemaDocs, createDeprecationMap, lintDeprecations, loadContract, patchDeclarationDocs, writeKizunaDeprecations };

package/dist/index.d.mts

@@ -0,0 +1,72 @@
+import ts from "typescript";
+import { DeprecationMap } from "@ts-kizuna/core/generator";
+import { Contract } from "@ts-kizuna/core";
+
+//#region src/schema-exports.d.ts
+/**
+ * Maps every exported schema reachable from `entryPath` to the verbatim JSDoc
+ * block on each of its fields, keyed by the exported const name (and, for
+ * aliased re-exports, by the original declared name too).
+ *
+ * Walks the whole reachable graph, both the entry's re-exports and every file
+ * it imports, so a schema defined in its own module and used via `import`
+ * (rather than re-exported from the contract entry) is still collected.
+ *
+ * Used to patch emitted `.d.ts` files, where a `z.ZodObject<{...}>` shape is
+ * keyed by the `declare const` name rather than a route or schema `meta.id`.
+ */
+declare const collectExportedSchemaDocs: (entryPath: string) => Map<string, Map<string, string>>;
+//#endregion
+//#region src/dts-jsdoc.d.ts
+interface PatchResult {
+  filesScanned: number;
+  filesChanged: number;
+  injections: number;
+}
+/**
+ * Re-injects the JSDoc blocks from {@link collectExportedSchemaDocs} onto Zod
+ * schema shape properties in the `.d.ts` files under `distDir`. Declaration emit
+ * drops the comments an author wrote on schema fields; this restores them, full
+ * descriptions, `@deprecated`, `@example`, etc., so they reach `z.infer`
+ * consumers in other repos. Skips properties that already have JSDoc. Idempotent.
+ */
+declare const patchDeclarationDocs: (distDir: string, exportFieldMap: Map<string, Map<string, string>>) => PatchResult;
+//#endregion
+//#region src/deprecation-parser.d.ts
+/**
+ * Parses a contract's `@deprecated` JSDoc tags into a {@link DeprecationMap}.
+ */
+declare const createDeprecationMap: (contractPath: string) => DeprecationMap;
+interface ContractSource {
+  contract: Contract;
+  contractPath: string;
+}
+/**
+ * Parses each contract's `@deprecated` tags and writes them to
+ * `<outDir>/deprecations.json`, keyed by contract fingerprint. Generators read
+ * the entry matching the contract they generate. Returns the written path.
+ */
+declare const writeKizunaDeprecations: (contracts: ContractSource[], outDir: string) => string;
+//#endregion
+//#region src/load-contract.d.ts
+/**
+ * Imports a contract module with jiti (so a `.ts` entry works without a build
+ * step) and returns the named export (default `contract`) or the default export.
+ * Returns undefined when neither is present.
+ */
+declare const loadContract: (contractPath: string, exportName?: string) => Promise<Contract | undefined>;
+//#endregion
+//#region src/lint-deprecations.d.ts
+interface DeprecationLintWarning {
+  file: string;
+  line: number;
+  message: string;
+}
+/**
+ * Warns about JSDoc that would silently disable a deprecation, a misspelled
+ * `@deprecated` tag, or more than one on the same comment. Scans the contract
+ * source and the files it imports.
+ */
+declare const lintDeprecations: (entryPath: string) => DeprecationLintWarning[];
+//#endregion
+export { type ContractSource, type DeprecationLintWarning, type PatchResult, collectExportedSchemaDocs, createDeprecationMap, lintDeprecations, loadContract, patchDeclarationDocs, writeKizunaDeprecations };

package/dist/index.mjs

@@ -0,0 +1,2 @@
+import { a as patchDeclarationDocs, i as writeKizunaDeprecations, n as loadContract, o as collectExportedSchemaDocs, r as createDeprecationMap, t as lintDeprecations } from "./lint-deprecations-Dx9WRFQa.mjs";
+export { collectExportedSchemaDocs, createDeprecationMap, lintDeprecations, loadContract, patchDeclarationDocs, writeKizunaDeprecations };