@xyd-js/opencli 0.1.0-build.0

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.
package/dist/index.js ADDED
@@ -0,0 +1,291 @@
1
+ // src/spec.ts
2
+ async function loadOpencliSpec(source, opts) {
3
+ try {
4
+ let content;
5
+ if (source.startsWith("http://") || source.startsWith("https://")) {
6
+ const response = await fetch(source);
7
+ if (!response.ok) {
8
+ throw new Error(`Failed to fetch OpenCLI spec: ${response.statusText}`);
9
+ }
10
+ content = await response.text();
11
+ } else {
12
+ const fs = await import("fs/promises");
13
+ const path = await import("path");
14
+ const base = (opts == null ? void 0 : opts.cwd) ?? process.cwd();
15
+ const resolvedPath = path.isAbsolute(source) ? source : path.resolve(base, source);
16
+ content = await fs.readFile(resolvedPath, "utf-8");
17
+ }
18
+ return JSON.parse(content);
19
+ } catch (error) {
20
+ console.error(`Error loading OpenCLI spec from ${source}:`, error);
21
+ return null;
22
+ }
23
+ }
24
+ function findCommand(spec, commandPath) {
25
+ var _a, _b, _c, _d, _e, _f, _g;
26
+ let parts = commandPath.trim().split(/\s+/).filter(Boolean);
27
+ if (parts.length === 0) {
28
+ return {
29
+ name: ((_a = spec.info) == null ? void 0 : _a.title) || "root",
30
+ description: ((_b = spec.info) == null ? void 0 : _b.description) || ((_c = spec.info) == null ? void 0 : _c.summary),
31
+ options: spec.options || [],
32
+ arguments: spec.arguments || [],
33
+ commands: spec.commands || [],
34
+ examples: spec.examples || [],
35
+ exitCodes: spec.exitCodes || [],
36
+ interactive: spec.interactive
37
+ };
38
+ }
39
+ if (parts.length > 0 && ((_d = spec.info) == null ? void 0 : _d.title) && parts[0] === spec.info.title) {
40
+ parts = parts.slice(1);
41
+ }
42
+ if (parts.length === 0) {
43
+ return {
44
+ name: ((_e = spec.info) == null ? void 0 : _e.title) || "root",
45
+ description: ((_f = spec.info) == null ? void 0 : _f.description) || ((_g = spec.info) == null ? void 0 : _g.summary),
46
+ options: spec.options || [],
47
+ arguments: spec.arguments || [],
48
+ commands: spec.commands || [],
49
+ examples: spec.examples || [],
50
+ exitCodes: spec.exitCodes || [],
51
+ interactive: spec.interactive
52
+ };
53
+ }
54
+ let currentCommands = spec.commands || [];
55
+ let foundCommand = null;
56
+ for (const part of parts) {
57
+ foundCommand = currentCommands.find((cmd) => {
58
+ var _a2;
59
+ return cmd.name === part || ((_a2 = cmd.aliases) == null ? void 0 : _a2.includes(part));
60
+ }) || null;
61
+ if (!foundCommand) {
62
+ return null;
63
+ }
64
+ currentCommands = foundCommand.commands || [];
65
+ }
66
+ return foundCommand;
67
+ }
68
+
69
+ // src/generate.ts
70
+ function generateUsage(_spec, command, commandPath) {
71
+ const parts = [];
72
+ parts.push(commandPath);
73
+ if (command.options && command.options.length > 0) {
74
+ const visibleOptions = command.options.filter((opt) => !opt.hidden);
75
+ if (visibleOptions.length > 0) {
76
+ parts.push("[options]");
77
+ }
78
+ }
79
+ if (command.arguments && command.arguments.length > 0) {
80
+ const visibleArgs = command.arguments.filter((arg) => !arg.hidden);
81
+ const argParts = visibleArgs.map((arg) => {
82
+ const name = arg.name.toLowerCase();
83
+ const suffix = arg.variadic ? "..." : "";
84
+ return arg.required ? `<${name}${suffix}>` : `[${name}${suffix}]`;
85
+ });
86
+ parts.push(...argParts);
87
+ }
88
+ return parts.join(" ");
89
+ }
90
+ function generateDescription(command) {
91
+ return command.description || "";
92
+ }
93
+ function generateArguments(command, indentStyle = "code") {
94
+ if (!command.arguments || command.arguments.length === 0) {
95
+ return "";
96
+ }
97
+ const visibleArgs = command.arguments.filter((arg) => !arg.hidden);
98
+ if (visibleArgs.length === 0) {
99
+ return "";
100
+ }
101
+ const lines = [];
102
+ for (const arg of visibleArgs) {
103
+ const name = arg.name.toLowerCase();
104
+ const desc = arg.description || "";
105
+ if (indentStyle === "list") {
106
+ lines.push(`- \`${name}\`${desc ? ` ${desc}` : ""}`);
107
+ } else {
108
+ const paddedName = name.padEnd(30);
109
+ lines.push(` ${paddedName}${desc}`);
110
+ }
111
+ }
112
+ return lines.join("\n");
113
+ }
114
+ function generateOptions(command, indentStyle = "code") {
115
+ var _a;
116
+ if (!command.options || command.options.length === 0) {
117
+ return "";
118
+ }
119
+ const visibleOptions = command.options.filter((opt) => !opt.hidden);
120
+ if (visibleOptions.length === 0) {
121
+ return "";
122
+ }
123
+ const lines = [];
124
+ for (const option of visibleOptions) {
125
+ const aliases = ((_a = option.aliases) == null ? void 0 : _a.filter((a) => a.length === 1)) || [];
126
+ const short = aliases.length > 0 ? `-${aliases[0]}` : "";
127
+ const long = `--${option.name}`;
128
+ let argPlaceholder = "";
129
+ if (option.arguments && option.arguments.length > 0) {
130
+ const argNames = option.arguments.filter((arg) => !arg.hidden).map((arg) => `<${arg.name.toLowerCase()}>`);
131
+ argPlaceholder = " " + argNames.join(" ");
132
+ }
133
+ const desc = option.description || "";
134
+ if (indentStyle === "list") {
135
+ const shortPart = short ? `\`${short}\`, ` : "";
136
+ lines.push(`- ${shortPart}\`${long}\`${argPlaceholder}${desc ? ` ${desc}` : ""}`);
137
+ } else {
138
+ const signature = `${short ? `${short}, ` : ""}${long}${argPlaceholder}`;
139
+ const paddedSignature = signature.padEnd(30);
140
+ lines.push(` ${paddedSignature}${desc}`);
141
+ }
142
+ }
143
+ return lines.join("\n");
144
+ }
145
+ function generateFlags(command) {
146
+ var _a;
147
+ if (!command.options || command.options.length === 0) {
148
+ return "No flags available.";
149
+ }
150
+ const visibleOptions = command.options.filter((opt) => !opt.hidden);
151
+ if (visibleOptions.length === 0) {
152
+ return "No flags available.";
153
+ }
154
+ const lines = [];
155
+ for (const option of visibleOptions) {
156
+ const optionParts = [];
157
+ const aliases = ((_a = option.aliases) == null ? void 0 : _a.filter((a) => a.length === 1)) || [];
158
+ const short = aliases.length > 0 ? `-${aliases[0]}` : "";
159
+ const long = `--${option.name}`;
160
+ const name = short ? `\`${short}\`, \`${long}\`` : `\`${long}\``;
161
+ optionParts.push(name);
162
+ if (option.required) {
163
+ optionParts.push("**(required)**");
164
+ }
165
+ lines.push(`- ${optionParts.join(" ")}`);
166
+ if (option.description) {
167
+ lines.push(` ${option.description}`);
168
+ }
169
+ if (option.arguments && option.arguments.length > 0) {
170
+ const argParts = option.arguments.filter((arg) => !arg.hidden).map((arg) => {
171
+ const name2 = arg.name.toUpperCase();
172
+ return arg.required ? `<${name2}>` : `[${name2}]`;
173
+ });
174
+ if (argParts.length > 0) {
175
+ lines.push(` Arguments: ${argParts.join(" ")}`);
176
+ }
177
+ }
178
+ }
179
+ return lines.join("\n");
180
+ }
181
+ function generateCommands(command) {
182
+ if (!command.commands || command.commands.length === 0) {
183
+ return "No subcommands available.";
184
+ }
185
+ const visibleCommands = command.commands.filter((cmd) => !cmd.hidden);
186
+ if (visibleCommands.length === 0) {
187
+ return "No subcommands available.";
188
+ }
189
+ const lines = [];
190
+ for (const subcommand of visibleCommands) {
191
+ lines.push(`- \`${subcommand.name}\``);
192
+ if (subcommand.aliases && subcommand.aliases.length > 0) {
193
+ lines.push(` Aliases: ${subcommand.aliases.map((a) => `\`${a}\``).join(", ")}`);
194
+ }
195
+ if (subcommand.description) {
196
+ lines.push(` ${subcommand.description}`);
197
+ }
198
+ }
199
+ return lines.join("\n");
200
+ }
201
+
202
+ // src/converters.ts
203
+ function opencliToReferences(spec, options = {}) {
204
+ var _a, _b;
205
+ if (!spec) return [];
206
+ const cliTitle = ((_a = spec.info) == null ? void 0 : _a.title) || "cli";
207
+ const regionSet = ((_b = options.regions) == null ? void 0 : _b.length) ? new Set(options.regions) : null;
208
+ const refs = [];
209
+ const walk = (commands, parentPath) => {
210
+ var _a2;
211
+ for (const cmd of commands || []) {
212
+ if (cmd.hidden) continue;
213
+ const cmdPath = [...parentPath, cmd.name];
214
+ const region = cmdPath.join(" ");
215
+ if (!regionSet || regionSet.has(region)) {
216
+ refs.push(commandToReference(spec, cmd, cmdPath, cliTitle));
217
+ }
218
+ if ((_a2 = cmd.commands) == null ? void 0 : _a2.length) walk(cmd.commands, cmdPath);
219
+ }
220
+ };
221
+ walk(spec.commands, []);
222
+ return refs;
223
+ }
224
+ function commandToReference(spec, cmd, cmdPath, cliTitle) {
225
+ const region = cmdPath.join(" ");
226
+ const displayPath = `${cliTitle} ${region}`.trim();
227
+ const definitions = [];
228
+ const args = (cmd.arguments || []).filter((a) => !a.hidden);
229
+ if (args.length) {
230
+ definitions.push({ title: "Arguments", properties: args.map(argumentToProperty) });
231
+ }
232
+ const opts = (cmd.options || []).filter((o) => !o.hidden);
233
+ if (opts.length) {
234
+ definitions.push({ title: "Options", properties: opts.map(optionToProperty) });
235
+ }
236
+ const subs = (cmd.commands || []).filter((c) => !c.hidden);
237
+ if (subs.length) {
238
+ definitions.push({
239
+ title: "Commands",
240
+ properties: subs.map((s) => ({
241
+ name: s.name,
242
+ type: "command",
243
+ description: s.description || ""
244
+ }))
245
+ });
246
+ }
247
+ const group = cmdPath.length === 1 ? ["Commands"] : [cmdPath.slice(0, -1).join(" ")];
248
+ return {
249
+ title: region || cliTitle,
250
+ canonical: cmdPath.join("/") || cliTitle,
251
+ description: cmd.description || "",
252
+ // context.path is the region key the docs engine writes into the page
253
+ // frontmatter (`cli: <spec>#<path>`) and reads back to re-resolve the command.
254
+ context: { path: region, fullPath: generateUsage(spec, cmd, displayPath), group },
255
+ examples: { groups: [] },
256
+ definitions
257
+ };
258
+ }
259
+ function argumentToProperty(arg) {
260
+ const meta = arg.required ? [{ name: "required", value: "true" }] : void 0;
261
+ return {
262
+ name: arg.name,
263
+ type: arg.arity ? "array" : "string",
264
+ description: arg.description || "",
265
+ ...meta ? { meta } : {}
266
+ };
267
+ }
268
+ function optionToProperty(opt) {
269
+ var _a, _b;
270
+ const aliasNote = ((_a = opt.aliases) == null ? void 0 : _a.length) ? ` (alias: ${opt.aliases.map((a) => a.length === 1 ? `-${a}` : `--${a}`).join(", ")})` : "";
271
+ const meta = opt.required ? [{ name: "required", value: "true" }] : void 0;
272
+ return {
273
+ name: `--${opt.name}`,
274
+ // an option that takes a value vs. a boolean flag
275
+ type: ((_b = opt.arguments) == null ? void 0 : _b.length) ? "string" : "boolean",
276
+ description: `${opt.description || ""}${aliasNote}`,
277
+ ...meta ? { meta } : {}
278
+ };
279
+ }
280
+ export {
281
+ findCommand,
282
+ generateArguments,
283
+ generateCommands,
284
+ generateDescription,
285
+ generateFlags,
286
+ generateOptions,
287
+ generateUsage,
288
+ loadOpencliSpec,
289
+ opencliToReferences
290
+ };
291
+ //# sourceMappingURL=index.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"sources":["../src/spec.ts","../src/generate.ts","../src/converters.ts"],"sourcesContent":["import type { OpencliSpecJson, Command } from './types.js';\n\nexport interface LoadOpencliSpecOptions {\n /**\n * Base directory used to resolve a relative file `source`.\n * Defaults to `process.cwd()`. (The remark plugin passes the markdown file's dirname.)\n */\n cwd?: string;\n}\n\n/**\n * Load an OpenCLI spec from a file path or an HTTP(S) URL.\n *\n * Returns `null` (and logs) on any failure so callers can leave placeholders\n * untouched rather than throwing.\n */\nexport async function loadOpencliSpec(\n source: string,\n opts?: LoadOpencliSpecOptions,\n): Promise<OpencliSpecJson | null> {\n try {\n let content: string;\n\n if (source.startsWith('http://') || source.startsWith('https://')) {\n // Load from URL\n const response = await fetch(source);\n if (!response.ok) {\n throw new Error(`Failed to fetch OpenCLI spec: ${response.statusText}`);\n }\n content = await response.text();\n } else {\n // Load from file\n const fs = await import('node:fs/promises');\n const path = await import('node:path');\n\n // Resolve relative to the provided cwd (or process.cwd())\n const base = opts?.cwd ?? process.cwd();\n const resolvedPath = path.isAbsolute(source) ? source : path.resolve(base, source);\n\n content = await fs.readFile(resolvedPath, 'utf-8');\n }\n\n return JSON.parse(content) as OpencliSpecJson;\n } catch (error) {\n console.error(`Error loading OpenCLI spec from ${source}:`, error);\n return null;\n }\n}\n\n/**\n * Find a command in the spec by path (e.g., \"spice install\").\n * If the path is empty, returns a synthetic root command built from the spec root.\n */\nexport function findCommand(spec: OpencliSpecJson, commandPath: string): Command | null {\n let parts = commandPath.trim().split(/\\s+/).filter(Boolean);\n\n // If no path specified, create a synthetic root command from spec root\n if (parts.length === 0) {\n return {\n name: spec.info?.title || 'root',\n description: spec.info?.description || spec.info?.summary,\n options: spec.options || [],\n arguments: spec.arguments || [],\n commands: spec.commands || [],\n examples: spec.examples || [],\n exitCodes: spec.exitCodes || [],\n interactive: spec.interactive,\n };\n }\n\n // Skip the CLI name if it matches the first part (e.g., \"spice install\" -> \"install\")\n if (parts.length > 0 && spec.info?.title && parts[0] === spec.info.title) {\n parts = parts.slice(1);\n }\n\n // If only the CLI name was provided, return root command\n if (parts.length === 0) {\n return {\n name: spec.info?.title || 'root',\n description: spec.info?.description || spec.info?.summary,\n options: spec.options || [],\n arguments: spec.arguments || [],\n commands: spec.commands || [],\n examples: spec.examples || [],\n exitCodes: spec.exitCodes || [],\n interactive: spec.interactive,\n };\n }\n\n // Start from root commands\n let currentCommands = spec.commands || [];\n let foundCommand: Command | null = null;\n\n for (const part of parts) {\n foundCommand = currentCommands.find((cmd) => cmd.name === part || cmd.aliases?.includes(part)) || null;\n\n if (!foundCommand) {\n return null;\n }\n\n // Move to subcommands for next iteration\n currentCommands = foundCommand.commands || [];\n }\n\n return foundCommand;\n}\n","import type { OpencliSpecJson, Command } from './types.js';\n\nexport type IndentStyle = 'code' | 'list';\n\n/**\n * Generate usage line for a command (like: \"shadcn init [options] [components...]\")\n */\nexport function generateUsage(_spec: OpencliSpecJson, command: Command, commandPath: string): string {\n const parts: string[] = [];\n\n // Command path\n parts.push(commandPath);\n\n // Options indicator\n if (command.options && command.options.length > 0) {\n const visibleOptions = command.options.filter((opt) => !opt.hidden);\n if (visibleOptions.length > 0) {\n parts.push('[options]');\n }\n }\n\n // Arguments\n if (command.arguments && command.arguments.length > 0) {\n const visibleArgs = command.arguments.filter((arg) => !arg.hidden);\n const argParts = visibleArgs.map((arg) => {\n const name = arg.name.toLowerCase();\n // Use ... suffix if argument can accept multiple values (variadic)\n const suffix = arg.variadic ? '...' : '';\n return arg.required ? `<${name}${suffix}>` : `[${name}${suffix}]`;\n });\n parts.push(...argParts);\n }\n\n return parts.join(' ');\n}\n\n/**\n * Generate description for a command\n */\nexport function generateDescription(command: Command): string {\n return command.description || '';\n}\n\n/**\n * Generate arguments documentation\n * @param indentStyle - 'code' for tab-indented CLI style, 'list' for markdown list style\n */\nexport function generateArguments(command: Command, indentStyle: IndentStyle = 'code'): string {\n if (!command.arguments || command.arguments.length === 0) {\n return '';\n }\n\n const visibleArgs = command.arguments.filter((arg) => !arg.hidden);\n if (visibleArgs.length === 0) {\n return '';\n }\n\n const lines: string[] = [];\n\n for (const arg of visibleArgs) {\n const name = arg.name.toLowerCase();\n const desc = arg.description || '';\n\n if (indentStyle === 'list') {\n // Markdown list format: - `package` Package name\n lines.push(`- \\`${name}\\`${desc ? ` ${desc}` : ''}`);\n } else {\n // Code/CLI format with tab indentation\n const paddedName = name.padEnd(30);\n lines.push(`\\t${paddedName}${desc}`);\n }\n }\n\n return lines.join('\\n');\n}\n\n/**\n * Generate options documentation\n * @param indentStyle - 'code' for tab-indented CLI style, 'list' for markdown list style\n */\nexport function generateOptions(command: Command, indentStyle: IndentStyle = 'code'): string {\n if (!command.options || command.options.length === 0) {\n return '';\n }\n\n const visibleOptions = command.options.filter((opt) => !opt.hidden);\n if (visibleOptions.length === 0) {\n return '';\n }\n\n const lines: string[] = [];\n\n for (const option of visibleOptions) {\n // Build option signature\n const aliases = option.aliases?.filter((a) => a.length === 1) || [];\n const short = aliases.length > 0 ? `-${aliases[0]}` : '';\n const long = `--${option.name}`;\n\n // Add argument placeholder if option takes arguments\n let argPlaceholder = '';\n if (option.arguments && option.arguments.length > 0) {\n const argNames = option.arguments.filter((arg) => !arg.hidden).map((arg) => `<${arg.name.toLowerCase()}>`);\n argPlaceholder = ' ' + argNames.join(' ');\n }\n\n const desc = option.description || '';\n\n if (indentStyle === 'list') {\n // Markdown list format: - `-g`, `--global` Install globally\n const shortPart = short ? `\\`${short}\\`, ` : '';\n lines.push(`- ${shortPart}\\`${long}\\`${argPlaceholder}${desc ? ` ${desc}` : ''}`);\n } else {\n // Code/CLI format with tab indentation\n const signature = `${short ? `${short}, ` : ''}${long}${argPlaceholder}`;\n const paddedSignature = signature.padEnd(30);\n lines.push(`\\t${paddedSignature}${desc}`);\n }\n }\n\n return lines.join('\\n');\n}\n\n/**\n * TODO: OPTIONS DO ALMOST THE SAME\n * Generate flags/options documentation\n */\nexport function generateFlags(command: Command): string {\n if (!command.options || command.options.length === 0) {\n return 'No flags available.';\n }\n\n const visibleOptions = command.options.filter((opt) => !opt.hidden);\n if (visibleOptions.length === 0) {\n return 'No flags available.';\n }\n\n const lines: string[] = [];\n\n for (const option of visibleOptions) {\n const optionParts: string[] = [];\n\n // Option name and aliases\n const aliases = option.aliases?.filter((a) => a.length === 1) || [];\n const short = aliases.length > 0 ? `-${aliases[0]}` : '';\n const long = `--${option.name}`;\n const name = short ? `\\`${short}\\`, \\`${long}\\`` : `\\`${long}\\``;\n optionParts.push(name);\n\n // Required indicator\n if (option.required) {\n optionParts.push('**(required)**');\n }\n\n lines.push(`- ${optionParts.join(' ')}`);\n\n // Description\n if (option.description) {\n lines.push(` ${option.description}`);\n }\n\n // Option arguments\n if (option.arguments && option.arguments.length > 0) {\n const argParts = option.arguments\n .filter((arg) => !arg.hidden)\n .map((arg) => {\n const name = arg.name.toUpperCase();\n return arg.required ? `<${name}>` : `[${name}]`;\n });\n if (argParts.length > 0) {\n lines.push(` Arguments: ${argParts.join(' ')}`);\n }\n }\n }\n\n return lines.join('\\n');\n}\n\n/**\n * Generate subcommands documentation\n */\nexport function generateCommands(command: Command): string {\n if (!command.commands || command.commands.length === 0) {\n return 'No subcommands available.';\n }\n\n const visibleCommands = command.commands.filter((cmd) => !cmd.hidden);\n if (visibleCommands.length === 0) {\n return 'No subcommands available.';\n }\n\n const lines: string[] = [];\n\n for (const subcommand of visibleCommands) {\n lines.push(`- \\`${subcommand.name}\\``);\n\n if (subcommand.aliases && subcommand.aliases.length > 0) {\n lines.push(` Aliases: ${subcommand.aliases.map((a) => `\\`${a}\\``).join(', ')}`);\n }\n\n if (subcommand.description) {\n lines.push(` ${subcommand.description}`);\n }\n }\n\n return lines.join('\\n');\n}\n","import { generateUsage } from './generate';\nimport type { Argument, Command, OpencliSpecJson, Option } from './types';\n\n// Structural subset of @xyd-js/uniform's `Reference` — kept local so the OpenCLI\n// core stays free of the (React-typed) uniform package. The docs engine consumes\n// these as uniform References (api.cli → Atlas).\ninterface OpencliRefProperty {\n name: string;\n type: string;\n description: string;\n meta?: { name: string; value: unknown }[];\n}\ninterface OpencliRefDefinition {\n title: string;\n properties: OpencliRefProperty[];\n}\nexport interface OpencliReference {\n title: string;\n canonical: string;\n description: string;\n // `group` drives sidebar placement (the docs engine groups references by it);\n // `path` is the region key round-tripped through the page frontmatter.\n context: { path: string; fullPath: string; group: string[] };\n examples: { groups: never[] };\n definitions: OpencliRefDefinition[];\n}\n\nexport interface OpencliToReferencesOptions {\n /**\n * Restrict output to specific commands. Each region is a command path,\n * space-joined from the CLI root (e.g. `\"install\"`, `\"remote add\"`).\n */\n regions?: string[];\n}\n\n/**\n * Convert an OpenCLI document to uniform `Reference[]` — one Reference per\n * command — so the docs engine can render CLI reference pages the same way it\n * renders OpenAPI/GraphQL (`api.cli`). Mirrors `oapSchemaToReferences`.\n */\nexport function opencliToReferences(\n spec: OpencliSpecJson | null | undefined,\n options: OpencliToReferencesOptions = {},\n): OpencliReference[] {\n if (!spec) return [];\n\n const cliTitle = spec.info?.title || 'cli';\n const regionSet = options.regions?.length ? new Set(options.regions) : null;\n const refs: OpencliReference[] = [];\n\n const walk = (commands: Command[] | undefined, parentPath: string[]) => {\n for (const cmd of commands || []) {\n if (cmd.hidden) continue;\n const cmdPath = [...parentPath, cmd.name];\n const region = cmdPath.join(' ');\n if (!regionSet || regionSet.has(region)) {\n refs.push(commandToReference(spec, cmd, cmdPath, cliTitle));\n }\n if (cmd.commands?.length) walk(cmd.commands, cmdPath);\n }\n };\n walk(spec.commands, []);\n\n return refs;\n}\n\nfunction commandToReference(\n spec: OpencliSpecJson,\n cmd: Command,\n cmdPath: string[],\n cliTitle: string,\n): OpencliReference {\n const region = cmdPath.join(' ');\n const displayPath = `${cliTitle} ${region}`.trim();\n\n const definitions: OpencliRefDefinition[] = [];\n\n const args = (cmd.arguments || []).filter((a) => !a.hidden);\n if (args.length) {\n definitions.push({ title: 'Arguments', properties: args.map(argumentToProperty) });\n }\n\n const opts = (cmd.options || []).filter((o) => !o.hidden);\n if (opts.length) {\n definitions.push({ title: 'Options', properties: opts.map(optionToProperty) });\n }\n\n const subs = (cmd.commands || []).filter((c) => !c.hidden);\n if (subs.length) {\n definitions.push({\n title: 'Commands',\n properties: subs.map((s) => ({\n name: s.name,\n type: 'command',\n description: s.description || '',\n })),\n });\n }\n\n // Sidebar grouping: top-level commands sit under \"Commands\"; a subcommand sits\n // under a group named after its parent path (e.g. `auth login` → group \"auth\").\n // (One group level is required — the docs engine drops references with an empty\n // group — and a group must not mix direct pages with subgroups.)\n const group = cmdPath.length === 1 ? ['Commands'] : [cmdPath.slice(0, -1).join(' ')];\n\n return {\n title: region || cliTitle,\n canonical: cmdPath.join('/') || cliTitle,\n description: cmd.description || '',\n // context.path is the region key the docs engine writes into the page\n // frontmatter (`cli: <spec>#<path>`) and reads back to re-resolve the command.\n context: { path: region, fullPath: generateUsage(spec, cmd, displayPath), group },\n examples: { groups: [] },\n definitions,\n };\n}\n\nfunction argumentToProperty(arg: Argument): OpencliRefProperty {\n const meta = arg.required ? [{ name: 'required', value: 'true' }] : undefined;\n return {\n name: arg.name,\n type: arg.arity ? 'array' : 'string',\n description: arg.description || '',\n ...(meta ? { meta } : {}),\n };\n}\n\nfunction optionToProperty(opt: Option): OpencliRefProperty {\n const aliasNote = opt.aliases?.length\n ? ` (alias: ${opt.aliases.map((a) => (a.length === 1 ? `-${a}` : `--${a}`)).join(', ')})`\n : '';\n const meta = opt.required ? [{ name: 'required', value: 'true' }] : undefined;\n return {\n name: `--${opt.name}`,\n // an option that takes a value vs. a boolean flag\n type: opt.arguments?.length ? 'string' : 'boolean',\n description: `${opt.description || ''}${aliasNote}`,\n ...(meta ? { meta } : {}),\n };\n}\n"],"mappings":";AAgBA,eAAsB,gBACpB,QACA,MACiC;AACjC,MAAI;AACF,QAAI;AAEJ,QAAI,OAAO,WAAW,SAAS,KAAK,OAAO,WAAW,UAAU,GAAG;AAEjE,YAAM,WAAW,MAAM,MAAM,MAAM;AACnC,UAAI,CAAC,SAAS,IAAI;AAChB,cAAM,IAAI,MAAM,iCAAiC,SAAS,UAAU,EAAE;AAAA,MACxE;AACA,gBAAU,MAAM,SAAS,KAAK;AAAA,IAChC,OAAO;AAEL,YAAM,KAAK,MAAM,OAAO,aAAkB;AAC1C,YAAM,OAAO,MAAM,OAAO,MAAW;AAGrC,YAAM,QAAO,6BAAM,QAAO,QAAQ,IAAI;AACtC,YAAM,eAAe,KAAK,WAAW,MAAM,IAAI,SAAS,KAAK,QAAQ,MAAM,MAAM;AAEjF,gBAAU,MAAM,GAAG,SAAS,cAAc,OAAO;AAAA,IACnD;AAEA,WAAO,KAAK,MAAM,OAAO;AAAA,EAC3B,SAAS,OAAO;AACd,YAAQ,MAAM,mCAAmC,MAAM,KAAK,KAAK;AACjE,WAAO;AAAA,EACT;AACF;AAMO,SAAS,YAAY,MAAuB,aAAqC;AArDxF;AAsDE,MAAI,QAAQ,YAAY,KAAK,EAAE,MAAM,KAAK,EAAE,OAAO,OAAO;AAG1D,MAAI,MAAM,WAAW,GAAG;AACtB,WAAO;AAAA,MACL,QAAM,UAAK,SAAL,mBAAW,UAAS;AAAA,MAC1B,eAAa,UAAK,SAAL,mBAAW,kBAAe,UAAK,SAAL,mBAAW;AAAA,MAClD,SAAS,KAAK,WAAW,CAAC;AAAA,MAC1B,WAAW,KAAK,aAAa,CAAC;AAAA,MAC9B,UAAU,KAAK,YAAY,CAAC;AAAA,MAC5B,UAAU,KAAK,YAAY,CAAC;AAAA,MAC5B,WAAW,KAAK,aAAa,CAAC;AAAA,MAC9B,aAAa,KAAK;AAAA,IACpB;AAAA,EACF;AAGA,MAAI,MAAM,SAAS,OAAK,UAAK,SAAL,mBAAW,UAAS,MAAM,CAAC,MAAM,KAAK,KAAK,OAAO;AACxE,YAAQ,MAAM,MAAM,CAAC;AAAA,EACvB;AAGA,MAAI,MAAM,WAAW,GAAG;AACtB,WAAO;AAAA,MACL,QAAM,UAAK,SAAL,mBAAW,UAAS;AAAA,MAC1B,eAAa,UAAK,SAAL,mBAAW,kBAAe,UAAK,SAAL,mBAAW;AAAA,MAClD,SAAS,KAAK,WAAW,CAAC;AAAA,MAC1B,WAAW,KAAK,aAAa,CAAC;AAAA,MAC9B,UAAU,KAAK,YAAY,CAAC;AAAA,MAC5B,UAAU,KAAK,YAAY,CAAC;AAAA,MAC5B,WAAW,KAAK,aAAa,CAAC;AAAA,MAC9B,aAAa,KAAK;AAAA,IACpB;AAAA,EACF;AAGA,MAAI,kBAAkB,KAAK,YAAY,CAAC;AACxC,MAAI,eAA+B;AAEnC,aAAW,QAAQ,OAAO;AACxB,mBAAe,gBAAgB,KAAK,CAAC,QAAK;AA9F9C,UAAAA;AA8FiD,iBAAI,SAAS,UAAQA,MAAA,IAAI,YAAJ,gBAAAA,IAAa,SAAS;AAAA,KAAK,KAAK;AAElG,QAAI,CAAC,cAAc;AACjB,aAAO;AAAA,IACT;AAGA,sBAAkB,aAAa,YAAY,CAAC;AAAA,EAC9C;AAEA,SAAO;AACT;;;AClGO,SAAS,cAAc,OAAwB,SAAkB,aAA6B;AACnG,QAAM,QAAkB,CAAC;AAGzB,QAAM,KAAK,WAAW;AAGtB,MAAI,QAAQ,WAAW,QAAQ,QAAQ,SAAS,GAAG;AACjD,UAAM,iBAAiB,QAAQ,QAAQ,OAAO,CAAC,QAAQ,CAAC,IAAI,MAAM;AAClE,QAAI,eAAe,SAAS,GAAG;AAC7B,YAAM,KAAK,WAAW;AAAA,IACxB;AAAA,EACF;AAGA,MAAI,QAAQ,aAAa,QAAQ,UAAU,SAAS,GAAG;AACrD,UAAM,cAAc,QAAQ,UAAU,OAAO,CAAC,QAAQ,CAAC,IAAI,MAAM;AACjE,UAAM,WAAW,YAAY,IAAI,CAAC,QAAQ;AACxC,YAAM,OAAO,IAAI,KAAK,YAAY;AAElC,YAAM,SAAS,IAAI,WAAW,QAAQ;AACtC,aAAO,IAAI,WAAW,IAAI,IAAI,GAAG,MAAM,MAAM,IAAI,IAAI,GAAG,MAAM;AAAA,IAChE,CAAC;AACD,UAAM,KAAK,GAAG,QAAQ;AAAA,EACxB;AAEA,SAAO,MAAM,KAAK,GAAG;AACvB;AAKO,SAAS,oBAAoB,SAA0B;AAC5D,SAAO,QAAQ,eAAe;AAChC;AAMO,SAAS,kBAAkB,SAAkB,cAA2B,QAAgB;AAC7F,MAAI,CAAC,QAAQ,aAAa,QAAQ,UAAU,WAAW,GAAG;AACxD,WAAO;AAAA,EACT;AAEA,QAAM,cAAc,QAAQ,UAAU,OAAO,CAAC,QAAQ,CAAC,IAAI,MAAM;AACjE,MAAI,YAAY,WAAW,GAAG;AAC5B,WAAO;AAAA,EACT;AAEA,QAAM,QAAkB,CAAC;AAEzB,aAAW,OAAO,aAAa;AAC7B,UAAM,OAAO,IAAI,KAAK,YAAY;AAClC,UAAM,OAAO,IAAI,eAAe;AAEhC,QAAI,gBAAgB,QAAQ;AAE1B,YAAM,KAAK,OAAO,IAAI,KAAK,OAAO,KAAK,IAAI,KAAK,EAAE,EAAE;AAAA,IACtD,OAAO;AAEL,YAAM,aAAa,KAAK,OAAO,EAAE;AACjC,YAAM,KAAK,IAAK,UAAU,GAAG,IAAI,EAAE;AAAA,IACrC;AAAA,EACF;AAEA,SAAO,MAAM,KAAK,IAAI;AACxB;AAMO,SAAS,gBAAgB,SAAkB,cAA2B,QAAgB;AAhF7F;AAiFE,MAAI,CAAC,QAAQ,WAAW,QAAQ,QAAQ,WAAW,GAAG;AACpD,WAAO;AAAA,EACT;AAEA,QAAM,iBAAiB,QAAQ,QAAQ,OAAO,CAAC,QAAQ,CAAC,IAAI,MAAM;AAClE,MAAI,eAAe,WAAW,GAAG;AAC/B,WAAO;AAAA,EACT;AAEA,QAAM,QAAkB,CAAC;AAEzB,aAAW,UAAU,gBAAgB;AAEnC,UAAM,YAAU,YAAO,YAAP,mBAAgB,OAAO,CAAC,MAAM,EAAE,WAAW,OAAM,CAAC;AAClE,UAAM,QAAQ,QAAQ,SAAS,IAAI,IAAI,QAAQ,CAAC,CAAC,KAAK;AACtD,UAAM,OAAO,KAAK,OAAO,IAAI;AAG7B,QAAI,iBAAiB;AACrB,QAAI,OAAO,aAAa,OAAO,UAAU,SAAS,GAAG;AACnD,YAAM,WAAW,OAAO,UAAU,OAAO,CAAC,QAAQ,CAAC,IAAI,MAAM,EAAE,IAAI,CAAC,QAAQ,IAAI,IAAI,KAAK,YAAY,CAAC,GAAG;AACzG,uBAAiB,MAAM,SAAS,KAAK,GAAG;AAAA,IAC1C;AAEA,UAAM,OAAO,OAAO,eAAe;AAEnC,QAAI,gBAAgB,QAAQ;AAE1B,YAAM,YAAY,QAAQ,KAAK,KAAK,SAAS;AAC7C,YAAM,KAAK,KAAK,SAAS,KAAK,IAAI,KAAK,cAAc,GAAG,OAAO,KAAK,IAAI,KAAK,EAAE,EAAE;AAAA,IACnF,OAAO;AAEL,YAAM,YAAY,GAAG,QAAQ,GAAG,KAAK,OAAO,EAAE,GAAG,IAAI,GAAG,cAAc;AACtE,YAAM,kBAAkB,UAAU,OAAO,EAAE;AAC3C,YAAM,KAAK,IAAK,eAAe,GAAG,IAAI,EAAE;AAAA,IAC1C;AAAA,EACF;AAEA,SAAO,MAAM,KAAK,IAAI;AACxB;AAMO,SAAS,cAAc,SAA0B;AA9HxD;AA+HE,MAAI,CAAC,QAAQ,WAAW,QAAQ,QAAQ,WAAW,GAAG;AACpD,WAAO;AAAA,EACT;AAEA,QAAM,iBAAiB,QAAQ,QAAQ,OAAO,CAAC,QAAQ,CAAC,IAAI,MAAM;AAClE,MAAI,eAAe,WAAW,GAAG;AAC/B,WAAO;AAAA,EACT;AAEA,QAAM,QAAkB,CAAC;AAEzB,aAAW,UAAU,gBAAgB;AACnC,UAAM,cAAwB,CAAC;AAG/B,UAAM,YAAU,YAAO,YAAP,mBAAgB,OAAO,CAAC,MAAM,EAAE,WAAW,OAAM,CAAC;AAClE,UAAM,QAAQ,QAAQ,SAAS,IAAI,IAAI,QAAQ,CAAC,CAAC,KAAK;AACtD,UAAM,OAAO,KAAK,OAAO,IAAI;AAC7B,UAAM,OAAO,QAAQ,KAAK,KAAK,SAAS,IAAI,OAAO,KAAK,IAAI;AAC5D,gBAAY,KAAK,IAAI;AAGrB,QAAI,OAAO,UAAU;AACnB,kBAAY,KAAK,gBAAgB;AAAA,IACnC;AAEA,UAAM,KAAK,KAAK,YAAY,KAAK,GAAG,CAAC,EAAE;AAGvC,QAAI,OAAO,aAAa;AACtB,YAAM,KAAK,KAAK,OAAO,WAAW,EAAE;AAAA,IACtC;AAGA,QAAI,OAAO,aAAa,OAAO,UAAU,SAAS,GAAG;AACnD,YAAM,WAAW,OAAO,UACrB,OAAO,CAAC,QAAQ,CAAC,IAAI,MAAM,EAC3B,IAAI,CAAC,QAAQ;AACZ,cAAMC,QAAO,IAAI,KAAK,YAAY;AAClC,eAAO,IAAI,WAAW,IAAIA,KAAI,MAAM,IAAIA,KAAI;AAAA,MAC9C,CAAC;AACH,UAAI,SAAS,SAAS,GAAG;AACvB,cAAM,KAAK,gBAAgB,SAAS,KAAK,GAAG,CAAC,EAAE;AAAA,MACjD;AAAA,IACF;AAAA,EACF;AAEA,SAAO,MAAM,KAAK,IAAI;AACxB;AAKO,SAAS,iBAAiB,SAA0B;AACzD,MAAI,CAAC,QAAQ,YAAY,QAAQ,SAAS,WAAW,GAAG;AACtD,WAAO;AAAA,EACT;AAEA,QAAM,kBAAkB,QAAQ,SAAS,OAAO,CAAC,QAAQ,CAAC,IAAI,MAAM;AACpE,MAAI,gBAAgB,WAAW,GAAG;AAChC,WAAO;AAAA,EACT;AAEA,QAAM,QAAkB,CAAC;AAEzB,aAAW,cAAc,iBAAiB;AACxC,UAAM,KAAK,OAAO,WAAW,IAAI,IAAI;AAErC,QAAI,WAAW,WAAW,WAAW,QAAQ,SAAS,GAAG;AACvD,YAAM,KAAK,cAAc,WAAW,QAAQ,IAAI,CAAC,MAAM,KAAK,CAAC,IAAI,EAAE,KAAK,IAAI,CAAC,EAAE;AAAA,IACjF;AAEA,QAAI,WAAW,aAAa;AAC1B,YAAM,KAAK,KAAK,WAAW,WAAW,EAAE;AAAA,IAC1C;AAAA,EACF;AAEA,SAAO,MAAM,KAAK,IAAI;AACxB;;;ACrKO,SAAS,oBACd,MACA,UAAsC,CAAC,GACnB;AA3CtB;AA4CE,MAAI,CAAC,KAAM,QAAO,CAAC;AAEnB,QAAM,aAAW,UAAK,SAAL,mBAAW,UAAS;AACrC,QAAM,cAAY,aAAQ,YAAR,mBAAiB,UAAS,IAAI,IAAI,QAAQ,OAAO,IAAI;AACvE,QAAM,OAA2B,CAAC;AAElC,QAAM,OAAO,CAAC,UAAiC,eAAyB;AAlD1E,QAAAC;AAmDI,eAAW,OAAO,YAAY,CAAC,GAAG;AAChC,UAAI,IAAI,OAAQ;AAChB,YAAM,UAAU,CAAC,GAAG,YAAY,IAAI,IAAI;AACxC,YAAM,SAAS,QAAQ,KAAK,GAAG;AAC/B,UAAI,CAAC,aAAa,UAAU,IAAI,MAAM,GAAG;AACvC,aAAK,KAAK,mBAAmB,MAAM,KAAK,SAAS,QAAQ,CAAC;AAAA,MAC5D;AACA,WAAIA,MAAA,IAAI,aAAJ,gBAAAA,IAAc,OAAQ,MAAK,IAAI,UAAU,OAAO;AAAA,IACtD;AAAA,EACF;AACA,OAAK,KAAK,UAAU,CAAC,CAAC;AAEtB,SAAO;AACT;AAEA,SAAS,mBACP,MACA,KACA,SACA,UACkB;AAClB,QAAM,SAAS,QAAQ,KAAK,GAAG;AAC/B,QAAM,cAAc,GAAG,QAAQ,IAAI,MAAM,GAAG,KAAK;AAEjD,QAAM,cAAsC,CAAC;AAE7C,QAAM,QAAQ,IAAI,aAAa,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,EAAE,MAAM;AAC1D,MAAI,KAAK,QAAQ;AACf,gBAAY,KAAK,EAAE,OAAO,aAAa,YAAY,KAAK,IAAI,kBAAkB,EAAE,CAAC;AAAA,EACnF;AAEA,QAAM,QAAQ,IAAI,WAAW,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,EAAE,MAAM;AACxD,MAAI,KAAK,QAAQ;AACf,gBAAY,KAAK,EAAE,OAAO,WAAW,YAAY,KAAK,IAAI,gBAAgB,EAAE,CAAC;AAAA,EAC/E;AAEA,QAAM,QAAQ,IAAI,YAAY,CAAC,GAAG,OAAO,CAAC,MAAM,CAAC,EAAE,MAAM;AACzD,MAAI,KAAK,QAAQ;AACf,gBAAY,KAAK;AAAA,MACf,OAAO;AAAA,MACP,YAAY,KAAK,IAAI,CAAC,OAAO;AAAA,QAC3B,MAAM,EAAE;AAAA,QACR,MAAM;AAAA,QACN,aAAa,EAAE,eAAe;AAAA,MAChC,EAAE;AAAA,IACJ,CAAC;AAAA,EACH;AAMA,QAAM,QAAQ,QAAQ,WAAW,IAAI,CAAC,UAAU,IAAI,CAAC,QAAQ,MAAM,GAAG,EAAE,EAAE,KAAK,GAAG,CAAC;AAEnF,SAAO;AAAA,IACL,OAAO,UAAU;AAAA,IACjB,WAAW,QAAQ,KAAK,GAAG,KAAK;AAAA,IAChC,aAAa,IAAI,eAAe;AAAA;AAAA;AAAA,IAGhC,SAAS,EAAE,MAAM,QAAQ,UAAU,cAAc,MAAM,KAAK,WAAW,GAAG,MAAM;AAAA,IAChF,UAAU,EAAE,QAAQ,CAAC,EAAE;AAAA,IACvB;AAAA,EACF;AACF;AAEA,SAAS,mBAAmB,KAAmC;AAC7D,QAAM,OAAO,IAAI,WAAW,CAAC,EAAE,MAAM,YAAY,OAAO,OAAO,CAAC,IAAI;AACpE,SAAO;AAAA,IACL,MAAM,IAAI;AAAA,IACV,MAAM,IAAI,QAAQ,UAAU;AAAA,IAC5B,aAAa,IAAI,eAAe;AAAA,IAChC,GAAI,OAAO,EAAE,KAAK,IAAI,CAAC;AAAA,EACzB;AACF;AAEA,SAAS,iBAAiB,KAAiC;AA/H3D;AAgIE,QAAM,cAAY,SAAI,YAAJ,mBAAa,UAC3B,YAAY,IAAI,QAAQ,IAAI,CAAC,MAAO,EAAE,WAAW,IAAI,IAAI,CAAC,KAAK,KAAK,CAAC,EAAG,EAAE,KAAK,IAAI,CAAC,MACpF;AACJ,QAAM,OAAO,IAAI,WAAW,CAAC,EAAE,MAAM,YAAY,OAAO,OAAO,CAAC,IAAI;AACpE,SAAO;AAAA,IACL,MAAM,KAAK,IAAI,IAAI;AAAA;AAAA,IAEnB,QAAM,SAAI,cAAJ,mBAAe,UAAS,WAAW;AAAA,IACzC,aAAa,GAAG,IAAI,eAAe,EAAE,GAAG,SAAS;AAAA,IACjD,GAAI,OAAO,EAAE,KAAK,IAAI,CAAC;AAAA,EACzB;AACF;","names":["_a","name","_a"]}
package/index.ts ADDED
@@ -0,0 +1 @@
1
+ export * from './src';