@shrkcrft/inspector 0.1.0-alpha.2

package/dist/onboarding-drafts.js

@@ -0,0 +1,234 @@
+import { existsSync, mkdirSync, writeFileSync } from 'node:fs';
+import * as nodePath from 'node:path';
+import { renderOnboardingReport } from "./onboarding-report.js";
+/**
+ * Write onboarding drafts under sharkcraft/onboarding/. This function NEVER
+ * writes outside that subdirectory (the caller can override the location, but
+ * the function refuses any path that escapes the resolved outDir).
+ */
+export function writeOnboardingDrafts(plan, options) {
+    const outDir = nodePath.resolve(options.outDir ??
+        nodePath.join(options.projectRoot, 'sharkcraft', 'onboarding'));
+    ensureDir(outDir);
+    const files = [];
+    const write = (name, body) => {
+        const full = nodePath.join(outDir, name);
+        // Belt-and-braces: refuse anything that escapes outDir.
+        if (!full.startsWith(outDir + nodePath.sep)) {
+            throw new Error(`draft path escapes outDir: ${name}`);
+        }
+        writeFileSync(full, body, 'utf8');
+        files.push({ path: full, bytes: Buffer.byteLength(body, 'utf8') });
+    };
+    write('onboarding-report.md', renderOnboardingReport(plan));
+    write('inferred-rules.draft.ts', renderInferredRulesDraft(plan));
+    write('inferred-paths.draft.ts', renderInferredPathsDraft(plan));
+    write('inferred-templates.draft.ts', renderInferredTemplatesDraft(plan));
+    write('inferred-boundaries.draft.ts', renderInferredBoundariesDraft(plan));
+    write('inferred-pipelines.draft.ts', renderInferredPipelinesDraft(plan));
+    if (options.importedAgentRules && options.importedAgentRules.entries.length > 0) {
+        write('imported-agent-rules.draft.ts', renderImportedAgentRulesDraft(options.importedAgentRules));
+    }
+    return { outDir, files };
+}
+// ─── Renderers ───────────────────────────────────────────────────────────────
+function renderInferredRulesDraft(plan) {
+    const lines = [];
+    lines.push(`// Inferred rules draft — generated by \`shrk onboard\`. Review before adopting.`);
+    lines.push(`// Move keepers into sharkcraft/rules.ts.`);
+    lines.push(`export default [`);
+    for (const r of plan.inferredRules) {
+        lines.push(`  {`);
+        lines.push(`    id: ${literal(r.id)},`);
+        lines.push(`    type: 'rule',`);
+        lines.push(`    title: ${literal(r.title)},`);
+        lines.push(`    priority: ${literal(r.priority)},`);
+        lines.push(`    content: ${literal(r.content)},`);
+        lines.push(`    tags: ${literal(['inferred', r.source])},`);
+        lines.push(`    // reason: ${escapeSingleLineComment(r.reason)}`);
+        lines.push(`  },`);
+    }
+    lines.push(`];`);
+    return lines.join('\n') + '\n';
+}
+function renderInferredPathsDraft(plan) {
+    const lines = [];
+    lines.push(`// Inferred path conventions draft — generated by \`shrk onboard\`. Review before adopting.`);
+    lines.push(`// Move keepers into sharkcraft/paths.ts.`);
+    lines.push(`export default [`);
+    for (const p of plan.inferredPathConventions) {
+        lines.push(`  {`);
+        lines.push(`    id: ${literal(p.id)},`);
+        lines.push(`    type: 'path',`);
+        lines.push(`    title: ${literal(p.title)},`);
+        lines.push(`    content: ${literal(p.content)},`);
+        lines.push(`    patterns: ${literal(p.patterns)},`);
+        lines.push(`    tags: ${literal(['inferred', 'path'])},`);
+        lines.push(`    // reason: ${escapeSingleLineComment(p.reason)}`);
+        lines.push(`  },`);
+    }
+    lines.push(`];`);
+    return lines.join('\n') + '\n';
+}
+function renderInferredTemplatesDraft(plan) {
+    const lines = [];
+    const anyScaffolded = plan.inferredTemplateCandidates.some((t) => t.scaffold);
+    lines.push(`// Inferred template candidates — generated by \`shrk onboard\`.`);
+    if (anyScaffolded) {
+        lines.push(`// Entries with \`runnable: true\` ship a draft body with placeholder variables.`);
+        lines.push(`// Review carefully (especially low-confidence entries) before moving to sharkcraft/templates.ts.`);
+    }
+    else {
+        lines.push(`// NOT runnable until you fill in targetPath + content. Re-run with \`--scaffold-templates\` to draft bodies.`);
+    }
+    lines.push(`export default [`);
+    for (const t of plan.inferredTemplateCandidates) {
+        renderTemplateCandidate(lines, t);
+    }
+    lines.push(`];`);
+    return lines.join('\n') + '\n';
+}
+function renderTemplateCandidate(lines, t) {
+    lines.push(`  {`);
+    lines.push(`    id: ${literal(t.id)},`);
+    lines.push(`    name: ${literal(t.name)},`);
+    lines.push(`    description: ${literal(t.description)},`);
+    lines.push(`    confidence: ${literal(t.confidence)},`);
+    if (t.targetPathHint) {
+        lines.push(`    // targetPath hint: ${escapeSingleLineComment(t.targetPathHint)}`);
+    }
+    if (t.sample) {
+        lines.push(`    // sample: ${escapeSingleLineComment(t.sample)}`);
+    }
+    lines.push(`    // reason: ${escapeSingleLineComment(t.reason)}`);
+    if (t.scaffold) {
+        lines.push(`    runnable: true,`);
+        lines.push(`    scaffold: {`);
+        lines.push(`      id: ${literal(t.scaffold.id)},`);
+        lines.push(`      name: ${literal(t.scaffold.name)},`);
+        lines.push(`      description: ${literal(t.scaffold.description)},`);
+        lines.push(`      targetPath: ${literal(t.scaffold.targetPath)},`);
+        lines.push(`      variables: [`);
+        for (const v of t.scaffold.variables) {
+            lines.push(`        {`);
+            lines.push(`          name: ${literal(v.name)},`);
+            lines.push(`          description: ${literal(v.description)},`);
+            if (typeof v.default === 'string') {
+                lines.push(`          default: ${literal(v.default)},`);
+            }
+            lines.push(`        },`);
+        }
+        lines.push(`      ],`);
+        lines.push(`      content: ${renderMultilineTemplateLiteral(t.scaffold.content)},`);
+        if (t.scaffold.warnings.length > 0) {
+            lines.push(`      // warnings:`);
+            for (const w of t.scaffold.warnings) {
+                lines.push(`      //   - ${escapeSingleLineComment(w)}`);
+            }
+        }
+        lines.push(`    },`);
+    }
+    lines.push(`  },`);
+}
+function renderMultilineTemplateLiteral(content) {
+    // Use a tagged template literal-safe form. Backticks and ${ must be escaped.
+    const escaped = content.replace(/\\/g, '\\\\').replace(/`/g, '\\`').replace(/\$\{/g, '\\${');
+    return '`' + escaped + '`';
+}
+function renderInferredBoundariesDraft(plan) {
+    const lines = [];
+    lines.push(`// Inferred boundary rules draft — generated by \`shrk onboard\`. Review before adopting.`);
+    lines.push(`// Drop into sharkcraft/boundaries.ts (and register via sharkcraft.config.ts boundaryFiles).`);
+    lines.push(`export default [`);
+    for (const b of plan.inferredBoundaryRules) {
+        lines.push(`  {`);
+        lines.push(`    id: ${literal(b.id)},`);
+        lines.push(`    title: ${literal(b.title)},`);
+        lines.push(`    severity: ${literal(b.severity)},`);
+        lines.push(`    from: ${literal(b.from)},`);
+        if (b.forbiddenImports) {
+            lines.push(`    forbiddenImports: ${literal(b.forbiddenImports)},`);
+        }
+        if (b.allowedImports) {
+            lines.push(`    allowedImports: ${literal(b.allowedImports)},`);
+        }
+        lines.push(`    suggestedFix: ${literal(b.suggestedFix)},`);
+        lines.push(`    // reason: ${escapeSingleLineComment(b.reason)}`);
+        lines.push(`  },`);
+    }
+    lines.push(`];`);
+    return lines.join('\n') + '\n';
+}
+function renderInferredPipelinesDraft(plan) {
+    const lines = [];
+    lines.push(`// Inferred pipelines draft — generated by \`shrk onboard\`. Review before adopting.`);
+    lines.push(`// Move keepers into sharkcraft/pipelines.ts.`);
+    lines.push(`export default [`);
+    for (const p of plan.inferredPipelines) {
+        lines.push(`  {`);
+        lines.push(`    id: ${literal(p.id)},`);
+        lines.push(`    title: ${literal(p.title)},`);
+        lines.push(`    description: ${literal(p.description)},`);
+        lines.push(`    steps: ${renderSteps(p.steps)},`);
+        lines.push(`    // reason: ${escapeSingleLineComment(p.reason)}`);
+        lines.push(`  },`);
+    }
+    lines.push(`];`);
+    return lines.join('\n') + '\n';
+}
+function renderSteps(steps) {
+    const items = steps.map((id) => `      { id: ${literal(id)}, title: ${literal(id)} }`);
+    return `[\n${items.join(',\n')}\n    ]`;
+}
+// ─── Util ────────────────────────────────────────────────────────────────────
+function literal(v) {
+    if (Array.isArray(v)) {
+        return `[${v.map((x) => literal(x)).join(', ')}]`;
+    }
+    if (typeof v === 'string') {
+        // Use JSON.stringify for safe escaping.
+        return JSON.stringify(v);
+    }
+    return JSON.stringify(v);
+}
+function escapeSingleLineComment(s) {
+    return s.replace(/\r?\n/g, ' ').replace(/\*\//g, '*​/');
+}
+function ensureDir(dir) {
+    if (existsSync(dir))
+        return;
+    mkdirSync(dir, { recursive: true });
+}
+function renderImportedAgentRulesDraft(bundle) {
+    const lines = [];
+    lines.push(`// Imported agent rules draft — generated by \`shrk onboard --import-agents\`.`);
+    lines.push(`// Source files: ${bundle.sourceFiles.map((s) => escapeSingleLineComment(s)).join(', ') || '(none)'}`);
+    lines.push(`// Review before adopting; entries flagged "ambiguous" may need a manual rewrite.`);
+    lines.push(`export default [`);
+    for (const e of bundle.entries) {
+        lines.push(`  {`);
+        lines.push(`    id: ${literal(e.id)},`);
+        lines.push(`    type: ${literal(e.type)},`);
+        lines.push(`    title: ${literal(e.title)},`);
+        lines.push(`    content: ${literal(e.content)},`);
+        lines.push(`    tags: ${literal(e.tags)},`);
+        if (e.scope?.length)
+            lines.push(`    scope: ${literal(e.scope)},`);
+        if (e.source?.origin) {
+            lines.push(`    // origin: ${escapeSingleLineComment(e.source.origin)}`);
+        }
+        if (e.flaggedAmbiguous) {
+            lines.push(`    // ambiguous: please review the wording before adopting`);
+        }
+        lines.push(`  },`);
+    }
+    lines.push(`];`);
+    if (bundle.warnings.length > 0) {
+        lines.push('');
+        lines.push('// Warnings:');
+        for (const w of bundle.warnings) {
+            lines.push(`//   - ${escapeSingleLineComment(w)}`);
+        }
+    }
+    return lines.join('\n') + '\n';
+}

package/dist/onboarding-report.d.ts

@@ -0,0 +1,8 @@
+import type { IOnboardingPlan } from './onboarding.js';
+/**
+ * Render an onboarding plan as a Markdown report. The output is intentionally
+ * stable and human-readable: it is the artifact a user reads when deciding
+ * whether to adopt SharkCraft drafts.
+ */
+export declare function renderOnboardingReport(plan: IOnboardingPlan): string;
+//# sourceMappingURL=onboarding-report.d.ts.map

package/dist/onboarding-report.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"onboarding-report.d.ts","sourceRoot":"","sources":["../src/onboarding-report.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,iBAAiB,CAAC;AAEvD;;;;GAIG;AACH,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,eAAe,GAAG,MAAM,CA0PpE"}

package/dist/onboarding-report.js

@@ -0,0 +1,239 @@
+/**
+ * Render an onboarding plan as a Markdown report. The output is intentionally
+ * stable and human-readable: it is the artifact a user reads when deciding
+ * whether to adopt SharkCraft drafts.
+ */
+export function renderOnboardingReport(plan) {
+    const out = [];
+    out.push('# SharkCraft onboarding report');
+    out.push('');
+    // ── Project summary ────────────────────────────────────────────────────
+    out.push('## Project summary');
+    out.push('');
+    const s = plan.projectSummary;
+    out.push(`- Project root: \`${s.projectRoot}\``);
+    if (s.projectName)
+        out.push(`- Name: \`${s.projectName}\``);
+    if (s.description)
+        out.push(`- Description: ${s.description}`);
+    out.push(`- Package manager: \`${s.packageManager}\``);
+    out.push(`- SharkCraft folder present: ${s.hasSharkcraftFolder ? 'yes' : 'no'}`);
+    if (s.profiles.length) {
+        out.push(`- Profiles: ${s.profiles.map((p) => `\`${p}\``).join(', ')}`);
+    }
+    else {
+        out.push('- Profiles: none detected');
+    }
+    out.push('');
+    // ── AI-readiness ──────────────────────────────────────────────────────
+    out.push('## AI-readiness — current vs. expected');
+    out.push('');
+    out.push(`- Current: **${plan.readiness.current}** (score ${plan.readiness.currentScore}/100)`);
+    out.push(`- Expected after drafts: **${plan.readiness.expected}** (score ~${plan.readiness.expectedScore}/100)`);
+    out.push('');
+    if (plan.readiness.topImprovements.length) {
+        out.push('Top improvements:');
+        for (const i of plan.readiness.topImprovements)
+            out.push(`- ${i}`);
+        out.push('');
+    }
+    // ── Recommended presets ───────────────────────────────────────────────
+    if (plan.recommendedPresets.length) {
+        out.push('## Recommended presets');
+        out.push('');
+        for (const r of plan.recommendedPresets) {
+            out.push(`- **${r.preset.id}** (${r.confidence}, score ${r.score}) — ${r.preset.title}`);
+            if (r.reasons.length) {
+                for (const reason of r.reasons)
+                    out.push(`  - ${reason}`);
+            }
+        }
+        out.push('');
+    }
+    // ── Suggested files ───────────────────────────────────────────────────
+    out.push('## Suggested files');
+    out.push('');
+    out.push('Drafts are written under `sharkcraft/onboarding/` only.');
+    out.push('No existing rules.ts / paths.ts / templates.ts is overwritten.');
+    out.push('');
+    for (const f of plan.suggestedFiles)
+        out.push(`- \`${f}\``);
+    out.push('');
+    // ── Path conventions ──────────────────────────────────────────────────
+    out.push('## Suggested path conventions');
+    out.push('');
+    if (plan.inferredPathConventions.length === 0) {
+        out.push('_No path conventions inferred._');
+    }
+    else {
+        for (const p of plan.inferredPathConventions) {
+            out.push(`- **${p.id}** — ${p.title}`);
+            out.push(`  - patterns: ${p.patterns.map((x) => `\`${x}\``).join(', ')}`);
+            out.push(`  - reason: ${p.reason}`);
+        }
+    }
+    out.push('');
+    // ── Rules ─────────────────────────────────────────────────────────────
+    out.push('## Suggested rules');
+    out.push('');
+    if (plan.inferredRules.length === 0) {
+        out.push('_No rules inferred._');
+    }
+    else {
+        for (const r of plan.inferredRules) {
+            out.push(`- **${r.id}** (${r.priority}) — ${r.title}`);
+            out.push(`  - reason: ${r.reason}`);
+        }
+    }
+    out.push('');
+    // ── Boundary rules ────────────────────────────────────────────────────
+    out.push('## Suggested boundary rules');
+    out.push('');
+    if (plan.inferredBoundaryRules.length === 0) {
+        out.push('_No boundary rules inferred — layer structure not clear enough._');
+    }
+    else {
+        for (const b of plan.inferredBoundaryRules) {
+            out.push(`- **${b.id}** (${b.severity}) — ${b.title}`);
+            out.push(`  - from: ${b.from.map((x) => `\`${x}\``).join(', ')}`);
+            if (b.forbiddenImports?.length) {
+                out.push(`  - forbids: ${b.forbiddenImports.map((x) => `\`${x}\``).join(', ')}`);
+            }
+            out.push(`  - fix: ${b.suggestedFix}`);
+            out.push(`  - reason: ${b.reason}`);
+        }
+    }
+    out.push('');
+    // ── Template candidates ───────────────────────────────────────────────
+    out.push('## Suggested templates');
+    out.push('');
+    if (plan.inferredTemplateCandidates.length === 0) {
+        out.push('_No template candidates detected._');
+    }
+    else {
+        for (const t of plan.inferredTemplateCandidates) {
+            out.push(`- **${t.id}** (${t.confidence}) — ${t.name}`);
+            out.push(`  - ${t.description}`);
+            if (t.targetPathHint)
+                out.push(`  - target: \`${t.targetPathHint}\``);
+            if (t.sample)
+                out.push(`  - sample: \`${t.sample}\``);
+            out.push(`  - reason: ${t.reason}`);
+        }
+    }
+    out.push('');
+    // ── Pipelines ─────────────────────────────────────────────────────────
+    out.push('## Suggested pipelines');
+    out.push('');
+    if (plan.inferredPipelines.length === 0) {
+        out.push('_No pipelines inferred._');
+    }
+    else {
+        for (const p of plan.inferredPipelines) {
+            out.push(`- **${p.id}** — ${p.title}`);
+            out.push(`  - steps: ${p.steps.map((s) => `\`${s}\``).join(' → ')}`);
+            out.push(`  - reason: ${p.reason}`);
+        }
+    }
+    out.push('');
+    // ── Verification commands ─────────────────────────────────────────────
+    out.push('## Verification commands');
+    out.push('');
+    if (plan.inferredVerificationCommands.length === 0) {
+        out.push('_No verification commands inferred — add scripts to package.json so apply can validate._');
+    }
+    else {
+        for (const v of plan.inferredVerificationCommands) {
+            out.push(`- **${v.id}** — \`${v.command}\``);
+            out.push(`  - reason: ${v.reason}`);
+        }
+    }
+    out.push('');
+    // ── Existing instruction files ────────────────────────────────────────
+    if (plan.detectedInstructionFiles.length) {
+        out.push('## Existing instruction files detected');
+        out.push('');
+        for (const f of plan.detectedInstructionFiles) {
+            out.push(`- \`${f.path}\` — import with: \`${f.importCommand}\``);
+        }
+        out.push('');
+    }
+    // ── Monorepo summary ──────────────────────────────────────────────────
+    if (plan.monorepoSummary) {
+        const m = plan.monorepoSummary;
+        out.push('## Monorepo summary');
+        out.push('');
+        out.push(`- Apps: ${m.apps.length}, Packages: ${m.packages.length}, Libs: ${m.libs.length}`);
+        if (m.workspaces.length > 0) {
+            out.push(`- Workspaces: ${m.workspaces.map((w) => `\`${w}\``).join(', ')}`);
+        }
+        if (m.notes.length) {
+            for (const n of m.notes)
+                out.push(`- ${n}`);
+        }
+        out.push('');
+        if (m.apps.length + m.packages.length + m.libs.length > 0) {
+            out.push('### Detected workspaces');
+            out.push('');
+            for (const p of [...m.apps, ...m.packages, ...m.libs]) {
+                const scriptList = Object.keys(p.scripts).slice(0, 4).join(', ');
+                out.push(`- \`${p.path}\`${p.name ? ` (\`${p.name}\`)` : ''}${scriptList ? ` — scripts: ${scriptList}` : ''}`);
+            }
+            out.push('');
+        }
+        if (m.rootVerificationCommands.length) {
+            out.push('### Root verification commands');
+            out.push('');
+            for (const c of m.rootVerificationCommands)
+                out.push(`- \`${c}\``);
+            out.push('');
+        }
+        if (m.perPackageVerificationHints.length) {
+            out.push('### Per-package verification hints');
+            out.push('');
+            for (const h of m.perPackageVerificationHints.slice(0, 24)) {
+                out.push(`- \`${h.packagePath}\` — \`${h.command}\``);
+            }
+            if (m.perPackageVerificationHints.length > 24) {
+                out.push(`- …and ${m.perPackageVerificationHints.length - 24} more.`);
+            }
+            out.push('');
+        }
+        if (m.boundaryCandidates.length) {
+            out.push('### Boundary candidates (from layout)');
+            out.push('');
+            for (const b of m.boundaryCandidates) {
+                out.push(`- **${b.id}** — ${b.title}`);
+                out.push(`  - from: ${b.from.map((x) => `\`${x}\``).join(', ')}`);
+                out.push(`  - forbids: ${b.forbiddenImports.map((x) => `\`${x}\``).join(', ')}`);
+                out.push(`  - reason: ${b.reason}`);
+            }
+            out.push('');
+        }
+        if (m.presetRecommendations.length) {
+            out.push('### Preset recommendations for monorepo root');
+            out.push('');
+            for (const p of m.presetRecommendations)
+                out.push(`- \`${p}\``);
+            out.push('');
+        }
+    }
+    // ── Risks / warnings ──────────────────────────────────────────────────
+    if (plan.risks.length) {
+        out.push('## Risks / warnings');
+        out.push('');
+        for (const r of plan.risks)
+            out.push(`- ${r}`);
+        out.push('');
+    }
+    // ── Next commands ─────────────────────────────────────────────────────
+    out.push('## Next commands');
+    out.push('');
+    for (const c of plan.nextCommands)
+        out.push(`- \`${c}\``);
+    out.push('');
+    out.push('---');
+    out.push('');
+    out.push('Drafts are advisory. SharkCraft never overwrites rules.ts / paths.ts / templates.ts — adopt by hand.');
+    return out.join('\n');
+}

package/dist/onboarding.d.ts

@@ -0,0 +1,134 @@
+import { PackageManager, WorkspaceProfile, type IWorkspaceSummary } from '@shrkcrft/workspace';
+import { type IPresetRecommendation } from '@shrkcrft/presets';
+import type { ISharkcraftInspection } from './sharkcraft-inspector.js';
+import { type ReadinessGrade } from './ai-readiness.js';
+import { type IInferredTemplateScaffold } from './template-body-inference.js';
+import { type IMonorepoSummary } from './monorepo-onboarding.js';
+export interface IInferredPathConvention {
+    id: string;
+    title: string;
+    content: string;
+    /** Glob patterns matching files this convention applies to. */
+    patterns: readonly string[];
+    reason: string;
+}
+export interface IInferredVerificationCommand {
+    id: string;
+    label: string;
+    command: string;
+    trusted: boolean;
+    reason: string;
+}
+export interface IInferredBoundaryRule {
+    id: string;
+    title: string;
+    severity: 'error' | 'warning';
+    from: readonly string[];
+    forbiddenImports?: readonly string[];
+    allowedImports?: readonly string[];
+    suggestedFix: string;
+    reason: string;
+}
+export interface IInferredTemplateCandidate {
+    id: string;
+    name: string;
+    description: string;
+    /** Sample file we'd model the template on (if any). */
+    sample?: string;
+    /** Suggested targetPath pattern relative to projectRoot. */
+    targetPathHint?: string;
+    /** Whether we are confident enough to emit a draft. */
+    confidence: 'high' | 'medium' | 'low';
+    reason: string;
+    /**
+     * Runnable scaffold body — only populated when the caller passed
+     * `scaffoldTemplates: true` AND scaffolding succeeded for this candidate.
+     * Drafts use this to emit a runnable template body; absence means the user
+     * gets the conservative metadata-only entry.
+     */
+    scaffold?: IInferredTemplateScaffold;
+}
+export interface IInferredRule {
+    id: string;
+    title: string;
+    content: string;
+    priority: 'critical' | 'high' | 'medium' | 'low';
+    source: 'package-json' | 'tsconfig' | 'folder-structure' | 'imports' | 'agents-md';
+    reason: string;
+}
+export interface IInferredPipeline {
+    id: string;
+    title: string;
+    description: string;
+    /** Suggested step ids in order. */
+    steps: readonly string[];
+    reason: string;
+}
+export interface IDetectedInstructionFile {
+    kind: 'agents-md' | 'claude-md' | 'cursor-rules';
+    /** Project-relative path. */
+    path: string;
+    /** The CLI command we'd recommend running. */
+    importCommand: string;
+}
+export interface IReadinessEstimate {
+    current: ReadinessGrade;
+    expected: ReadinessGrade;
+    currentScore: number;
+    expectedScore: number;
+    topImprovements: readonly string[];
+}
+export interface IOnboardingProjectSummary {
+    projectRoot: string;
+    projectName?: string;
+    description?: string;
+    packageManager: PackageManager;
+    profiles: readonly WorkspaceProfile[];
+    hasSharkcraftFolder: boolean;
+}
+export interface IOnboardingPlan {
+    projectSummary: IOnboardingProjectSummary;
+    /** Best-fit presets ranked against detected profiles. */
+    recommendedPresets: readonly IPresetRecommendation[];
+    /** Suggested sharkcraft/* files to scaffold. */
+    suggestedFiles: readonly string[];
+    inferredPathConventions: readonly IInferredPathConvention[];
+    inferredVerificationCommands: readonly IInferredVerificationCommand[];
+    inferredBoundaryRules: readonly IInferredBoundaryRule[];
+    inferredTemplateCandidates: readonly IInferredTemplateCandidate[];
+    inferredRules: readonly IInferredRule[];
+    inferredPipelines: readonly IInferredPipeline[];
+    /** AGENTS.md / CLAUDE.md / .cursor/rules detected for optional import. */
+    detectedInstructionFiles: readonly IDetectedInstructionFile[];
+    /** Risks/warnings — things we couldn't infer or need human review. */
+    risks: readonly string[];
+    /** Suggested commands the user can run next. */
+    nextCommands: readonly string[];
+    readiness: IReadinessEstimate;
+    /**
+     * Monorepo overview when the project has workspaces / Nx / packages+libs+apps.
+     * `null` for plain single-package repos.
+     */
+    monorepoSummary: IMonorepoSummary | null;
+}
+export interface IBuildOnboardingPlanOptions {
+    /** Pinned preset id to surface first in the recommendation list. */
+    preferredPreset?: string;
+    /**
+     * When true, attempt to produce runnable scaffolded bodies for high- and
+     * medium-confidence template candidates. Default false (metadata only).
+     */
+    scaffoldTemplates?: boolean;
+}
+export declare function buildOnboardingPlan(inspection: ISharkcraftInspection, options?: IBuildOnboardingPlanOptions): IOnboardingPlan;
+export declare function inferPathConventions(ws: IWorkspaceSummary, subDirs: ReadonlyMap<string, readonly string[]>): IInferredPathConvention[];
+export declare function inferVerificationCommands(ws: IWorkspaceSummary): IInferredVerificationCommand[];
+export declare function inferBoundaryRules(ws: IWorkspaceSummary, subDirs: ReadonlyMap<string, readonly string[]>): IInferredBoundaryRule[];
+export interface IInferTemplateCandidatesOptions {
+    scaffoldTemplates?: boolean;
+}
+export declare function inferTemplateCandidates(ws: IWorkspaceSummary, options?: IInferTemplateCandidatesOptions): IInferredTemplateCandidate[];
+export declare function inferRules(ws: IWorkspaceSummary): IInferredRule[];
+export declare function inferPipelines(ws: IWorkspaceSummary, verification: readonly IInferredVerificationCommand[]): IInferredPipeline[];
+export declare function detectInstructionFiles(projectRoot: string): IDetectedInstructionFile[];
+//# sourceMappingURL=onboarding.d.ts.map

package/dist/onboarding.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"onboarding.d.ts","sourceRoot":"","sources":["../src/onboarding.ts"],"names":[],"mappings":"AAEA,OAAO,EACL,cAAc,EACd,gBAAgB,EAEhB,KAAK,iBAAiB,EACvB,MAAM,qBAAqB,CAAC;AAC7B,OAAO,EAGL,KAAK,qBAAqB,EAC3B,MAAM,mBAAmB,CAAC;AAC3B,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,2BAA2B,CAAC;AACvE,OAAO,EAEL,KAAK,cAAc,EACpB,MAAM,mBAAmB,CAAC;AAC3B,OAAO,EAEL,KAAK,yBAAyB,EAC/B,MAAM,8BAA8B,CAAC;AACtC,OAAO,EAEL,KAAK,gBAAgB,EACtB,MAAM,0BAA0B,CAAC;AAIlC,MAAM,WAAW,uBAAuB;IACtC,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,+DAA+D;IAC/D,QAAQ,EAAE,SAAS,MAAM,EAAE,CAAC;IAC5B,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,4BAA4B;IAC3C,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,OAAO,EAAE,OAAO,CAAC;IACjB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,qBAAqB;IACpC,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,OAAO,GAAG,SAAS,CAAC;IAC9B,IAAI,EAAE,SAAS,MAAM,EAAE,CAAC;IACxB,gBAAgB,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IACrC,cAAc,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;IACnC,YAAY,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,0BAA0B;IACzC,EAAE,EAAE,MAAM,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;IACb,WAAW,EAAE,MAAM,CAAC;IACpB,uDAAuD;IACvD,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,4DAA4D;IAC5D,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,uDAAuD;IACvD,UAAU,EAAE,MAAM,GAAG,QAAQ,GAAG,KAAK,CAAC;IACtC,MAAM,EAAE,MAAM,CAAC;IACf;;;;;OAKG;IACH,QAAQ,CAAC,EAAE,yBAAyB,CAAC;CACtC;AAED,MAAM,WAAW,aAAa;IAC5B,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,UAAU,GAAG,MAAM,GAAG,QAAQ,GAAG,KAAK,CAAC;IACjD,MAAM,EACF,cAAc,GACd,UAAU,GACV,kBAAkB,GAClB,SAAS,GACT,WAAW,CAAC;IAChB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,iBAAiB;IAChC,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,EAAE,MAAM,CAAC;IACpB,mCAAmC;IACnC,KAAK,EAAE,SAAS,MAAM,EAAE,CAAC;IACzB,MAAM,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,WAAW,wBAAwB;IACvC,IAAI,EAAE,WAAW,GAAG,WAAW,GAAG,cAAc,CAAC;IACjD,6BAA6B;IAC7B,IAAI,EAAE,MAAM,CAAC;IACb,8CAA8C;IAC9C,aAAa,EAAE,MAAM,CAAC;CACvB;AAED,MAAM,WAAW,kBAAkB;IACjC,OAAO,EAAE,cAAc,CAAC;IACxB,QAAQ,EAAE,cAAc,CAAC;IACzB,YAAY,EAAE,MAAM,CAAC;IACrB,aAAa,EAAE,MAAM,CAAC;IACtB,eAAe,EAAE,SAAS,MAAM,EAAE,CAAC;CACpC;AAED,MAAM,WAAW,yBAAyB;IACxC,WAAW,EAAE,MAAM,CAAC;IACpB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,cAAc,EAAE,cAAc,CAAC;IAC/B,QAAQ,EAAE,SAAS,gBAAgB,EAAE,CAAC;IACtC,mBAAmB,EAAE,OAAO,CAAC;CAC9B;AAED,MAAM,WAAW,eAAe;IAC9B,cAAc,EAAE,yBAAyB,CAAC;IAC1C,yDAAyD;IACzD,kBAAkB,EAAE,SAAS,qBAAqB,EAAE,CAAC;IACrD,gDAAgD;IAChD,cAAc,EAAE,SAAS,MAAM,EAAE,CAAC;IAClC,uBAAuB,EAAE,SAAS,uBAAuB,EAAE,CAAC;IAC5D,4BAA4B,EAAE,SAAS,4BAA4B,EAAE,CAAC;IACtE,qBAAqB,EAAE,SAAS,qBAAqB,EAAE,CAAC;IACxD,0BAA0B,EAAE,SAAS,0BAA0B,EAAE,CAAC;IAClE,aAAa,EAAE,SAAS,aAAa,EAAE,CAAC;IACxC,iBAAiB,EAAE,SAAS,iBAAiB,EAAE,CAAC;IAChD,0EAA0E;IAC1E,wBAAwB,EAAE,SAAS,wBAAwB,EAAE,CAAC;IAC9D,sEAAsE;IACtE,KAAK,EAAE,SAAS,MAAM,EAAE,CAAC;IACzB,gDAAgD;IAChD,YAAY,EAAE,SAAS,MAAM,EAAE,CAAC;IAChC,SAAS,EAAE,kBAAkB,CAAC;IAC9B;;;OAGG;IACH,eAAe,EAAE,gBAAgB,GAAG,IAAI,CAAC;CAC1C;AAED,MAAM,WAAW,2BAA2B;IAC1C,oEAAoE;IACpE,eAAe,CAAC,EAAE,MAAM,CAAC;IACzB;;;OAGG;IACH,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B;AAID,wBAAgB,mBAAmB,CACjC,UAAU,EAAE,qBAAqB,EACjC,OAAO,GAAE,2BAAgC,GACxC,eAAe,CAuEjB;AA8ED,wBAAgB,oBAAoB,CAClC,EAAE,EAAE,iBAAiB,EACrB,OAAO,EAAE,WAAW,CAAC,MAAM,EAAE,SAAS,MAAM,EAAE,CAAC,GAC9C,uBAAuB,EAAE,CA2C3B;AAoBD,wBAAgB,yBAAyB,CACvC,EAAE,EAAE,iBAAiB,GACpB,4BAA4B,EAAE,CAqBhC;AAsCD,wBAAgB,kBAAkB,CAChC,EAAE,EAAE,iBAAiB,EACrB,OAAO,EAAE,WAAW,CAAC,MAAM,EAAE,SAAS,MAAM,EAAE,CAAC,GAC9C,qBAAqB,EAAE,CAyCzB;AAqDD,MAAM,WAAW,+BAA+B;IAC9C,iBAAiB,CAAC,EAAE,OAAO,CAAC;CAC7B;AAED,wBAAgB,uBAAuB,CACrC,EAAE,EAAE,iBAAiB,EACrB,OAAO,GAAE,+BAAoC,GAC5C,0BAA0B,EAAE,CAmC9B;AAID,wBAAgB,UAAU,CAAC,EAAE,EAAE,iBAAiB,GAAG,aAAa,EAAE,CAqGjE;AAID,wBAAgB,cAAc,CAC5B,EAAE,EAAE,iBAAiB,EACrB,YAAY,EAAE,SAAS,4BAA4B,EAAE,GACpD,iBAAiB,EAAE,CA4DrB;AAID,wBAAgB,sBAAsB,CACpC,WAAW,EAAE,MAAM,GAClB,wBAAwB,EAAE,CAyB5B"}