npm - @univer-cli/config-command - Versions diffs - 1.0.0-beta.2 - Mend

@univer-cli/config-command 1.0.0-beta.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (6) hide show

package/README.md ADDED Viewed

@@ -0,0 +1,62 @@
+# @univer-cli/config-command
+English | [简体中文](./README.zh-CN.md)
+Add `@univer-cli/config` to a Commander application with a ready-to-use set of local configuration commands.
+## Installation
+```bash
+pnpm add commander @univer-cli/config @univer-cli/config-command
+```
+Commander `^15.0.0` is a peer dependency. Requires Node.js 22.12 or higher.
+## Quick Start
+Define the configuration with the capability, then inject it into the command:
+```ts
+import { join } from "node:path";
+import { configCodecs, createFileConfig, defineConfig } from "@univer-cli/config";
+import { createConfigCommand } from "@univer-cli/config-command";
+import { Command } from "commander";
+const config = createFileConfig({
+  path: join(process.cwd(), ".my-cli", "config.json"),
+  definitions: defineConfig({
+    "runtime.enabled": {
+      description: "Enable the runtime.",
+      defaultValue: true,
+      codec: configCodecs.boolean(),
+    },
+  }),
+});
+const program = new Command("my-cli");
+program.addCommand(createConfigCommand({ config }));
+await program.parseAsync();
+```
+## Command list
+```text
+config path
+config list [--json]
+config get <key> [--json]
+config set <key> <value> [--json]
+config unset <key> [--json]
+```
+`set` uses the codec in the configuration definition to parse text, so the CLI and direct capability calls share the same validation. The default output is human-readable; `--json` prints structured results. Commander exits non-zero for unknown keys and invalid values.
+## Customization
+The factory returns a native Commander `Command`. The application can customize its name, aliases, help, output, and exit behavior, or skip the preset and call the capability directly:
+```ts
+const entry = await config.get({ key: "runtime.enabled" });
+renderWithMyOwnFormat(entry);
+```
+This package does not define configuration keys, default values, or persistence rules; these contracts all belong to `@univer-cli/config`.

package/README.zh-CN.md ADDED Viewed

@@ -0,0 +1,64 @@
+# @univer-cli/config-command
+[English](./README.md) | 简体中文
+把 `@univer-cli/config` 接入 Commander 应用，提供一组可直接使用的本地配置命令。
+## 安装
+```bash
+pnpm add commander @univer-cli/config @univer-cli/config-command
+```
+Commander `^15.0.0` 是 peer dependency。要求 Node.js 22.12 或更高版本。
+## 快速开始
+先用 capability 定义配置，再注入 command：
+```ts
+import { join } from "node:path";
+import { configCodecs, createFileConfig, defineConfig } from "@univer-cli/config";
+import { createConfigCommand } from "@univer-cli/config-command";
+import { Command } from "commander";
+const config = createFileConfig({
+  path: join(process.cwd(), ".my-cli", "config.json"),
+  definitions: defineConfig({
+    "runtime.enabled": {
+      description: "Enable the runtime.",
+      defaultValue: true,
+      codec: configCodecs.boolean(),
+    },
+  }),
+});
+const program = new Command("my-cli");
+program.addCommand(createConfigCommand({ config }));
+await program.parseAsync();
+```
+## 命令一览
+```text
+config path
+config list [--json]
+config get <key> [--json]
+config set <key> <value> [--json]
+config unset <key> [--json]
+```
+`set` 使用配置定义中的 codec 解析文本，因此 CLI 与直接调用 capability 共享相同校验。默认输出面向人阅读；
+`--json` 输出结构化结果。未知 key 和非法值由 Commander 以失败退出处理。
+## 定制
+Factory 返回原生 Commander `Command`。Application 可以修改名称、alias、help、输出或退出行为，也可以跳过
+preset，直接调用 capability：
+```ts
+const entry = await config.get({ key: "runtime.enabled" });
+renderWithMyOwnFormat(entry);
+```
+本 package 不定义配置 key、默认值或持久化规则；这些合同全部属于 `@univer-cli/config`。

package/dist/index.cjs ADDED Viewed

	@@ -0,0 +1 @@
1	+ 'use strict';module['exports']=require('./index.mjs');

package/dist/index.d.ts ADDED Viewed

@@ -0,0 +1,9 @@
+import { Config } from "@univer-cli/config";
+import { Command } from "commander";
+//#region src/index.d.ts
+interface ConfigCommandDependencies {
+  readonly config: Config;
+}
+declare function createConfigCommand(dependencies: ConfigCommandDependencies): Command;
+//#endregion
+export { ConfigCommandDependencies, createConfigCommand };

package/dist/index.mjs ADDED Viewed

@@ -0,0 +1 @@

package/package.json ADDED Viewed

@@ -0,0 +1,26 @@
+{
+  "name": "@univer-cli/config-command",
+  "type": "module",
+  "version": "1.0.0-beta.2",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.mjs",
+      "require": "./dist/index.cjs"
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "README.zh-CN.md"
+  ],
+  "dependencies": {
+    "@univer-cli/config": "1.0.0-beta.2"
+  },
+  "peerDependencies": {
+    "commander": "^15.0.0"
+  }
+}