@deot/docs-cli 1.0.1

package/README.md

@@ -0,0 +1,94 @@
+# @deot/docs-cli
+
+`@deot/docs-cli` 提供 `doc` 命令，用于启动文档开发服务、生成静态站点或预览 production 模式下的文档 workspace。
+
+## 安装
+
+```bash
+pnpm add -D @deot/docs-cli
+```
+
+## 快速开始
+
+workspace 必须位于当前项目内，并在自身根部包含 `index.html`。未传参数时
+优先使用 `site/index.html`，不存在时回退到项目根 `index.html`；入口文件本身
+不能是符号链接：
+
+```bash
+pnpm exec doc dev
+```
+
+指定其他 workspace：
+
+```bash
+pnpm exec doc dev --workspace docs
+```
+
+也可以将项目根作为完整 workspace：
+
+```bash
+pnpm exec doc dev --workspace .
+```
+
+## 命令
+
+### `doc dev`
+
+启动 Vite 开发服务。该模式会向 HTML 注入 `window.__DOCS_RUNTIME__`，提供本地资源寻址、`/__docs/events` SSE、已加载资源的更新通知，以及 `PUT /__docs/page` 页面保存入口。保存规则见 [`@deot/docs-dever`](../dever/README.md)。
+
+```bash
+pnpm exec doc dev --workspace site
+```
+
+### `doc build`
+
+以 workspace 的 `index.html` 为入口执行一次 production 构建，并将 workspace 内的静态资源（含 `.page.json`）复制到输出目录。构建完成后进程退出，不启用 watcher 或 SSE。
+
+```bash
+pnpm exec doc build --workspace site --out-dir dist
+```
+
+### `doc preview`
+
+直接以 production runtime 预览 workspace，不生成新的构建产物。默认端口为 `4173`，不会注入开发 runtime，也不会启用 HMR 或 SSE。
+
+```bash
+pnpm exec doc preview --workspace site
+```
+
+## 选项
+
+| 选项 | 适用命令 | 说明 |
+| --- | --- | --- |
+| `--workspace <path>` | 全部 | 项目内的 workspace；未指定时依次探测 `site` 和项目根。 |
+| `--out-dir <path>` | `build` | 输出目录，默认 `dist`。 |
+| `--host <host>` | `preview` | 监听地址，默认 `0.0.0.0`。 |
+| `--port <port>` | `preview` | 监听端口，默认 `4173`。 |
+| `--dry-run [boolean]` | 全部 | 只输出将要运行的模式，不启动服务或执行构建。 |
+| `--package-name <name>` | 全部 | 原样传给运行层的包名上下文；当前核心模式不读取。 |
+| `--custom <value>` | 全部 | 原样传给运行层的扩展信息；当前核心模式不读取。 |
+
+`build` 与 `preview` 是互斥模式，不能在同一次运行中同时启用。
+
+## 配置查找
+
+CLI 会从当前工作目录按以下顺序查找第一个存在的配置文件，并与内置文档插件配置合并：
+
+1. `z.doc.config.js` / `z.doc.config.ts`
+2. `doc.config.js` / `doc.config.ts`
+3. `vite.config.js` / `vite.config.ts`
+
+未找到时使用 `@deot/docs-dever` 自带的 `shared.config.ts`。
+
+## 仓库内验证
+
+在仓库根目录执行：
+
+```bash
+npm run test -- --package-name cli
+npm run build -- --package-name cli
+```
+
+## 许可证
+
+MIT

package/bin/cli.js

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+
+import '../dist/index.js';

package/dist/index.cjs

@@ -0,0 +1,60 @@
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+//#region \0rolldown/runtime.js
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __copyProps = (to, from, except, desc) => {
+	if (from && typeof from === "object" || typeof from === "function") for (var keys = __getOwnPropNames(from), i = 0, n = keys.length, key; i < n; i++) {
+		key = keys[i];
+		if (!__hasOwnProp.call(to, key) && key !== except) __defProp(to, key, {
+			get: ((k) => from[k]).bind(null, key),
+			enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable
+		});
+	}
+	return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(isNodeMode || !mod || !mod.__esModule || !__hasOwnProp.call(mod, "default") ? __defProp(target, "default", {
+	value: mod,
+	enumerable: true
+}) : target, mod));
+//#endregion
+let commander = require("commander");
+let node_module = require("node:module");
+let _deot_docs_dever = require("@deot/docs-dever");
+_deot_docs_dever = __toESM(_deot_docs_dever, 1);
+//#region packages/cli/src/index.ts
+var require$1 = (0, node_module.createRequire)({}.url);
+var defaultOptions = [new commander.Option("--dry-run [boolean]", "Dry Run").argParser((value) => {
+	if (value === "true") return true;
+	if (value === "false") return false;
+	throw new commander.InvalidArgumentError("Expected true or false");
+}), new commander.Option("--custom <string>", "Any Custom Info")];
+var addOptions = (ctx, action) => {
+	defaultOptions.forEach((i) => ctx.addOption(i));
+	ctx.action(action);
+};
+commander.program.version(require$1("../package").version);
+commander.program.usage("<cmd>");
+addOptions(commander.program.command("dev").option("--workspace <string>", "Select Workspace").option("--package-name <string>", "Select PackageName").description("development mode"), _deot_docs_dever.run);
+addOptions(commander.program.command("build").option("--workspace <string>", "Select Workspace").option("--out-dir <string>", "Select Build OutDir").option("--package-name <string>", "Select PackageName").description("production mode"), (options) => _deot_docs_dever.run({
+	...options,
+	build: true
+}));
+addOptions(commander.program.command("preview").option("--workspace <string>", "Select Workspace").option("--host <string>", "Select Host").option("--port <number>", "Select Port", (value) => Number(value)).option("--package-name <string>", "Select PackageName").description("preview workspace in production mode"), (options) => _deot_docs_dever.run({
+	...options,
+	preview: true
+}));
+var main = async () => {
+	try {
+		await commander.program.parseAsync(process.argv);
+		if (!commander.program.args.length) commander.program.help();
+	} catch (reason) {
+		process.exitCode = 1;
+		console.error(reason instanceof Error ? reason.message : reason);
+	}
+};
+main();
+//#endregion

package/dist/index.d.ts

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

package/dist/index.js

@@ -0,0 +1,36 @@
+import { InvalidArgumentError, Option, program } from "commander";
+import { createRequire } from "node:module";
+import * as Dever from "@deot/docs-dever";
+//#region packages/cli/src/index.ts
+var require = createRequire(import.meta.url);
+var defaultOptions = [new Option("--dry-run [boolean]", "Dry Run").argParser((value) => {
+	if (value === "true") return true;
+	if (value === "false") return false;
+	throw new InvalidArgumentError("Expected true or false");
+}), new Option("--custom <string>", "Any Custom Info")];
+var addOptions = (ctx, action) => {
+	defaultOptions.forEach((i) => ctx.addOption(i));
+	ctx.action(action);
+};
+program.version(require("../package").version);
+program.usage("<cmd>");
+addOptions(program.command("dev").option("--workspace <string>", "Select Workspace").option("--package-name <string>", "Select PackageName").description("development mode"), Dever.run);
+addOptions(program.command("build").option("--workspace <string>", "Select Workspace").option("--out-dir <string>", "Select Build OutDir").option("--package-name <string>", "Select PackageName").description("production mode"), (options) => Dever.run({
+	...options,
+	build: true
+}));
+addOptions(program.command("preview").option("--workspace <string>", "Select Workspace").option("--host <string>", "Select Host").option("--port <number>", "Select Port", (value) => Number(value)).option("--package-name <string>", "Select PackageName").description("preview workspace in production mode"), (options) => Dever.run({
+	...options,
+	preview: true
+}));
+var main = async () => {
+	try {
+		await program.parseAsync(process.argv);
+		if (!program.args.length) program.help();
+	} catch (reason) {
+		process.exitCode = 1;
+		console.error(reason instanceof Error ? reason.message : reason);
+	}
+};
+main();
+//#endregion

package/package.json

@@ -0,0 +1,26 @@
+{
+  "name": "@deot/docs-cli",
+  "version": "1.0.1",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "type": "module",
+  "files": [
+    "dist",
+    "config"
+  ],
+  "license": "MIT",
+  "publishConfig": {
+    "access": "public"
+  },
+  "dependencies": {
+    "@deot/docs-dever": "^1.0.1",
+    "commander": "^15.0.0"
+  },
+  "devDependencies": {
+    "cross-env": "^10.0.1",
+    "@deot/dev-test": "^2.9.13"
+  },
+  "bin": {
+    "doc": "bin/cli.js"
+  }
+}