@saltify/milky-generator 0.1.1 → 0.2.1

package/README.md

@@ -0,0 +1,54 @@
+# @saltify/milky-generator
+
+Milky 代码生成 CLI，用于基于 Milky IR 生成不同目标格式的规范文件。
+
+## 安装
+
+```bash
+npm install -g @saltify/milky-generator
+```
+
+安装后可直接使用命令：
+
+```bash
+milkygen
+```
+
+## 命令
+
+### 查看可用 generator
+
+```
+milkygen list
+```
+
+### 生成内容
+
+```
+milkygen generate <generator> [--output <file>] [--version <version>]
+```
+
+示例：
+
+```bash
+milkygen generate openapi
+milkygen generate json-schema -o ./dist/schema.json
+milkygen generate typescript/zod -version latest --output ./generated/schema.ts
+milkygen generate rust/serde --version 1.2.1
+```
+
+参数说明：
+
+- `--output`, `-o`: 输出文件路径；若未提供，输出到标准输出。
+- `--version`, `-v`: 指定使用的 Milky IR 版本，支持以下值：
+  - `latest`: 默认值，使用 npm `latest` 标签对应版本的协议定义。
+  - 具体版本号: **只能使用 `1.2.1` 及以上版本**，因为协议定义在 `1.2.1` 版本中才正式发布。
+  - `local`: 使用当前包依赖中的本地协议定义。不建议使用，因为可能与发布版本不一致。
+
+### 查看 CLI 版本
+
+```
+milkygen version
+```
+
+注意这里的 version 是指 milkygen CLI 的版本，而不是 Milky IR 协议的版本。Milky IR 协议版本需要通过 `--version` 参数指定，具体说明见上文。

package/dist/cli.mjs

@@ -58,9 +58,7 @@ function getApiTypeNames(endpoint) {
 	return {
 		pascalEndpoint,
 		inputName: `${pascalEndpoint}Input`,
-		outputName: `${pascalEndpoint}Output`,
-		requestName: `${pascalEndpoint}Request`,
-		responseName: `${pascalEndpoint}Response`
+		outputName: `${pascalEndpoint}Output`
 	};
 }
 function isSameField(first, second) {
@@ -885,7 +883,7 @@ const $ZodCheckOverwrite = /* @__PURE__ */ $constructor("$ZodCheckOverwrite", (i
 });
 //#endregion
 //#region ../node_modules/.pnpm/zod@4.3.6/node_modules/zod/v4/core/versions.js
-const version$1 = {
+const version$2 = {
 	major: 4,
 	minor: 3,
 	patch: 6
@@ -897,7 +895,7 @@ const $ZodType = /* @__PURE__ */ $constructor("$ZodType", (inst, def) => {
 	inst ?? (inst = {});
 	inst._zod.def = def;
 	inst._zod.bag = inst._zod.bag || {};
-	inst._zod.version = version$1;
+	inst._zod.version = version$2;
 	const checks = [...inst._zod.def.checks ?? []];
 	if (inst._zod.traits.has("$ZodCheck")) checks.unshift(inst);
 	for (const ch of checks) for (const fn of ch._zod.onattach) fn(inst);
@@ -24919,26 +24917,42 @@ function generateTypeScriptStaticSpec(ir) {
 			const typeNames = getApiTypeNames(api.endpoint);
 			l(`/** ${api.description} API 请求参数 */`);
 			if (api.requestFields !== void 0) {
-				l(`export interface ${typeNames.requestName} {`);
+				l(`export interface ${typeNames.inputName} {`);
 				api.requestFields.forEach((field) => {
 					l(`  /** ${field.description} */`);
 					l(`  ${field.name}${field.isOptional ? "?" : ""}: ${getTypeScriptTypeProjection(field)};`);
 				});
 				l("}");
-			} else l(`export type ${typeNames.requestName} = {};`);
+			} else l(`export type ${typeNames.inputName} = {};`);
 			l();
 			l(`/** ${api.description} API 响应数据 */`);
 			if (api.responseFields !== void 0) {
-				l(`export interface ${typeNames.responseName} {`);
+				l(`export interface ${typeNames.outputName} {`);
 				api.responseFields.forEach((field) => {
 					l(`  /** ${field.description} */`);
 					l(`  ${field.name}${field.isOptional ? "?" : ""}: ${getTypeScriptTypeProjection(field)};`);
 				});
 				l("}");
-			} else l(`export type ${typeNames.responseName} = {};`);
+			} else l(`export type ${typeNames.outputName} = {};`);
 			l();
 		});
 	});
+	l("export interface ApiCategories {");
+	ir.apiCategories.forEach((category) => {
+		l(`  /** ${category.name} */`);
+		l(`  ${category.key}: {`);
+		category.apis.forEach((api) => {
+			const typeNames = getApiTypeNames(api.endpoint);
+			l(`    /** ${api.description} */`);
+			l(`    ${api.endpoint}: {`);
+			l(`      request: ${typeNames.inputName};`);
+			l(`      response: ${typeNames.outputName};`);
+			l("    };");
+		});
+		l("  };");
+	});
+	l("}");
+	l();
 	return writer.toString();
 }
 //#endregion
@@ -25679,12 +25693,12 @@ const apiCategories = [
 ];
 //#endregion
 //#region ../protocol/package.json
-var version = "1.2.1-rc.2";
+var version$1 = "1.2.1";
 //#endregion
 //#region ../protocol/src/index.ts
 const ir = {
-	milkyVersion: version.split(".").slice(0, 2).join("."),
-	milkyPackageVersion: version,
+	milkyVersion: version$1.split(".").slice(0, 2).join("."),
+	milkyPackageVersion: version$1,
 	commonStructs,
 	apiCategories
 };
@@ -29284,7 +29298,7 @@ var require_rest = /* @__PURE__ */ __commonJSMin(((exports) => {
 	}
 }));
 //#endregion
-//#region src/cli.ts
+//#region package.json
 var import_cjs = (/* @__PURE__ */ __commonJSMin(((exports) => {
 	/**
 	* The index module: the entrance to the world of cmd-ts 😎
@@ -29447,6 +29461,10 @@ var import_cjs = (/* @__PURE__ */ __commonJSMin(((exports) => {
 		}
 	});
 })))();
+var version = "0.2.1";
+var description = "Milky codegen CLI";
+//#endregion
+//#region src/cli.ts
 const generators = [
 	{
 		canonicalName: "dart/json-serializable",
@@ -29496,9 +29514,11 @@ function serializeOutput(output) {
 }
 (0, import_cjs.run)((0, import_cjs.subcommands)({
 	name: "milkygen",
+	description,
 	cmds: {
 		generate: (0, import_cjs.command)({
 			name: "generate",
+			description: "Generate a spec from Milky IR.",
 			args: {
 				generator: (0, import_cjs.positional)({
 					type: import_cjs.string,
@@ -29551,6 +29571,14 @@ function serializeOutput(output) {
 					console.log(`  - ${gen.canonicalName}`);
 				});
 			}
+		}),
+		version: (0, import_cjs.command)({
+			name: "version",
+			description: "Print the version of milkygen.",
+			args: {},
+			handler: () => {
+				console.log(version);
+			}
 		})
 	}
 }), process.argv.slice(2));

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@saltify/milky-generator",
   "type": "module",
-  "version": "0.1.1",
+  "version": "0.2.1",
   "description": "Milky codegen CLI",
   "bin": {
     "milkygen": "dist/cli.mjs"