@zitadel/cli 0.1.0-alpha.9 → 0.2.0

package/dist/lib/oclif/help.mjs

@@ -0,0 +1,117 @@
+import { A as compareInGroup, O as COMMAND_GROUPS, i as exploreAllCommands, k as CommandGroups, t as showSkillsHint } from "../../skills-hint-CBoak9HL.mjs";
+import { Help, toConfiguredId, ux } from "@oclif/core";
+//#region src/lib/oclif/help.ts
+/**
+* Summaries for oclif plugin commands that ship without one. `version` prints
+* a blank line otherwise.
+*/
+const PLUGIN_SUMMARIES = { version: "Show the CLI version" };
+/**
+* Root help in the style of `gh --help`: a tagline, usage, the commands under
+* headed groups, then flags and examples. A family of commands (`users`,
+* `release`) is one row, and its own help lists the operations. Only
+* {@link showRootHelp} is replaced; per-command and per-topic help
+* (`start --help`, `schemas --help`) stay oclif's own, with a pointer back to
+* the root screen added. Wired in via `oclif.helpClass` in `package.json`.
+*/
+var ZitadelHelp = class extends Help {
+	async showRootHelp() {
+		const { bin } = this.config;
+		const commands = this.rootCommands();
+		const groups = COMMAND_GROUPS.map((group) => [group, this.rowsOf(this.commandsOf(commands, group))]).filter(([, rows]) => rows.length > 0);
+		const width = Math.max(0, ...groups.flatMap(([, rows]) => rows.map((row) => row.name.length)));
+		const list = (rows) => rows.map((row) => `${row.name.padEnd(width)}  ${row.summary}`).join("\n");
+		const sections = [
+			this.render(this.config.pjson.oclif.description ?? this.config.pjson.description ?? ""),
+			this.section("Usage", `${bin} <command> [flags]`),
+			`Run a command below. Use \`${bin} <command> --help\` to see its options.`,
+			...groups.map(([group, rows]) => this.section(group, list(rows))),
+			this.section("Flags", ["--help      Show help for command", `--version   Show ${bin} version`].join("\n")),
+			this.section("Examples", [
+				`$ ${bin} setup --framework next`,
+				`$ ${bin} start`,
+				`$ ${bin} doctor`
+			].join("\n"))
+		];
+		if (process.argv.length <= 2) await showSkillsHint({
+			env: process.env,
+			interactive: Boolean(process.stdout.isTTY && process.stdin.isTTY)
+		});
+		this.log(sections.join("\n\n"));
+	}
+	async showCommandHelp(command) {
+		await super.showCommandHelp(command);
+		this.log(exploreAllCommands(this.config.version));
+	}
+	async showTopicHelp(topic) {
+		await super.showTopicHelp(topic);
+		this.log(exploreAllCommands(this.config.version));
+	}
+	/**
+	* The commands the root screen lists: every visible command, grouped or
+	* not, whatever its depth. Alias entries and `help` itself are left out.
+	*/
+	rootCommands() {
+		return this.sortedCommands.filter((command) => command.id !== "help" && !command.aliases?.includes(command.id));
+	}
+	/**
+	* The commands a group lists. oclif's own utilities declare no group and are
+	* listed with the last one.
+	*/
+	commandsOf(commands, group) {
+		return commands.filter((command) => command.group === group || command.group === void 0 && group === CommandGroups.diagnostics);
+	}
+	/**
+	* The rows of one group. Commands sharing a first word (`users create`,
+	* `users get`) are one row named for it, described by the topic when it has
+	* a description and otherwise by the command of that name; a command on its
+	* own keeps its name. Rows follow `groupOrder` (the lowest of a family's
+	* commands), then the name.
+	*/
+	rowsOf(commands) {
+		const families = /* @__PURE__ */ new Map();
+		for (const command of commands) {
+			const [family = command.id] = command.id.split(":");
+			families.set(family, [...families.get(family) ?? [], command]);
+		}
+		return [...families].map(([family, members]) => {
+			const order = Math.min(...members.map((member) => member.groupOrder ?? Number.MAX_SAFE_INTEGER));
+			if (!members.some((member) => member.id.includes(":"))) {
+				const [only] = members;
+				return {
+					name: toConfiguredId(family, this.config),
+					summary: this.oneLineSummary(only?.summary ?? only?.description, only?.id),
+					order
+				};
+			}
+			const topic = this.config.topics.find((candidate) => candidate.name === family);
+			const root = members.find((member) => member.id === family) ?? members[0];
+			return {
+				name: toConfiguredId(family, this.config),
+				summary: this.oneLineSummary(topic?.description ?? root?.summary ?? root?.description),
+				order
+			};
+		}).sort((a, b) => compareInGroup({
+			id: a.name,
+			groupOrder: a.order
+		}, {
+			id: b.name,
+			groupOrder: b.order
+		}));
+	}
+	/**
+	* The summary as `gh` prints it: the first clause of the summary or
+	* description, with no trailing full stop. Built from the raw statics rather
+	* than {@link summary} so a user theme's colour codes cannot end up inside
+	* the clause; the theme is applied once the text is final.
+	*/
+	oneLineSummary(text, id) {
+		const source = (id === void 0 ? void 0 : PLUGIN_SUMMARIES[id]) ?? text ?? "";
+		const [clause = ""] = this.render(source).split(/[.:]\s|\n/, 1);
+		return ux.colorize(this.config.theme?.commandSummary, clause.trim().replace(/\.$/, ""));
+	}
+};
+//#endregion
+export { ZitadelHelp as default };
+
+//# sourceMappingURL=help.mjs.map

package/dist/lib/oclif/help.mjs.map

@@ -0,0 +1 @@
+{"version":3,"file":"help.mjs","names":[],"sources":["../../../src/lib/oclif/help.ts"],"sourcesContent":["import { type Command, Help, type Interfaces, toConfiguredId, ux } from \"@oclif/core\";\n\nimport { exploreAllCommands } from \"../journey-guidance\";\nimport { showSkillsHint } from \"../skills-hint\";\nimport { COMMAND_GROUPS, type CommandGroup, CommandGroups, compareInGroup } from \"./groups\";\n\n/** A loaded command plus the root-help statics `BaseCommand` (`./base`) declares. */\ntype GroupedCommand = Command.Loadable & { group?: CommandGroup; groupOrder?: number };\n\n/** One line of the root screen: a command, or a family of commands under one name. */\ntype Row = { name: string; summary: string; order: number };\n\n/**\n * Summaries for oclif plugin commands that ship without one. `version` prints\n * a blank line otherwise.\n */\nconst PLUGIN_SUMMARIES: Readonly<Record<string, string>> = {\n  version: \"Show the CLI version\",\n};\n\n/**\n * Root help in the style of `gh --help`: a tagline, usage, the commands under\n * headed groups, then flags and examples. A family of commands (`users`,\n * `release`) is one row, and its own help lists the operations. Only\n * {@link showRootHelp} is replaced; per-command and per-topic help\n * (`start --help`, `schemas --help`) stay oclif's own, with a pointer back to\n * the root screen added. Wired in via `oclif.helpClass` in `package.json`.\n */\nexport default class ZitadelHelp extends Help {\n  protected override async showRootHelp(): Promise<void> {\n    const { bin } = this.config;\n    const commands = this.rootCommands();\n    const groups = COMMAND_GROUPS.map(\n      (group) => [group, this.rowsOf(this.commandsOf(commands, group))] as const,\n    ).filter(([, rows]) => rows.length > 0);\n    const width = Math.max(0, ...groups.flatMap(([, rows]) => rows.map((row) => row.name.length)));\n    const list = (rows: readonly Row[]): string =>\n      rows.map((row) => `${row.name.padEnd(width)}  ${row.summary}`).join(\"\\n\");\n\n    const sections = [\n      this.render(this.config.pjson.oclif.description ?? this.config.pjson.description ?? \"\"),\n      this.section(\"Usage\", `${bin} <command> [flags]`),\n      `Run a command below. Use \\`${bin} <command> --help\\` to see its options.`,\n      ...groups.map(([group, rows]) => this.section(group, list(rows))),\n      this.section(\n        \"Flags\",\n        [\"--help      Show help for command\", `--version   Show ${bin} version`].join(\"\\n\"),\n      ),\n      this.section(\n        \"Examples\",\n        [`$ ${bin} setup --framework next`, `$ ${bin} start`, `$ ${bin} doctor`].join(\"\\n\"),\n      ),\n    ];\n    // Only a bare `zitadel`, not `zitadel --help` or an unknown command's help.\n    if (process.argv.length <= 2) {\n      await showSkillsHint({\n        env: process.env,\n        interactive: Boolean(process.stdout.isTTY && process.stdin.isTTY),\n      });\n    }\n    this.log(sections.join(\"\\n\\n\"));\n  }\n\n  override async showCommandHelp(command: Command.Loadable): Promise<void> {\n    await super.showCommandHelp(command);\n    this.log(exploreAllCommands(this.config.version));\n  }\n\n  override async showTopicHelp(topic: Interfaces.Topic): Promise<void> {\n    await super.showTopicHelp(topic);\n    this.log(exploreAllCommands(this.config.version));\n  }\n\n  /**\n   * The commands the root screen lists: every visible command, grouped or\n   * not, whatever its depth. Alias entries and `help` itself are left out.\n   */\n  private rootCommands(): GroupedCommand[] {\n    return (this.sortedCommands as GroupedCommand[]).filter(\n      (command) => command.id !== \"help\" && !command.aliases?.includes(command.id),\n    );\n  }\n\n  /**\n   * The commands a group lists. oclif's own utilities declare no group and are\n   * listed with the last one.\n   */\n  private commandsOf(commands: readonly GroupedCommand[], group: CommandGroup): GroupedCommand[] {\n    return commands.filter(\n      (command) =>\n        command.group === group ||\n        (command.group === undefined && group === CommandGroups.diagnostics),\n    );\n  }\n\n  /**\n   * The rows of one group. Commands sharing a first word (`users create`,\n   * `users get`) are one row named for it, described by the topic when it has\n   * a description and otherwise by the command of that name; a command on its\n   * own keeps its name. Rows follow `groupOrder` (the lowest of a family's\n   * commands), then the name.\n   */\n  private rowsOf(commands: readonly GroupedCommand[]): Row[] {\n    const families = new Map<string, GroupedCommand[]>();\n    for (const command of commands) {\n      const [family = command.id] = command.id.split(\":\");\n      families.set(family, [...(families.get(family) ?? []), command]);\n    }\n    const rows = [...families].map(([family, members]): Row => {\n      const order = Math.min(\n        ...members.map((member) => member.groupOrder ?? Number.MAX_SAFE_INTEGER),\n      );\n      const isFamily = members.some((member) => member.id.includes(\":\"));\n      if (!isFamily) {\n        const [only] = members;\n        return {\n          name: toConfiguredId(family, this.config),\n          summary: this.oneLineSummary(only?.summary ?? only?.description, only?.id),\n          order,\n        };\n      }\n      const topic = this.config.topics.find((candidate) => candidate.name === family);\n      const root = members.find((member) => member.id === family) ?? members[0];\n      return {\n        name: toConfiguredId(family, this.config),\n        summary: this.oneLineSummary(topic?.description ?? root?.summary ?? root?.description),\n        order,\n      };\n    });\n    return rows.sort((a, b) =>\n      compareInGroup({ id: a.name, groupOrder: a.order }, { id: b.name, groupOrder: b.order }),\n    );\n  }\n\n  /**\n   * The summary as `gh` prints it: the first clause of the summary or\n   * description, with no trailing full stop. Built from the raw statics rather\n   * than {@link summary} so a user theme's colour codes cannot end up inside\n   * the clause; the theme is applied once the text is final.\n   */\n  private oneLineSummary(text: string | undefined, id?: string): string {\n    const source = (id === undefined ? undefined : PLUGIN_SUMMARIES[id]) ?? text ?? \"\";\n    const [clause = \"\"] = this.render(source).split(/[.:]\\s|\\n/, 1);\n    return ux.colorize(this.config.theme?.commandSummary, clause.trim().replace(/\\.$/, \"\"));\n  }\n}\n"],"mappings":";;;;;;;AAgBA,MAAM,mBAAqD,EACzD,SAAS,uBACX;;;;;;;;;AAUA,IAAqB,cAArB,cAAyC,KAAK;CAC5C,MAAyB,eAA8B;EACrD,MAAM,EAAE,QAAQ,KAAK;EACrB,MAAM,WAAW,KAAK,aAAa;EACnC,MAAM,SAAS,eAAe,KAC3B,UAAU,CAAC,OAAO,KAAK,OAAO,KAAK,WAAW,UAAU,KAAK,CAAC,CAAC,CAClE,CAAC,CAAC,QAAQ,GAAG,UAAU,KAAK,SAAS,CAAC;EACtC,MAAM,QAAQ,KAAK,IAAI,GAAG,GAAG,OAAO,SAAS,GAAG,UAAU,KAAK,KAAK,QAAQ,IAAI,KAAK,MAAM,CAAC,CAAC;EAC7F,MAAM,QAAQ,SACZ,KAAK,KAAK,QAAQ,GAAG,IAAI,KAAK,OAAO,KAAK,EAAE,IAAI,IAAI,SAAS,CAAC,CAAC,KAAK,IAAI;EAE1E,MAAM,WAAW;GACf,KAAK,OAAO,KAAK,OAAO,MAAM,MAAM,eAAe,KAAK,OAAO,MAAM,eAAe,EAAE;GACtF,KAAK,QAAQ,SAAS,GAAG,IAAI,mBAAmB;GAChD,8BAA8B,IAAI;GAClC,GAAG,OAAO,KAAK,CAAC,OAAO,UAAU,KAAK,QAAQ,OAAO,KAAK,IAAI,CAAC,CAAC;GAChE,KAAK,QACH,SACA,CAAC,qCAAqC,oBAAoB,IAAI,SAAS,CAAC,CAAC,KAAK,IAAI,CACpF;GACA,KAAK,QACH,YACA;IAAC,KAAK,IAAI;IAA0B,KAAK,IAAI;IAAS,KAAK,IAAI;GAAQ,CAAC,CAAC,KAAK,IAAI,CACpF;EACF;EAEA,IAAI,QAAQ,KAAK,UAAU,GACzB,MAAM,eAAe;GACnB,KAAK,QAAQ;GACb,aAAa,QAAQ,QAAQ,OAAO,SAAS,QAAQ,MAAM,KAAK;EAClE,CAAC;EAEH,KAAK,IAAI,SAAS,KAAK,MAAM,CAAC;CAChC;CAEA,MAAe,gBAAgB,SAA0C;EACvE,MAAM,MAAM,gBAAgB,OAAO;EACnC,KAAK,IAAI,mBAAmB,KAAK,OAAO,OAAO,CAAC;CAClD;CAEA,MAAe,cAAc,OAAwC;EACnE,MAAM,MAAM,cAAc,KAAK;EAC/B,KAAK,IAAI,mBAAmB,KAAK,OAAO,OAAO,CAAC;CAClD;;;;;CAMA,eAAyC;EACvC,OAAQ,KAAK,eAAoC,QAC9C,YAAY,QAAQ,OAAO,UAAU,CAAC,QAAQ,SAAS,SAAS,QAAQ,EAAE,CAC7E;CACF;;;;;CAMA,WAAmB,UAAqC,OAAuC;EAC7F,OAAO,SAAS,QACb,YACC,QAAQ,UAAU,SACjB,QAAQ,UAAU,KAAA,KAAa,UAAU,cAAc,WAC5D;CACF;;;;;;;;CASA,OAAe,UAA4C;EACzD,MAAM,2BAAW,IAAI,IAA8B;EACnD,KAAK,MAAM,WAAW,UAAU;GAC9B,MAAM,CAAC,SAAS,QAAQ,MAAM,QAAQ,GAAG,MAAM,GAAG;GAClD,SAAS,IAAI,QAAQ,CAAC,GAAI,SAAS,IAAI,MAAM,KAAK,CAAC,GAAI,OAAO,CAAC;EACjE;EAsBA,OArBa,CAAC,GAAG,QAAQ,CAAC,CAAC,KAAK,CAAC,QAAQ,aAAkB;GACzD,MAAM,QAAQ,KAAK,IACjB,GAAG,QAAQ,KAAK,WAAW,OAAO,cAAc,OAAO,gBAAgB,CACzE;GAEA,IAAI,CADa,QAAQ,MAAM,WAAW,OAAO,GAAG,SAAS,GAAG,CACpD,GAAG;IACb,MAAM,CAAC,QAAQ;IACf,OAAO;KACL,MAAM,eAAe,QAAQ,KAAK,MAAM;KACxC,SAAS,KAAK,eAAe,MAAM,WAAW,MAAM,aAAa,MAAM,EAAE;KACzE;IACF;GACF;GACA,MAAM,QAAQ,KAAK,OAAO,OAAO,MAAM,cAAc,UAAU,SAAS,MAAM;GAC9E,MAAM,OAAO,QAAQ,MAAM,WAAW,OAAO,OAAO,MAAM,KAAK,QAAQ;GACvE,OAAO;IACL,MAAM,eAAe,QAAQ,KAAK,MAAM;IACxC,SAAS,KAAK,eAAe,OAAO,eAAe,MAAM,WAAW,MAAM,WAAW;IACrF;GACF;EACF,CACU,CAAC,CAAC,MAAM,GAAG,MACnB,eAAe;GAAE,IAAI,EAAE;GAAM,YAAY,EAAE;EAAM,GAAG;GAAE,IAAI,EAAE;GAAM,YAAY,EAAE;EAAM,CAAC,CACzF;CACF;;;;;;;CAQA,eAAuB,MAA0B,IAAqB;EACpE,MAAM,UAAU,OAAO,KAAA,IAAY,KAAA,IAAY,iBAAiB,QAAQ,QAAQ;EAChF,MAAM,CAAC,SAAS,MAAM,KAAK,OAAO,MAAM,CAAC,CAAC,MAAM,aAAa,CAAC;EAC9D,OAAO,GAAG,SAAS,KAAK,OAAO,OAAO,gBAAgB,OAAO,KAAK,CAAC,CAAC,QAAQ,OAAO,EAAE,CAAC;CACxF;AACF"}