@h-rig/standard-plugin 0.0.6-alpha.136 → 0.0.6-alpha.138

package/dist/src/drift/plugin.d.ts

@@ -1,5 +1,5 @@
 import { type DriftFinding, type DriftReport, type StageMutation, type StageResult, type StageRun, type ValidatorRegistration } from "@rig/contracts";
-import type { RegisteredValidator, ValidatorResult } from "@rig/core";
+import type { RegisteredValidator, RuntimeCliCommand, RuntimeCliContext, ValidatorResult } from "@rig/core";
 import { type DriftDetectOptions } from "./detect";
 export interface DocsDriftPluginOptions {
     readonly docsGlobs?: readonly string[];
@@ -9,9 +9,10 @@ export interface DocsDriftPluginOptions {
 export declare const DOCS_DRIFT_VALIDATOR_ID = "std:docs-drift";
 export declare const DOCS_DRIFT_CLI_ID = "std:drift";
 export declare const DOCS_DRIFT_STAGE_ID = "docs-drift";
+export declare const DOCS_DRIFT_CAPABILITY_ID = "std:docs-drift-capability";
 export declare const DOCS_DRIFT_VALIDATOR: ValidatorRegistration;
 export declare const DOCS_DRIFT_STAGE_MUTATION: StageMutation;
-export declare const DOCS_DRIFT_CLI_COMMAND = "bun -e 'import { runDriftCli } from \"@rig/standard-plugin/drift\"; process.exitCode = await runDriftCli(process.argv.slice(1), { projectRoot: process.cwd() });' --";
+export declare const DOCS_DRIFT_CLI_COMMAND = "rig drift [--docs <csv>] [--ignore <csv>] [--fail-on-drift] [--json]";
 export declare function highConfidenceDriftFindings(report: DriftReport): readonly DriftFinding[];
 export declare function driftGateResult(report: DriftReport, mode?: "observe" | "enforce"): StageResult;
 /**
@@ -30,4 +31,33 @@ export interface RunDriftCliOptions {
     readonly write?: (message: string) => void;
     readonly writeError?: (message: string) => void;
 }
+export declare function executeDrift(context: RuntimeCliContext, args: readonly string[], options?: DocsDriftPluginOptions): Promise<{
+    ok: boolean;
+    group: string;
+    command: string;
+    details: {
+        report: {
+            readonly degraded: boolean;
+            readonly generatedAt: string;
+            readonly findings: readonly {
+                readonly kind: "deleted-reference" | "stale-anchor" | "semantic-mismatch" | "issue-mismatch";
+                readonly detail: string;
+                readonly line: number | null;
+                readonly reference: string | null;
+                readonly docPath: string;
+                readonly confidence: "high" | "medium" | "low";
+            }[];
+            readonly scanned: number;
+        };
+        summary: {
+            total: number;
+            highConfidence: number;
+            degraded: boolean;
+        };
+        failOnDrift: boolean;
+        failed: boolean;
+    };
+}>;
+export declare function createDocsDriftRuntimeCliCommand(options?: DocsDriftPluginOptions): RuntimeCliCommand;
+export declare const DOCS_DRIFT_RUNTIME_CLI_COMMAND: RuntimeCliCommand;
 export declare function runDriftCli(args: readonly string[], options?: RunDriftCliOptions): Promise<number>;

package/dist/src/drift/plugin.js

@@ -301,6 +301,7 @@ async function detectDrift(options) {
 var DOCS_DRIFT_VALIDATOR_ID = "std:docs-drift";
 var DOCS_DRIFT_CLI_ID = "std:drift";
 var DOCS_DRIFT_STAGE_ID = "docs-drift";
+var DOCS_DRIFT_CAPABILITY_ID = "std:docs-drift-capability";
 var DOCS_DRIFT_VALIDATOR = {
   id: DOCS_DRIFT_VALIDATOR_ID,
   category: "regression",
@@ -316,7 +317,7 @@ var DOCS_DRIFT_STAGE_MUTATION = Schema.decodeUnknownSync(StageMutationSchema)({
   },
   contributedBy: DOCS_DRIFT_STAGE_ID
 });
-var DOCS_DRIFT_CLI_COMMAND = `bun -e 'import { runDriftCli } from "@rig/standard-plugin/drift"; process.exitCode = await runDriftCli(process.argv.slice(1), { projectRoot: process.cwd() });' --`;
+var DOCS_DRIFT_CLI_COMMAND = "rig drift [--docs <csv>] [--ignore <csv>] [--fail-on-drift] [--json]";
 function highConfidenceDriftFindings(report) {
   return report.findings.filter((finding) => finding.confidence === "high");
 }
@@ -369,6 +370,76 @@ function takeOptionValue(args, index, flag) {
     throw new Error(`${flag} requires a value`);
   return value;
 }
+function takeFlag(args, flag) {
+  const rest = [...args];
+  const index = rest.indexOf(flag);
+  if (index < 0)
+    return { value: false, rest };
+  rest.splice(index, 1);
+  return { value: true, rest };
+}
+function takeOption(args, flag) {
+  const rest = [...args];
+  const index = rest.indexOf(flag);
+  if (index < 0)
+    return { rest };
+  const value = rest[index + 1];
+  if (!value || value.startsWith("-"))
+    throw new Error(`${flag} requires a value.`);
+  rest.splice(index, 2);
+  return { value, rest };
+}
+function requireNoExtraArgs(args, usage) {
+  if (args.length > 0)
+    throw new Error(`Unexpected argument: ${args[0]}
+Usage: ${usage}`);
+}
+function parseCsv(value) {
+  return value?.split(",").map((entry) => entry.trim()).filter((entry) => entry.length > 0) ?? [];
+}
+function driftSummary(report) {
+  const highConfidence = highConfidenceDriftFindings(report).length;
+  return { total: report.findings.length, highConfidence, degraded: report.degraded };
+}
+async function executeDrift(context, args, options = {}) {
+  const json = takeFlag(args, "--json");
+  const docs = takeOption(json.rest, "--docs");
+  const ignore = takeOption(docs.rest, "--ignore");
+  const failOnDrift = takeFlag(ignore.rest, "--fail-on-drift");
+  requireNoExtraArgs(failOnDrift.rest, "rig drift [--docs <csv>] [--ignore <csv>] [--fail-on-drift] [--json]");
+  const docsGlobs = parseCsv(docs.value);
+  const ignoreGlobs = parseCsv(ignore.value);
+  const effectiveDocsGlobs = docsGlobs.length > 0 ? docsGlobs : options.docsGlobs;
+  const effectiveIgnoreGlobs = ignoreGlobs.length > 0 ? ignoreGlobs : options.ignoreGlobs;
+  const effectiveFailOnDrift = failOnDrift.value || options.failOnDrift === true;
+  const report = await detectDrift({
+    projectRoot: context.projectRoot,
+    ...effectiveDocsGlobs !== undefined ? { docsGlobs: effectiveDocsGlobs } : {},
+    ...effectiveIgnoreGlobs !== undefined ? { ignoreGlobs: effectiveIgnoreGlobs } : {}
+  });
+  const failed = effectiveFailOnDrift && highConfidenceDriftFindings(report).length > 0;
+  const details = { report, summary: driftSummary(report), failOnDrift: effectiveFailOnDrift, failed };
+  if (context.outputMode === "text") {
+    if (json.value)
+      console.log(JSON.stringify(details, null, 2));
+    else
+      console.log(report.findings.length === 0 ? `No drift findings across ${report.scanned} documents.` : report.findings.map((finding) => `${finding.docPath}:${finding.line ?? "?"}	${finding.kind}	${finding.confidence}	${finding.detail}`).join(`
+`));
+  }
+  return { ok: !failed, group: "drift", command: "scan", details };
+}
+function createDocsDriftRuntimeCliCommand(options = {}) {
+  return {
+    id: DOCS_DRIFT_CLI_ID,
+    family: "drift",
+    command: DOCS_DRIFT_CLI_COMMAND,
+    description: "Scan documentation for stale code references.",
+    usage: DOCS_DRIFT_CLI_COMMAND,
+    projectRequired: true,
+    run: (context, args) => executeDrift(context, args, options)
+  };
+}
+var DOCS_DRIFT_RUNTIME_CLI_COMMAND = createDocsDriftRuntimeCliCommand();
 async function runDriftCli(args, options = {}) {
   const docsGlobs = [];
   const ignoreGlobs = [];
@@ -421,13 +492,17 @@ export {
   runDriftCli,
   runDocsDriftValidation,
   highConfidenceDriftFindings,
+  executeDrift,
   driftGateResult,
   createDocsDriftValidator,
+  createDocsDriftRuntimeCliCommand,
   createDocsDriftGateStage,
   DOCS_DRIFT_VALIDATOR_ID,
   DOCS_DRIFT_VALIDATOR,
   DOCS_DRIFT_STAGE_MUTATION,
   DOCS_DRIFT_STAGE_ID,
+  DOCS_DRIFT_RUNTIME_CLI_COMMAND,
   DOCS_DRIFT_CLI_ID,
-  DOCS_DRIFT_CLI_COMMAND
+  DOCS_DRIFT_CLI_COMMAND,
+  DOCS_DRIFT_CAPABILITY_ID
 };

package/dist/src/index.d.ts

@@ -1,25 +1,3 @@
-import { type RigPluginWithRuntime } from "@rig/core";
-import { createEnvGitHubCredentialProvider, createStateGitHubCredentialProvider, createGitHubIssuesTaskSource, type GitHubCredentialProvider, type GitHubIssuesOptions } from "./github-issues-source";
-import { createFilesTaskSource } from "./files-source";
-import { type DocsDriftPluginOptions } from "./drift/plugin";
-export { createGitHubIssuesTaskSource, createEnvGitHubCredentialProvider, createStateGitHubCredentialProvider, createFilesTaskSource };
-export { createDocsDriftValidator, DOCS_DRIFT_CLI_ID, DOCS_DRIFT_STAGE_ID, DOCS_DRIFT_VALIDATOR_ID, driftGateResult, runDocsDriftValidation, runDriftCli } from "./drift/plugin";
-export { detectDrift, detectDeletedReferences, detectStaleAnchors } from "./drift/detect";
-export { extractDriftReferences } from "./drift/extract-refs";
-export { makeDriftGit } from "./drift/git-adapter";
-export { judgeDocumentationDrift } from "./drift/judge";
-export type { DriftReference, DriftReferenceKind } from "./drift/extract-refs";
-export type { DriftGit } from "./drift/git-adapter";
-export type { DriftJudgeInput, DriftJudgeMismatch, DriftJudgeProvider } from "./drift/judge";
-export type { GitHubIssuesOptions } from "./github-issues-source";
-export type { FilesTaskSourceOptions } from "./files-source";
-export type { DocsDriftPluginOptions } from "./drift/plugin";
-export interface StandardPluginOptions {
-    githubCredentialProvider?: GitHubCredentialProvider;
-    githubWorkspaceId?: string;
-    githubUserId?: string;
-    githubSpawn?: GitHubIssuesOptions["spawn"];
-    onGitHubTaskChanged?: GitHubIssuesOptions["onTaskChanged"];
-    drift?: DocsDriftPluginOptions;
-}
-export default function standardPlugin(opts?: StandardPluginOptions): RigPluginWithRuntime;
+export * from "./plugin";
+export { default } from "./plugin";
+export { standardProjectPlugins, type StandardProjectPluginsOptions } from "./bundle";

package/dist/src/index.js

@@ -1,5 +1,5 @@
 // @bun
-// packages/standard-plugin/src/index.ts
+// packages/standard-plugin/src/plugin.ts
 import { resolve as resolve4 } from "path";
 import { definePlugin } from "@rig/core";
 
@@ -1283,6 +1283,7 @@ async function detectDrift(options) {
 var DOCS_DRIFT_VALIDATOR_ID = "std:docs-drift";
 var DOCS_DRIFT_CLI_ID = "std:drift";
 var DOCS_DRIFT_STAGE_ID = "docs-drift";
+var DOCS_DRIFT_CAPABILITY_ID = "std:docs-drift-capability";
 var DOCS_DRIFT_VALIDATOR = {
   id: DOCS_DRIFT_VALIDATOR_ID,
   category: "regression",
@@ -1298,7 +1299,7 @@ var DOCS_DRIFT_STAGE_MUTATION = Schema.decodeUnknownSync(StageMutationSchema)({
   },
   contributedBy: DOCS_DRIFT_STAGE_ID
 });
-var DOCS_DRIFT_CLI_COMMAND = `bun -e 'import { runDriftCli } from "@rig/standard-plugin/drift"; process.exitCode = await runDriftCli(process.argv.slice(1), { projectRoot: process.cwd() });' --`;
+var DOCS_DRIFT_CLI_COMMAND = "rig drift [--docs <csv>] [--ignore <csv>] [--fail-on-drift] [--json]";
 function highConfidenceDriftFindings(report) {
   return report.findings.filter((finding) => finding.confidence === "high");
 }
@@ -1351,6 +1352,76 @@ function takeOptionValue(args, index, flag) {
     throw new Error(`${flag} requires a value`);
   return value;
 }
+function takeFlag(args, flag) {
+  const rest = [...args];
+  const index = rest.indexOf(flag);
+  if (index < 0)
+    return { value: false, rest };
+  rest.splice(index, 1);
+  return { value: true, rest };
+}
+function takeOption(args, flag) {
+  const rest = [...args];
+  const index = rest.indexOf(flag);
+  if (index < 0)
+    return { rest };
+  const value = rest[index + 1];
+  if (!value || value.startsWith("-"))
+    throw new Error(`${flag} requires a value.`);
+  rest.splice(index, 2);
+  return { value, rest };
+}
+function requireNoExtraArgs(args, usage) {
+  if (args.length > 0)
+    throw new Error(`Unexpected argument: ${args[0]}
+Usage: ${usage}`);
+}
+function parseCsv(value) {
+  return value?.split(",").map((entry) => entry.trim()).filter((entry) => entry.length > 0) ?? [];
+}
+function driftSummary(report) {
+  const highConfidence = highConfidenceDriftFindings(report).length;
+  return { total: report.findings.length, highConfidence, degraded: report.degraded };
+}
+async function executeDrift(context, args, options = {}) {
+  const json = takeFlag(args, "--json");
+  const docs = takeOption(json.rest, "--docs");
+  const ignore = takeOption(docs.rest, "--ignore");
+  const failOnDrift = takeFlag(ignore.rest, "--fail-on-drift");
+  requireNoExtraArgs(failOnDrift.rest, "rig drift [--docs <csv>] [--ignore <csv>] [--fail-on-drift] [--json]");
+  const docsGlobs = parseCsv(docs.value);
+  const ignoreGlobs = parseCsv(ignore.value);
+  const effectiveDocsGlobs = docsGlobs.length > 0 ? docsGlobs : options.docsGlobs;
+  const effectiveIgnoreGlobs = ignoreGlobs.length > 0 ? ignoreGlobs : options.ignoreGlobs;
+  const effectiveFailOnDrift = failOnDrift.value || options.failOnDrift === true;
+  const report = await detectDrift({
+    projectRoot: context.projectRoot,
+    ...effectiveDocsGlobs !== undefined ? { docsGlobs: effectiveDocsGlobs } : {},
+    ...effectiveIgnoreGlobs !== undefined ? { ignoreGlobs: effectiveIgnoreGlobs } : {}
+  });
+  const failed = effectiveFailOnDrift && highConfidenceDriftFindings(report).length > 0;
+  const details = { report, summary: driftSummary(report), failOnDrift: effectiveFailOnDrift, failed };
+  if (context.outputMode === "text") {
+    if (json.value)
+      console.log(JSON.stringify(details, null, 2));
+    else
+      console.log(report.findings.length === 0 ? `No drift findings across ${report.scanned} documents.` : report.findings.map((finding) => `${finding.docPath}:${finding.line ?? "?"}	${finding.kind}	${finding.confidence}	${finding.detail}`).join(`
+`));
+  }
+  return { ok: !failed, group: "drift", command: "scan", details };
+}
+function createDocsDriftRuntimeCliCommand(options = {}) {
+  return {
+    id: DOCS_DRIFT_CLI_ID,
+    family: "drift",
+    command: DOCS_DRIFT_CLI_COMMAND,
+    description: "Scan documentation for stale code references.",
+    usage: DOCS_DRIFT_CLI_COMMAND,
+    projectRequired: true,
+    run: (context, args) => executeDrift(context, args, options)
+  };
+}
+var DOCS_DRIFT_RUNTIME_CLI_COMMAND = createDocsDriftRuntimeCliCommand();
 async function runDriftCli(args, options = {}) {
   const docsGlobs = [];
   const ignoreGlobs = [];
@@ -1411,7 +1482,8 @@ async function judgeDocumentationDrift(provider, input) {
     confidence: mismatch.confidence ?? "medium"
   }));
 }
-// packages/standard-plugin/src/index.ts
+// packages/standard-plugin/src/plugin.ts
+var DOCS_HEALTH_PANEL_ID = "docs-health";
 function requireStringField(config, field, kind) {
   const value = config[field];
   if (!value) {
@@ -1456,6 +1528,35 @@ function githubProjectsOptionsFromConfig(config, context) {
 function booleanOption(value) {
   return typeof value === "boolean" ? value : undefined;
 }
+function panelProjectRoot(context) {
+  return isRecord(context) && typeof context.projectRoot === "string" && context.projectRoot.length > 0 ? context.projectRoot : null;
+}
+function driftFindingPanelId(finding, index) {
+  return `${finding.docPath}:${finding.line ?? index}:${finding.kind}`;
+}
+function createDocsHealthPanelProducer(options = {}) {
+  return async (context) => {
+    const projectRoot = panelProjectRoot(context);
+    if (!projectRoot)
+      return;
+    const report = await detectDrift({
+      projectRoot,
+      ...options.docsGlobs !== undefined ? { docsGlobs: options.docsGlobs } : {},
+      ...options.ignoreGlobs !== undefined ? { ignoreGlobs: options.ignoreGlobs } : {}
+    });
+    return {
+      findings: report.findings.map((finding, index) => ({
+        id: driftFindingPanelId(finding, index),
+        docPath: finding.docPath,
+        kind: finding.kind,
+        confidence: finding.confidence,
+        summary: finding.detail,
+        taskId: null
+      })),
+      degraded: report.degraded ? "drift scan degraded" : null
+    };
+  };
+}
 function standardPlugin(opts = {}) {
   return definePlugin({
     name: "rig-standard",
@@ -1474,11 +1575,19 @@ function standardPlugin(opts = {}) {
           description: "JSON files in a local directory"
         }
       ],
+      capabilities: [
+        { id: DOCS_DRIFT_CAPABILITY_ID, title: "Documentation drift detection", commandId: DOCS_DRIFT_CLI_ID, panelId: DOCS_HEALTH_PANEL_ID }
+      ],
+      panels: [
+        { id: DOCS_HEALTH_PANEL_ID, slot: "capability", title: "Documentation drift", capabilityId: DOCS_DRIFT_CAPABILITY_ID }
+      ],
       cliCommands: [
         {
           id: DOCS_DRIFT_CLI_ID,
+          family: "drift",
           command: DOCS_DRIFT_CLI_COMMAND,
-          description: "Scan documentation for stale code references."
+          description: "Scan documentation for stale code references.",
+          projectRequired: true
         }
       ],
       stageMutations: [DOCS_DRIFT_STAGE_MUTATION]
@@ -1486,6 +1595,13 @@ function standardPlugin(opts = {}) {
   }, {
     validators: [createDocsDriftValidator(opts.drift)],
     stages: { [DOCS_DRIFT_STAGE_ID]: createDocsDriftGateStage(opts.drift) },
+    featureCapabilities: [
+      { id: DOCS_DRIFT_CAPABILITY_ID, title: "Documentation drift detection", commandId: DOCS_DRIFT_CLI_ID, panelId: DOCS_HEALTH_PANEL_ID }
+    ],
+    panels: [
+      { id: DOCS_HEALTH_PANEL_ID, slot: "capability", title: "Documentation drift", capabilityId: DOCS_DRIFT_CAPABILITY_ID, produce: createDocsHealthPanelProducer(opts.drift) }
+    ],
+    cliCommands: [createDocsDriftRuntimeCliCommand(opts.drift)],
     taskSources: [
       {
         id: "std:github-issues",
@@ -1542,12 +1658,30 @@ function standardPlugin(opts = {}) {
     ]
   });
 }
+// packages/standard-plugin/src/bundle.ts
+import { createBlockerClassifierPlugin } from "@rig/blocker-classifier-plugin";
+import { createDefaultLifecyclePlugin } from "@rig/bundle-default-lifecycle";
+import { createDependencyGraphPlugin } from "@rig/dependency-graph-plugin";
+import { createPlanningPlugin } from "@rig/planning-plugin";
+import { createSupervisorPlugin } from "@rig/supervisor-plugin";
+function standardProjectPlugins(options = {}) {
+  return [
+    createDefaultLifecyclePlugin(),
+    createDependencyGraphPlugin(),
+    createBlockerClassifierPlugin(),
+    createPlanningPlugin(),
+    createSupervisorPlugin(),
+    standardPlugin(options.standard)
+  ];
+}
 export {
+  standardProjectPlugins,
   runDriftCli,
   runDocsDriftValidation,
   makeDriftGit,
   judgeDocumentationDrift,
   extractDriftReferences,
+  executeDrift,
   driftGateResult,
   detectStaleAnchors,
   detectDrift,
@@ -1558,7 +1692,11 @@ export {
   createFilesTaskSource,
   createEnvGitHubCredentialProvider,
   createDocsDriftValidator,
+  createDocsDriftRuntimeCliCommand,
+  DOCS_HEALTH_PANEL_ID,
   DOCS_DRIFT_VALIDATOR_ID,
   DOCS_DRIFT_STAGE_ID,
-  DOCS_DRIFT_CLI_ID
+  DOCS_DRIFT_RUNTIME_CLI_COMMAND,
+  DOCS_DRIFT_CLI_ID,
+  DOCS_DRIFT_CAPABILITY_ID
 };

package/dist/src/plugin.d.ts

@@ -0,0 +1,26 @@
+import { type RigPluginWithRuntime } from "@rig/core";
+import { createEnvGitHubCredentialProvider, createStateGitHubCredentialProvider, createGitHubIssuesTaskSource, type GitHubCredentialProvider, type GitHubIssuesOptions } from "./github-issues-source";
+import { createFilesTaskSource } from "./files-source";
+import { type DocsDriftPluginOptions } from "./drift/plugin";
+export { createGitHubIssuesTaskSource, createEnvGitHubCredentialProvider, createStateGitHubCredentialProvider, createFilesTaskSource };
+export { createDocsDriftRuntimeCliCommand, createDocsDriftValidator, DOCS_DRIFT_CAPABILITY_ID, DOCS_DRIFT_CLI_ID, DOCS_DRIFT_RUNTIME_CLI_COMMAND, DOCS_DRIFT_STAGE_ID, DOCS_DRIFT_VALIDATOR_ID, driftGateResult, executeDrift, runDocsDriftValidation, runDriftCli } from "./drift/plugin";
+export { detectDrift, detectDeletedReferences, detectStaleAnchors } from "./drift/detect";
+export { extractDriftReferences } from "./drift/extract-refs";
+export { makeDriftGit } from "./drift/git-adapter";
+export { judgeDocumentationDrift } from "./drift/judge";
+export type { DriftReference, DriftReferenceKind } from "./drift/extract-refs";
+export type { DriftGit } from "./drift/git-adapter";
+export type { DriftJudgeInput, DriftJudgeMismatch, DriftJudgeProvider } from "./drift/judge";
+export type { GitHubIssuesOptions } from "./github-issues-source";
+export type { FilesTaskSourceOptions } from "./files-source";
+export type { DocsDriftPluginOptions } from "./drift/plugin";
+export declare const DOCS_HEALTH_PANEL_ID = "docs-health";
+export interface StandardPluginOptions {
+    githubCredentialProvider?: GitHubCredentialProvider;
+    githubWorkspaceId?: string;
+    githubUserId?: string;
+    githubSpawn?: GitHubIssuesOptions["spawn"];
+    onGitHubTaskChanged?: GitHubIssuesOptions["onTaskChanged"];
+    drift?: DocsDriftPluginOptions;
+}
+export default function standardPlugin(opts?: StandardPluginOptions): RigPluginWithRuntime;