@shrkcrft/cli 0.1.0-alpha.2

package/dist/commands/commands.command.d.ts

@@ -0,0 +1,92 @@
+import { type CommandRegistry, type ICommandHandler } from '../command-registry.js';
+export declare function makeCommandsCommand(registry: CommandRegistry): ICommandHandler;
+export interface IRetirementPlanGroup {
+    reason: 'deprecated' | 'aliases' | 'machine-in-help' | 'overlapping' | 'missing-replacedBy' | 'legacy-no-removeAfter';
+    entries: readonly {
+        command: string;
+        replacedBy?: string;
+        preferredCommand?: string;
+        overlapsWith?: readonly string[];
+        reason?: string;
+        deprecatedSince?: string;
+    }[];
+}
+export interface IRetirementPlanReport {
+    schema: 'sharkcraft.commands-retirement-plan/v1';
+    total: number;
+    groups: readonly IRetirementPlanGroup[];
+}
+/**
+ * Build the retirement plan: groups every entry that needs lifecycle
+ * attention. Pure for testing.
+ */
+export declare function buildRetirementPlanReport(): IRetirementPlanReport;
+/** Back-compat: the simple top-level entry kept so existing tests still work. */
+export declare const commandsCommand: ICommandHandler;
+interface ICommandsDoctorIssue {
+    code: string;
+    message: string;
+    severity: 'error' | 'warning' | 'info';
+}
+export interface ICommandsDoctorReport {
+    passed: boolean;
+    issues: readonly ICommandsDoctorIssue[];
+    summary: {
+        catalogEntries: number;
+        registeredCommands: number;
+        registeredSubcommands: number;
+        errors: number;
+        warnings: number;
+    };
+}
+export interface ICommandsUxIssue {
+    code: 'missing-description' | 'missing-safety-metadata' | 'duplicate-alias' | 'unreferenced-primary' | 'short-description' | 'missing-docs-link' | 'primary-without-audience' | 'primary-without-role' | 'machine-marked-primary' | 'legacy-without-replacement' | 'overlap-without-preferred' | 'description-without-purpose' | 'too-many-primary-for-role' | 'deprecated-without-replacement' | 'alias-without-target' | 'nonstandard-verbosity-flag';
+    severity: 'info' | 'warning' | 'error';
+    message: string;
+    command: string;
+}
+export interface ICommandsUxReport {
+    schema: 'sharkcraft.commands-ux-check/v1';
+    passed: boolean;
+    issues: readonly ICommandsUxIssue[];
+    summary: {
+        catalogEntries: number;
+        primaryReferenced: number;
+        errors: number;
+        warnings: number;
+    };
+}
+export declare function buildCommandsUxReport(): ICommandsUxReport;
+/** Pure: build the doctor report. Exported for tests. */
+export declare function buildCommandsDoctorReport(registry: CommandRegistry | null): ICommandsDoctorReport;
+/**
+ * Docs drift check. Walks the canonical docs pages and verifies that
+ * every `shrk <command>` reference resolves to a non-deprecated catalog
+ * entry. Warns on (a) stale references, (b) docs promoting deprecated /
+ * retired commands, (c) `preferredCommand` / `replacedBy` pointers that
+ * don't resolve.
+ *
+ * Reasoned as warnings unless the reference is clearly structural
+ * (replacedBy → missing) — those are errors.
+ */
+export interface IDocsCheckIssue {
+    code: 'stale-doc-reference' | 'doc-promotes-deprecated' | 'replaced-by-missing' | 'preferred-command-missing';
+    severity: 'info' | 'warning' | 'error';
+    file?: string;
+    command: string;
+    message: string;
+}
+export interface IDocsCheckReport {
+    schema: 'sharkcraft.commands-docs-check/v1';
+    passed: boolean;
+    filesChecked: number;
+    issues: readonly IDocsCheckIssue[];
+    summary: {
+        errors: number;
+        warnings: number;
+        info: number;
+    };
+}
+export declare function buildDocsCheckReport(cwd?: string): Promise<IDocsCheckReport>;
+export {};
+//# sourceMappingURL=commands.command.d.ts.map

package/dist/commands/commands.command.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"commands.command.d.ts","sourceRoot":"","sources":["../../src/commands/commands.command.ts"],"names":[],"mappings":"AAAA,OAAO,EAIL,KAAK,eAAe,EACpB,KAAK,eAAe,EAErB,MAAM,wBAAwB,CAAC;AA6BhC,wBAAgB,mBAAmB,CAAC,QAAQ,EAAE,eAAe,GAAG,eAAe,CA+I9E;AAgLD,MAAM,WAAW,oBAAoB;IACnC,MAAM,EACF,YAAY,GACZ,SAAS,GACT,iBAAiB,GACjB,aAAa,GACb,oBAAoB,GACpB,uBAAuB,CAAC;IAC5B,OAAO,EAAE,SAAS;QAAE,OAAO,EAAE,MAAM,CAAC;QAAC,UAAU,CAAC,EAAE,MAAM,CAAC;QAAC,gBAAgB,CAAC,EAAE,MAAM,CAAC;QAAC,YAAY,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;QAAC,MAAM,CAAC,EAAE,MAAM,CAAC;QAAC,eAAe,CAAC,EAAE,MAAM,CAAA;KAAE,EAAE,CAAC;CACtK;AAED,MAAM,WAAW,qBAAqB;IACpC,MAAM,EAAE,wCAAwC,CAAC;IACjD,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,SAAS,oBAAoB,EAAE,CAAC;CACzC;AAED;;;GAGG;AACH,wBAAgB,yBAAyB,IAAI,qBAAqB,CAqDjE;AAsFD,iFAAiF;AACjF,eAAO,MAAM,eAAe,EAAE,eA6D7B,CAAC;AAEF,UAAU,oBAAoB;IAC5B,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,OAAO,GAAG,SAAS,GAAG,MAAM,CAAC;CACxC;AAED,MAAM,WAAW,qBAAqB;IACpC,MAAM,EAAE,OAAO,CAAC;IAChB,MAAM,EAAE,SAAS,oBAAoB,EAAE,CAAC;IACxC,OAAO,EAAE;QACP,cAAc,EAAE,MAAM,CAAC;QACvB,kBAAkB,EAAE,MAAM,CAAC;QAC3B,qBAAqB,EAAE,MAAM,CAAC;QAC9B,MAAM,EAAE,MAAM,CAAC;QACf,QAAQ,EAAE,MAAM,CAAC;KAClB,CAAC;CACH;AAED,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EACA,qBAAqB,GACrB,yBAAyB,GACzB,iBAAiB,GACjB,sBAAsB,GACtB,mBAAmB,GACnB,mBAAmB,GAEnB,0BAA0B,GAC1B,sBAAsB,GACtB,wBAAwB,GACxB,4BAA4B,GAC5B,2BAA2B,GAC3B,6BAA6B,GAC7B,2BAA2B,GAE3B,gCAAgC,GAChC,sBAAsB,GACtB,4BAA4B,CAAC;IACjC,QAAQ,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC;IACvC,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,iCAAiC,CAAC;IAC1C,MAAM,EAAE,OAAO,CAAC;IAChB,MAAM,EAAE,SAAS,gBAAgB,EAAE,CAAC;IACpC,OAAO,EAAE;QACP,cAAc,EAAE,MAAM,CAAC;QACvB,iBAAiB,EAAE,MAAM,CAAC;QAC1B,MAAM,EAAE,MAAM,CAAC;QACf,QAAQ,EAAE,MAAM,CAAC;KAClB,CAAC;CACH;AAoBD,wBAAgB,qBAAqB,IAAI,iBAAiB,CAsMzD;AAsBD,yDAAyD;AACzD,wBAAgB,yBAAyB,CACvC,QAAQ,EAAE,eAAe,GAAG,IAAI,GAC/B,qBAAqB,CA0JvB;AAuID;;;;;;;;;GASG;AACH,MAAM,WAAW,eAAe;IAC9B,IAAI,EACA,qBAAqB,GACrB,yBAAyB,GACzB,qBAAqB,GACrB,2BAA2B,CAAC;IAChC,QAAQ,EAAE,MAAM,GAAG,SAAS,GAAG,OAAO,CAAC;IACvC,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,gBAAgB;IAC/B,MAAM,EAAE,mCAAmC,CAAC;IAC5C,MAAM,EAAE,OAAO,CAAC;IAChB,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,SAAS,eAAe,EAAE,CAAC;IACnC,OAAO,EAAE;QAAE,MAAM,EAAE,MAAM,CAAC;QAAC,QAAQ,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;CAC7D;AAQD,wBAAsB,oBAAoB,CAAC,GAAG,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC,gBAAgB,CAAC,CA+ElF"}