@ankhorage/doctor 0.2.1 → 0.3.1

package/src/{ankh.provider.ts → cli/index.ts}

@@ -1,4 +1,4 @@
-import type { AnkhRuntimeCommandProvider } from '@ankhorage/ankh';
+import type { AnkhCommandHandler, AnkhRuntimeCommandProvider } from '@ankhorage/ankh';
 
 import {
   createProviderCommandDescriptors,
@@ -6,13 +6,13 @@ import {
   type DoctorCommandServices,
   runDoctorCommand,
   type RunDoctorCommandImpl,
-} from './commands.js';
+} from '../commands.js';
 import {
   DOCTOR_CAPABILITIES,
   DOCTOR_COMMAND_CATEGORY,
   DOCTOR_PACKAGE_NAME,
   DOCTOR_PACKAGE_VERSION,
-} from './packageMetadata.js';
+} from '../packageMetadata.js';
 
 export interface CreateDoctorRuntimeProviderOptions {
   readonly runCommandImpl?: RunDoctorCommandImpl;
@@ -30,10 +30,9 @@ export function createDoctorRuntimeProvider(
     version: DOCTOR_PACKAGE_VERSION,
     capabilities: [...DOCTOR_CAPABILITIES],
     commands: createProviderCommandDescriptors(),
-    handlers: DOCTOR_COMMANDS.map((command) => ({
-      path: command.path,
-      handler(request) {
-        return runCommandImpl(
+    handlers: DOCTOR_COMMANDS.map((command) => {
+      const handler: AnkhCommandHandler = (request) =>
+        runCommandImpl(
           {
             argv: request.argv,
             command,
@@ -43,8 +42,12 @@ export function createDoctorRuntimeProvider(
             services: options.services,
           },
         );
-      },
-    })),
+
+      return {
+        path: command.path,
+        handler,
+      };
+    }),
   } satisfies AnkhRuntimeCommandProvider;
 }
 

package/src/commands.ts

@@ -1,6 +1,6 @@
 import type { AnkhCapabilityId, AnkhCommandDescriptor } from '@ankhorage/contracts/cli';
 
-import type { DoctorAnalysisResult, DoctorTargetMode } from './analysis.js';
+import type { DoctorAnalysisResult, DoctorPlannedChange, DoctorTargetMode } from './analysis.js';
 import { analyzeDoctorTarget } from './analysis.js';
 import type { DoctorCommandContext, DoctorCommandRunResult } from './commandContext.js';
 import {
@@ -64,7 +64,7 @@ export const DOCTOR_COMMANDS = [
     path: ['validate'],
     capability: COMMAND_CAPABILITIES.validate,
     mode: 'validate',
-    summary: 'Auto-detect lightweight repo and package diagnostics for a local path.',
+    summary: 'Auto-detect the applicable doctor policy profile and validate a local path.',
     run: runValidateCommand,
   },
   {
@@ -72,7 +72,7 @@ export const DOCTOR_COMMANDS = [
     path: ['fix'],
     capability: COMMAND_CAPABILITIES.fix,
     mode: 'fix',
-    summary: 'Run the same lightweight checks and report that no automatic fixes exist yet.',
+    summary: 'Build a non-mutating fix plan for deterministic doctor policy violations.',
     run: runFixCommand,
   },
   {
@@ -226,7 +226,6 @@ async function runFixCommand(
   });
 
   request.context.writeStdout(renderAnalysisReport('fix', result));
-  request.context.writeStdout('No automatic fixes available.\n');
 
   return {
     exitCode: countErrorDiagnostics(result.diagnostics) > 0 ? 1 : 0,
@@ -274,6 +273,7 @@ function renderAnalysisReport(
   const lines = [
     `doctor ${commandName}`,
     `target: ${result.targetPath}`,
+    `profile: ${result.profile}`,
     `checks: ${result.appliedChecks.length > 0 ? result.appliedChecks.join(', ') : 'none'}`,
     `repoMarkers: ${result.repoMarkers.length > 0 ? result.repoMarkers.join(', ') : 'none'}`,
     '',
@@ -288,6 +288,19 @@ function renderAnalysisReport(
     }
   }
 
+  if (commandName === 'fix') {
+    lines.push('');
+    lines.push('Planned changes:');
+
+    if (result.plannedChanges.length === 0) {
+      lines.push('  none');
+    } else {
+      for (const change of result.plannedChanges) {
+        lines.push(renderPlannedChangeLine(change));
+      }
+    }
+  }
+
   const errorCount = countErrorDiagnostics(result.diagnostics);
   const warningCount = countWarningDiagnostics(result.diagnostics);
 
@@ -299,7 +312,11 @@ function renderAnalysisReport(
 }
 
 function renderDiagnosticLine(diagnostic: DoctorDiagnostic): string {
-  return `  - ${diagnostic.severity.toUpperCase()} ${diagnostic.code}: ${diagnostic.message}`;
+  return `  - ${diagnostic.severity.toUpperCase()} ${diagnostic.ruleId} (${diagnostic.code}): ${diagnostic.message}`;
+}
+
+function renderPlannedChangeLine(change: DoctorPlannedChange): string {
+  return `  - ${change.ruleId} [${change.kind}]: ${change.description}`;
 }
 
 function renderCommandFailure(commandName: DoctorCommandName, error: unknown): string {

package/src/diagnostics.ts

@@ -1,26 +1,83 @@
 export type DoctorDiagnosticCode =
+  | 'field-invalid'
+  | 'field-missing'
   | 'invalid-ankh-metadata'
   | 'invalid-package-json'
-  | 'missing-changelog'
-  | 'missing-changeset-directory'
-  | 'missing-license'
-  | 'missing-readme'
-  | 'missing-workflows-directory'
-  | 'package-json-missing'
-  | 'package-name-missing'
-  | 'package-type-missing'
-  | 'package-version-missing'
-  | 'repo-markers-missing'
+  | 'missing-dependency'
+  | 'missing-path'
+  | 'missing-script'
+  | 'provider-source-import-failed'
+  | 'provider-source-missing'
   | 'target-not-directory'
   | 'target-not-found'
   | 'unsupported-target';
 
 export type DoctorDiagnosticSeverity = 'error' | 'warning';
+export type DoctorPolicyProfile = 'integration-monorepo' | 'public-package' | 'unknown';
+export type DoctorRuleId =
+  | 'integration.package.ankh.disallowed'
+  | 'integration.package.private.required'
+  | 'integration.package.workspaces.required'
+  | 'package.ankh.capabilities.match-provider'
+  | 'package.ankh.present.valid-shape'
+  | 'package.ankh.provider-path.required'
+  | 'package.ankh.required-for-provider'
+  | 'package.dependencies.changesets.required'
+  | 'package.dependencies.devtools.required'
+  | 'package.dependencies.paradox.required'
+  | 'package.dependencies.types-bun.required'
+  | 'package.dependencies.types-node.required'
+  | 'package.dependencies.typescript.required'
+  | 'package.json.bugs.required'
+  | 'package.json.description.required'
+  | 'package.json.exports.required'
+  | 'package.json.files.required'
+  | 'package.json.homepage.required'
+  | 'package.json.keywords.required'
+  | 'package.json.license.required'
+  | 'package.json.name.required'
+  | 'package.json.package-manager.bun'
+  | 'package.json.package-manager.required'
+  | 'package.json.private.public-package-disallowed'
+  | 'package.json.publish-config.public'
+  | 'package.json.publish-config.required'
+  | 'package.json.repository.required'
+  | 'package.json.type.module'
+  | 'package.json.type.required'
+  | 'package.json.version.required'
+  | 'package.scripts.build.required'
+  | 'package.scripts.changeset-status.required'
+  | 'package.scripts.changeset.required'
+  | 'package.scripts.docs.required'
+  | 'package.scripts.format-check.required'
+  | 'package.scripts.format.required'
+  | 'package.scripts.knip.required'
+  | 'package.scripts.lint-fix.required'
+  | 'package.scripts.lint.required'
+  | 'package.scripts.test.required'
+  | 'package.scripts.typecheck.required'
+  | 'package.scripts.version-packages.required'
+  | 'provider.commands.match-capabilities'
+  | 'provider.commands.match-handlers'
+  | 'provider.source.importable'
+  | 'provider.source.required'
+  | 'repo.changelog.required'
+  | 'repo.changeset.required'
+  | 'repo.license.required'
+  | 'repo.readme.required'
+  | 'repo.workflows.required'
+  | 'target.package-json.required'
+  | 'target.path.directory'
+  | 'target.path.exists'
+  | 'target.profile.supported'
+  | 'target.repo-markers.required';
 
 export interface DoctorDiagnostic {
   readonly code: DoctorDiagnosticCode;
   readonly message: string;
   readonly path: string;
+  readonly profile: DoctorPolicyProfile;
+  readonly ruleId: DoctorRuleId;
   readonly severity: DoctorDiagnosticSeverity;
 }
 

package/src/index.ts

@@ -1,21 +1,26 @@
 export type {
   DoctorAnalysisRequest,
   DoctorAnalysisResult,
+  DoctorFixPlan,
+  DoctorPlannedChange,
+  DoctorPlannedChangeKind,
   DoctorTargetCheck,
   DoctorTargetMode,
 } from './analysis.js';
 export { analyzeDoctorTarget } from './analysis.js';
+export { runCli } from './cli.js';
 export {
   createDoctorRuntimeProvider,
   type CreateDoctorRuntimeProviderOptions,
-} from './ankh.provider.js';
-export { runCli } from './cli.js';
+} from './cli/index.js';
 export type { DoctorCommandContext, DoctorCommandRunResult } from './commandContext.js';
 export { createDefaultCommandContext } from './commandContext.js';
 export type {
   DoctorDiagnostic,
   DoctorDiagnosticCode,
   DoctorDiagnosticSeverity,
+  DoctorPolicyProfile,
+  DoctorRuleId,
 } from './diagnostics.js';
 export {
   DOCTOR_CAPABILITIES,

package/src/packageMetadata.ts

@@ -18,6 +18,6 @@ export const DOCTOR_CAPABILITIES = [
 
 export const DOCTOR_PACKAGE_METADATA = {
   category: DOCTOR_COMMAND_CATEGORY,
-  provider: './dist/ankh.provider.js',
+  provider: './dist/cli/index.js',
   capabilities: DOCTOR_CAPABILITIES,
 } as const satisfies AnkhPackageMetadata;

package/src/readme-usage.ts

@@ -17,10 +17,18 @@ import { runCli } from './cli.js';
  * - `repo`
  * - `package`
  *
- * `doctor#1` intentionally stays lightweight:
+ * `doctor#2` adds a profile-based policy engine:
  *
- * - path-aware local repo/package diagnostics are implemented now
- * - GitHub checks, CI checks, full policy enforcement, and autofix rules are deferred
+ * - strict `public-package` validation for extracted public package repos
+ * - light recognized `integration-monorepo` validation for `ankhorage4`
+ * - non-mutating `fix` plans for deterministic mechanical changes only
+ *
+ * Still deferred:
+ *
+ * - GitHub checks
+ * - CI checks
+ * - on-disk `fix --apply`
+ * - deeper cross-repo policy enforcement
  *
  * Path handling:
  *

package/dist/ankh.provider.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"ankh.provider.d.ts","sourceRoot":"","sources":["../src/ankh.provider.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,0BAA0B,EAAE,MAAM,iBAAiB,CAAC;AAElE,OAAO,EAGL,KAAK,qBAAqB,EAE1B,KAAK,oBAAoB,EAC1B,MAAM,eAAe,CAAC;AAQvB,MAAM,WAAW,kCAAkC;IACjD,QAAQ,CAAC,cAAc,CAAC,EAAE,oBAAoB,CAAC;IAC/C,QAAQ,CAAC,QAAQ,CAAC,EAAE,OAAO,CAAC,qBAAqB,CAAC,CAAC;CACpD;AAED,wBAAgB,2BAA2B,CACzC,OAAO,GAAE,kCAAuC,GAC/C,0BAA0B,CAyB5B;AAED,QAAA,MAAM,QAAQ,4BAAgC,CAAC;AAE/C,eAAe,QAAQ,CAAC"}

package/dist/ankh.provider.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"ankh.provider.js","sourceRoot":"","sources":["../src/ankh.provider.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,gCAAgC,EAChC,eAAe,EAEf,gBAAgB,GAEjB,MAAM,eAAe,CAAC;AACvB,OAAO,EACL,mBAAmB,EACnB,uBAAuB,EACvB,mBAAmB,EACnB,sBAAsB,GACvB,MAAM,sBAAsB,CAAC;AAO9B,MAAM,UAAU,2BAA2B,CACzC,UAA8C,EAAE;IAEhD,MAAM,cAAc,GAAG,OAAO,CAAC,cAAc,IAAI,gBAAgB,CAAC;IAElE,OAAO;QACL,EAAE,EAAE,mBAAmB;QACvB,QAAQ,EAAE,uBAAuB;QACjC,OAAO,EAAE,sBAAsB;QAC/B,YAAY,EAAE,CAAC,GAAG,mBAAmB,CAAC;QACtC,QAAQ,EAAE,gCAAgC,EAAE;QAC5C,QAAQ,EAAE,eAAe,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;YAC1C,IAAI,EAAE,OAAO,CAAC,IAAI;YAClB,OAAO,CAAC,OAAO;gBACb,OAAO,cAAc,CACnB;oBACE,IAAI,EAAE,OAAO,CAAC,IAAI;oBAClB,OAAO;oBACP,OAAO,EAAE,OAAO,CAAC,OAAO;iBACzB,EACD;oBACE,QAAQ,EAAE,OAAO,CAAC,QAAQ;iBAC3B,CACF,CAAC;YACJ,CAAC;SACF,CAAC,CAAC;KACiC,CAAC;AACzC,CAAC;AAED,MAAM,QAAQ,GAAG,2BAA2B,EAAE,CAAC;AAE/C,eAAe,QAAQ,CAAC","sourcesContent":["import type { AnkhRuntimeCommandProvider } from '@ankhorage/ankh';\n\nimport {\n  createProviderCommandDescriptors,\n  DOCTOR_COMMANDS,\n  type DoctorCommandServices,\n  runDoctorCommand,\n  type RunDoctorCommandImpl,\n} from './commands.js';\nimport {\n  DOCTOR_CAPABILITIES,\n  DOCTOR_COMMAND_CATEGORY,\n  DOCTOR_PACKAGE_NAME,\n  DOCTOR_PACKAGE_VERSION,\n} from './packageMetadata.js';\n\nexport interface CreateDoctorRuntimeProviderOptions {\n  readonly runCommandImpl?: RunDoctorCommandImpl;\n  readonly services?: Partial<DoctorCommandServices>;\n}\n\nexport function createDoctorRuntimeProvider(\n  options: CreateDoctorRuntimeProviderOptions = {},\n): AnkhRuntimeCommandProvider {\n  const runCommandImpl = options.runCommandImpl ?? runDoctorCommand;\n\n  return {\n    id: DOCTOR_PACKAGE_NAME,\n    category: DOCTOR_COMMAND_CATEGORY,\n    version: DOCTOR_PACKAGE_VERSION,\n    capabilities: [...DOCTOR_CAPABILITIES],\n    commands: createProviderCommandDescriptors(),\n    handlers: DOCTOR_COMMANDS.map((command) => ({\n      path: command.path,\n      handler(request) {\n        return runCommandImpl(\n          {\n            argv: request.argv,\n            command,\n            context: request.context,\n          },\n          {\n            services: options.services,\n          },\n        );\n      },\n    })),\n  } satisfies AnkhRuntimeCommandProvider;\n}\n\nconst provider = createDoctorRuntimeProvider();\n\nexport default provider;\n"]}