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

@univer-cli/api-reference-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,67 @@
+# @univer-cli/api-reference-command
+English | [简体中文](./README.zh-CN.md)
+Add `@univer-cli/api-reference` to an existing Commander application with ready-to-use `api find` and `api show` commands.
+## Installation
+```bash
+pnpm add commander @univer-cli/api-reference @univer-cli/api-reference-command
+```
+Commander `^15.0.0` is a peer dependency. Requires Node.js 22.12 or higher.
+## Quick Start
+```ts
+import { createStandardApiReference } from "@univer-cli/api-reference";
+import { createApiCommand } from "@univer-cli/api-reference-command";
+import { Command } from "commander";
+const program = new Command("my-cli");
+program.addCommand(
+  createApiCommand({
+    reference: createStandardApiReference(),
+  }),
+);
+await program.parseAsync();
+```
+After building the CLI, query the reference directly:
+```bash
+my-cli api find setValues "conditional formatting" --unit sheet
+my-cli api show FRange FRange.setValues ICellData.v
+```
+## Command list
+```text
+api find <terms...> [--unit <sheet|slide|doc|base|board>]
+api show <symbols...>
+```
+`find` prints human-readable matches; `show` prints precise details. When a symbol is not found, `show` writes an error and exits non-zero. Commander also handles invalid arguments and reference execution errors.
+## Customize with Commander
+The factory returns a native `Command`, so you can continue to customize its name, aliases, output, and error behavior:
+```ts
+const command = createApiCommand({ reference }).name("reference").alias("api").exitOverride();
+command.configureOutput({
+  writeOut: (text) => process.stdout.write(text),
+  writeErr: (text) => process.stderr.write(text),
+});
+```
+The package does not create a root program or restrict how the application composes other commands.
+## API entry
+- `createApiCommand({ reference })`: Returns a native Commander `Command`.
+- `renderFindResults()`, `renderShowResult()`: Default text presenters.

package/README.zh-CN.md ADDED Viewed

@@ -0,0 +1,69 @@
+# @univer-cli/api-reference-command
+[English](./README.md) | 简体中文
+把 `@univer-cli/api-reference` 接入现有 Commander 应用，提供可直接使用的 `api find` 和 `api show`
+命令。
+## 安装
+```bash
+pnpm add commander @univer-cli/api-reference @univer-cli/api-reference-command
+```
+Commander `^15.0.0` 是 peer dependency。要求 Node.js 22.12 或更高版本。
+## 快速开始
+```ts
+import { createStandardApiReference } from "@univer-cli/api-reference";
+import { createApiCommand } from "@univer-cli/api-reference-command";
+import { Command } from "commander";
+const program = new Command("my-cli");
+program.addCommand(
+  createApiCommand({
+    reference: createStandardApiReference(),
+  }),
+);
+await program.parseAsync();
+```
+构建后可直接查询：
+```bash
+my-cli api find setValues "conditional formatting" --unit sheet
+my-cli api show FRange FRange.setValues ICellData.v
+```
+## 命令一览
+```text
+api find <terms...> [--unit <sheet|slide|doc|base|board>]
+api show <symbols...>
+```
+`find` 输出面向人阅读的候选项；`show` 输出精确详情。找不到 symbol 时写入错误信息并以失败退出，参数非法或
+reference 执行异常也由 Commander 处理。
+## 使用原生 Commander 定制
+Factory 返回原生 `Command`，可以继续修改名称、alias、输出和错误行为：
+```ts
+const command = createApiCommand({ reference }).name("reference").alias("api").exitOverride();
+command.configureOutput({
+  writeOut: (text) => process.stdout.write(text),
+  writeErr: (text) => process.stderr.write(text),
+});
+```
+Package 不创建 root program，也不限制 application 如何组合其他 command。
+## API 入口
+- `createApiCommand({ reference })`：返回原生 Commander `Command`。
+- `renderFindResults()`、`renderShowResult()`：默认文本 presenter。

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 { ApiReference } from "@univer-cli/api-reference";
+import { Command } from "commander";
+//#region src/index.d.ts
+interface ApiReferenceCommandDependencies {
+  readonly reference: ApiReference;
+}
+declare function createApiCommand(dependencies: ApiReferenceCommandDependencies): Command;
+//#endregion
+export { ApiReferenceCommandDependencies, createApiCommand };

package/dist/index.mjs ADDED Viewed

@@ -0,0 +1 @@

package/package.json ADDED Viewed

@@ -0,0 +1,26 @@
+{
+  "name": "@univer-cli/api-reference-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/api-reference": "1.0.0-beta.2"
+  },
+  "peerDependencies": {
+    "commander": "^15.0.0"
+  }
+}