@ontrails/trails 1.0.0-beta.4 → 1.0.0-beta.42

package/src/trails/warden-guide.ts

@@ -0,0 +1,134 @@
+import type { FieldOverride } from '@ontrails/core';
+import { Result, trail } from '@ontrails/core';
+import {
+  buildWardenGuideManifest,
+  formatWardenGuide,
+  wardenDepthValues,
+  wardenFixClasses,
+  wardenFixSafeties,
+  wardenGuideFormatValues,
+  wardenRuleConcerns,
+  wardenRuleLifecycleStates,
+  wardenRuleScopes,
+  wardenRuleTiers,
+} from '@ontrails/warden';
+import { z } from 'zod';
+
+const wardenGuidanceLinkSchema = z.object({
+  label: z.string(),
+  path: z.string().optional(),
+  url: z.string().optional(),
+});
+
+const wardenGuidanceSchema = z.object({
+  commands: z.array(z.string()).readonly().optional(),
+  docs: z.array(wardenGuidanceLinkSchema).readonly().optional(),
+  relatedRules: z.array(z.string()).readonly().optional(),
+  steps: z.array(z.string()).readonly().optional(),
+  summary: z.string(),
+});
+
+const wardenRuleGuideEntrySchema = z.object({
+  concern: z.enum(wardenRuleConcerns),
+  depth: z.enum(wardenDepthValues),
+  description: z.string(),
+  docs: z.array(wardenGuidanceLinkSchema).readonly(),
+  fix: z
+    .object({
+      class: z.enum(wardenFixClasses),
+      safety: z.enum(wardenFixSafeties),
+      scanTargets: z
+        .object({
+          exclude: z.array(z.string()).readonly().optional(),
+          extensions: z.array(z.string()).readonly().optional(),
+        })
+        .optional(),
+    })
+    .optional(),
+  guidance: wardenGuidanceSchema.optional(),
+  id: z.string(),
+  invariant: z.string(),
+  lifecycle: z.object({
+    retireWhen: z.string().optional(),
+    state: z.enum(wardenRuleLifecycleStates),
+  }),
+  scope: z.enum(wardenRuleScopes),
+  severity: z.enum(['error', 'warn']),
+  tier: z.enum(wardenRuleTiers),
+});
+
+const wardenGuideManifestSchema = z.object({
+  generatedFrom: z.object({
+    package: z.literal('@ontrails/warden'),
+    registries: z
+      .tuple([z.literal('wardenRules'), z.literal('wardenTopoRules')])
+      .readonly(),
+    source: z.literal('builtin-rule-metadata'),
+  }),
+  kind: z.literal('trails-warden-guide-manifest'),
+  ruleCount: z.number(),
+  rules: z.array(wardenRuleGuideEntrySchema).readonly(),
+  version: z.literal(1),
+});
+
+const wardenGuideInputSchema = z.object({
+  guideFormat: z
+    .enum(wardenGuideFormatValues)
+    .default('markdown')
+    .describe('Guide output format'),
+});
+
+const wardenGuideFields = {
+  guideFormat: {
+    aliases: true,
+    options: [
+      {
+        hint: 'Human-readable Warden guide',
+        label: 'Markdown',
+        value: 'markdown',
+      },
+      {
+        hint: 'Compact guidance for agent context',
+        label: 'Agent JSON',
+        value: 'agent-json',
+      },
+      {
+        hint: 'Full structured rule manifest',
+        label: 'Manifest',
+        value: 'manifest',
+      },
+    ],
+  },
+} satisfies Readonly<
+  Record<'guideFormat', FieldOverride & { readonly aliases: true }>
+>;
+
+export const wardenGuideTrail = trail('warden.guide', {
+  description: 'Project Warden rule guidance as markdown or JSON',
+  examples: [
+    {
+      input: { guideFormat: 'markdown' },
+      name: 'Markdown guide',
+    },
+    {
+      input: { guideFormat: 'agent-json' },
+      name: 'Agent JSON guide',
+    },
+  ],
+  fields: wardenGuideFields,
+  implementation: (input) => {
+    const manifest = buildWardenGuideManifest();
+    return Result.ok({
+      format: input.guideFormat,
+      formatted: formatWardenGuide(manifest, input.guideFormat),
+      manifest,
+    });
+  },
+  input: wardenGuideInputSchema,
+  intent: 'read',
+  output: z.object({
+    format: z.enum(wardenGuideFormatValues),
+    formatted: z.string(),
+    manifest: wardenGuideManifestSchema,
+  }),
+});

package/src/trails/warden.ts

@@ -1,104 +1,244 @@
 /**
  * `warden` trail -- Governance checks.
  *
- * Thin wrapper around `runWarden` and `formatWardenReport` from @ontrails/warden.
+ * Thin wrapper around the shared @ontrails/warden command surface.
  */
 
 import { Result, trail } from '@ontrails/core';
 import {
-  formatGitHubAnnotations,
-  formatJson,
-  formatSummary,
-  formatWardenReport,
-  runWarden,
+  diagnosticSchema,
+  runWardenCommand,
+  wardenDepthValues,
+  wardenDraftsValues,
+  wardenFailOnValues,
+  wardenFormatValues,
+  wardenLockValues,
 } from '@ontrails/warden';
 import { z } from 'zod';
 
-import { loadApp } from './load-app.js';
+import {
+  createIsolatedExampleRoot,
+  writeIsolatedExampleTextFile,
+} from '../local-state-io.js';
+
+import { resolveTrailRootDir } from './root-dir.js';
 
 // ---------------------------------------------------------------------------
 // Trail definition
 // ---------------------------------------------------------------------------
 
+const wardenInputSchema = z.object({
+  adapterCheck: z
+    .boolean()
+    .default(false)
+    .describe('Run shared adapter authoring checks'),
+  apps: z
+    .array(z.string())
+    .optional()
+    .describe('App names or module paths to govern'),
+  cached: z.boolean().default(false).describe('Alias for --lock cached'),
+  ci: z.boolean().default(false).describe('Use the CI Warden preset'),
+  configPath: z.string().optional().describe('Path to trails.config.ts'),
+  depth: z
+    .enum(wardenDepthValues)
+    .optional()
+    .describe('Cumulative analysis depth'),
+  drafts: z.enum(wardenDraftsValues).optional().describe('Draft state mode'),
+  excludeDrafts: z
+    .boolean()
+    .default(false)
+    .describe('Alias for --drafts exclude'),
+  failOn: z.enum(wardenFailOnValues).optional().describe('Failure threshold'),
+  fix: z.boolean().default(false).describe('Apply safe source fixes'),
+  format: z.enum(wardenFormatValues).optional().describe('Output format'),
+  github: z.boolean().default(false).describe('Alias for --format github'),
+  includeDrafts: z
+    .boolean()
+    .default(false)
+    .describe('Alias for --drafts include'),
+  json: z.boolean().default(false).describe('Alias for --format json'),
+  lock: z.enum(wardenLockValues).optional().describe('Lockfile mode'),
+  noLockMutation: z
+    .boolean()
+    .default(false)
+    .describe('Suppress lockfile mutation'),
+  onlyDrafts: z.boolean().default(false).describe('Alias for --drafts only'),
+  prePush: z.boolean().default(false).describe('Use the pre-push preset'),
+  refresh: z.boolean().default(false).describe('Alias for --lock refresh'),
+  rootDir: z.string().optional().describe('Root directory to scan'),
+  scopeExclude: z
+    .array(z.string())
+    .optional()
+    .describe('Root-relative path globs that Warden should not govern'),
+  skipLock: z.boolean().default(false).describe('Alias for --lock skip'),
+  strict: z.boolean().default(false).describe('Alias for --fail-on warning'),
+  summary: z.boolean().default(false).describe('Alias for --format summary'),
+});
+
+type WardenTrailInput = z.infer<typeof wardenInputSchema>;
+
+const createIsolatedWardenExampleRoot = (name: string): string => {
+  const rootDir = createIsolatedExampleRoot(
+    `warden-${name}-${Date.now().toString(36)}-${Math.random().toString(36).slice(2)}`
+  );
+  writeIsolatedExampleTextFile(rootDir, 'src/clean.ts', 'export {};\n');
+  return rootDir;
+};
+
+const pushFlag = (args: string[], condition: boolean, flag: string): void => {
+  if (condition) {
+    args.push(flag);
+  }
+};
+
+const pushValue = (
+  args: string[],
+  flag: string,
+  value: string | undefined
+): void => {
+  if (value !== undefined) {
+    args.push(flag, value);
+  }
+};
+
+const pushApps = (
+  args: string[],
+  apps: readonly string[] | undefined
+): void => {
+  if (apps !== undefined && apps.length > 0) {
+    args.push('--apps', apps.join(','));
+  }
+};
+
+const pushRepeatedValues = (
+  args: string[],
+  flag: string,
+  values: readonly string[] | undefined
+): void => {
+  for (const value of values ?? []) {
+    args.push(flag, value);
+  }
+};
+
+export const buildWardenCommandArgs = (
+  input: WardenTrailInput
+): readonly string[] => {
+  const args: string[] = [];
+
+  pushFlag(args, input.prePush, '--pre-push');
+  pushFlag(args, input.ci, '--ci');
+  pushValue(args, '--depth', input.depth);
+  if (input.strict) {
+    args.push('--strict');
+  } else {
+    pushValue(args, '--fail-on', input.failOn);
+  }
+  if (input.github) {
+    args.push('--github');
+  } else if (input.json) {
+    args.push('--json');
+  } else if (input.summary) {
+    args.push('--summary');
+  } else {
+    pushValue(args, '--format', input.format);
+  }
+  if (input.skipLock) {
+    args.push('--skip-lock');
+  } else if (input.refresh) {
+    args.push('--refresh');
+  } else if (input.cached) {
+    args.push('--cached');
+  } else {
+    pushValue(args, '--lock', input.lock);
+  }
+  if (input.onlyDrafts) {
+    args.push('--only-drafts');
+  } else if (input.excludeDrafts) {
+    args.push('--exclude-drafts');
+  } else if (input.includeDrafts) {
+    args.push('--include-drafts');
+  } else {
+    pushValue(args, '--drafts', input.drafts);
+  }
+  pushFlag(args, input.noLockMutation, '--no-lock-mutation');
+  pushFlag(args, input.fix, '--fix');
+  pushFlag(args, input.adapterCheck, '--adapter-check');
+  pushValue(args, '--config-path', input.configPath);
+  pushRepeatedValues(args, '--scope-exclude', input.scopeExclude);
+  pushApps(args, input.apps);
+
+  return args;
+};
+
 export const wardenTrail = trail('warden', {
   description: 'Run governance checks (lint + drift)',
   examples: [
     {
       input: {
-        driftOnly: false,
-        lintOnly: false,
+        depth: 'source',
+        lock: 'skip',
+        rootDir: createIsolatedWardenExampleRoot('default'),
       },
       name: 'Default warden run',
     },
     {
       input: {
+        depth: 'source',
         format: 'github',
+        lock: 'skip',
+        rootDir: createIsolatedWardenExampleRoot('github'),
       },
       name: 'GitHub Actions annotations',
     },
   ],
-  input: z.object({
-    driftOnly: z.boolean().default(false).describe('Only run drift detection'),
-    format: z
-      .enum(['text', 'json', 'github', 'summary'])
-      .default('text')
-      .describe('Output format: text, json, github, or summary'),
-    lintOnly: z.boolean().default(false).describe('Only run lint rules'),
-    rootDir: z.string().optional().describe('Root directory to scan'),
-  }),
-  intent: 'read',
+  implementation: async (input, ctx) => {
+    const rootDirResult = resolveTrailRootDir(input.rootDir, ctx.cwd);
+    if (rootDirResult.isErr()) {
+      return rootDirResult;
+    }
+    const rootDir = rootDirResult.value;
+    const result = await runWardenCommand({
+      args: buildWardenCommandArgs(input),
+      cwd: rootDir,
+      env: ctx.env ?? {},
+    });
+    const { report } = result;
+
+    return Result.ok({
+      diagnostics: [...report.diagnostics],
+      drift: report.drift,
+      errorCount: report.errorCount,
+      fixes: report.fixes,
+      formatted: result.output,
+      passed: report.passed,
+      warnCount: report.warnCount,
+    });
+  },
+  input: wardenInputSchema,
+  intent: 'write',
   output: z.object({
     diagnostics: z.array(
-      z.object({
-        filePath: z.string(),
-        line: z.number(),
-        message: z.string(),
-        rule: z.string(),
-        severity: z.enum(['error', 'warn']),
-      })
+      diagnosticSchema.extend({ topoName: z.string().optional() })
     ),
     drift: z
       .object({
+        blockedReason: z.string().optional(),
         committedHash: z.string().nullable(),
         currentHash: z.string(),
         stale: z.boolean(),
       })
       .nullable(),
     errorCount: z.number(),
+    fixes: z
+      .object({
+        applied: z.number(),
+        filesChanged: z.number(),
+        skipped: z.number(),
+      })
+      .optional(),
     formatted: z.string(),
     passed: z.boolean(),
     warnCount: z.number(),
   }),
-  run: async (input, ctx) => {
-    const rootDir = input.rootDir ?? ctx.cwd ?? process.cwd();
-    // oxlint-disable-next-line prefer-await-to-then -- catch converts rejection to undefined cleanly
-    const topo = await loadApp('./src/app.ts', rootDir).catch(
-      (): undefined => undefined
-    );
-
-    const report = await runWarden({
-      driftOnly: input.driftOnly,
-      lintOnly: input.lintOnly,
-      rootDir,
-      topo,
-    });
-
-    const formatters: Record<string, (r: typeof report) => string> = {
-      github: formatGitHubAnnotations,
-      json: formatJson,
-      summary: formatSummary,
-      text: formatWardenReport,
-    };
-    const formatter = formatters[input.format] ?? formatWardenReport;
-    const formatted = formatter(report);
-
-    return Result.ok({
-      diagnostics: report.diagnostics,
-      drift: report.drift,
-      errorCount: report.errorCount,
-      formatted,
-      passed: report.passed,
-      warnCount: report.warnCount,
-    });
-  },
+  permit: 'public',
 });