@shrkcrft/inspector 0.1.0-alpha.2

package/dist/onboarding-adoption.d.ts

@@ -0,0 +1,136 @@
+import type { ISharkcraftInspection } from './sharkcraft-inspector.js';
+import type { IOnboardingPlan } from './onboarding.js';
+export declare enum AdoptionCategory {
+    SafeToAdopt = "safe-to-adopt",
+    ManualReview = "manual-review",
+    LowConfidence = "low-confidence",
+    Conflict = "conflict",
+    AlreadyCovered = "already-covered",
+    Skipped = "skipped"
+}
+export declare enum AdoptionKind {
+    Rule = "rule",
+    Path = "path",
+    Verification = "verification",
+    Template = "template",
+    Boundary = "boundary",
+    Pipeline = "pipeline"
+}
+export interface IAdoptionItem {
+    kind: AdoptionKind;
+    id: string;
+    title: string;
+    category: AdoptionCategory;
+    /** Why this item was placed in the given category. */
+    reason: string;
+    /** Source draft file under sharkcraft/onboarding/. */
+    draftFile: string;
+    /** Short snippet to be included in the adoption-plan.md. */
+    preview: string;
+}
+export interface IAdoptionPlan {
+    /** Confidence threshold used to build the plan. */
+    confidence: 'high' | 'medium' | 'low';
+    /** Which kinds were included by the user (defaults to all except templates). */
+    included: readonly AdoptionKind[];
+    /** Which kinds were excluded. */
+    excluded: readonly AdoptionKind[];
+    items: readonly IAdoptionItem[];
+    /** Summary counts keyed by category. */
+    summary: Readonly<Record<AdoptionCategory, number>>;
+    /** Items grouped per category for human consumption. */
+    byCategory: Readonly<Record<AdoptionCategory, readonly IAdoptionItem[]>>;
+}
+export interface IBuildAdoptionPlanInput {
+    inspection: ISharkcraftInspection;
+    plan: IOnboardingPlan;
+    /** Confidence threshold. Default: 'high'. */
+    confidence?: 'high' | 'medium' | 'low';
+    /** Kinds explicitly included. Empty = all except `template` and `boundary`. */
+    include?: readonly AdoptionKind[];
+    /** Kinds explicitly excluded. Always applied last. */
+    exclude?: readonly AdoptionKind[];
+    /** When true, imported agent rules are treated as manual-review (default). */
+    treatImportedAgentRulesAsManualReview?: boolean;
+}
+/**
+ * Build an adoption plan from an onboarding plan. Pure: no IO. The plan
+ * classifies every inferred item into one of the AdoptionCategory buckets and
+ * records the threshold/include/exclude inputs so it's reproducible.
+ */
+export declare function buildOnboardingAdoptionPlan(input: IBuildAdoptionPlanInput): IAdoptionPlan;
+export declare function renderAdoptionPlanMarkdown(plan: IAdoptionPlan): string;
+export type AdoptionPatchFormat = 'pseudo' | 'unified';
+export interface IRenderAdoptionPatchOptions {
+    /** 'pseudo' (default) preserves the `@@ append @@` sentinel for human review.
+     *  'unified' produces a real git-apply-compatible patch. */
+    format?: AdoptionPatchFormat;
+    /** Project root — required when format='unified' so existing-file hunks read
+     *  the current file content. */
+    projectRoot?: string;
+}
+export interface IAdoptionPatchTarget {
+    relativePath: string;
+    /** sha256 of the existing file when format='unified' and the file exists. */
+    beforeHash?: string;
+    /** Whether the target existed at patch render time. */
+    existed: boolean;
+    /** Bytes added by this hunk. */
+    bytesAdded: number;
+}
+export interface IRenderAdoptionPatchResult {
+    body: string;
+    targets: IAdoptionPatchTarget[];
+    format: AdoptionPatchFormat;
+}
+/**
+ * Render an adoption patch. Defaults to the conservative 'pseudo' format
+ * (sentinel-marked append block). 'unified' produces real `git apply`
+ * patches: full-file create for missing targets, append-at-EOF hunk for
+ * existing targets with a small leading context window so git can find the
+ * insertion point reliably.
+ *
+ * The patch is always append-only and intentionally never overwrites
+ * existing content. Output lives under sharkcraft/onboarding/adoption/.
+ */
+export declare function renderAdoptionPatchDetailed(plan: IAdoptionPlan, options?: IRenderAdoptionPatchOptions): IRenderAdoptionPatchResult;
+/** Back-compat wrapper that returns just the patch body. */
+export declare function renderAdoptionPatch(plan: IAdoptionPlan): string;
+export interface IWriteAdoptionPatchInput {
+    projectRoot: string;
+    plan: IAdoptionPlan;
+    /** Patch format. Default 'pseudo'. */
+    format?: AdoptionPatchFormat;
+    /** When true (default), if previous adoption-state.json exists and the
+     *  current target file hashes diverge from the previously-recorded hashes,
+     *  archive the old state+patch under history/ before writing the new ones. */
+    autoRegenerate?: boolean;
+    /** Override: skip the auto-regenerate archival step. Pairs with
+     *  `--no-auto-regenerate` on the CLI. */
+    noAutoRegenerate?: boolean;
+}
+export interface IWriteAdoptionPatchResult {
+    outDir: string;
+    files: Array<{
+        path: string;
+        bytes: number;
+    }>;
+    format: AdoptionPatchFormat;
+    /** Targets the patch touches, with `beforeHash` for unified-format hunks. */
+    targets: IAdoptionPatchTarget[];
+    /** Adoption state file path (always written). */
+    statePath: string;
+    /** Whether previous outputs were archived under history/ before the run. */
+    archived: readonly string[];
+    /** Whether the previous patch was detected as stale at write time. */
+    wasStale: boolean;
+}
+export declare function writeAdoptionPatch(input: IWriteAdoptionPatchInput): IWriteAdoptionPatchResult;
+/** Validate that the targets in a previously-written summary still match the
+ *  current files on disk. Used by `shrk onboard adopt review` to warn when
+ *  the target files changed between plan-time and review-time. */
+export declare function validatePatchTargets(projectRoot: string, targets: readonly IAdoptionPatchTarget[]): {
+    changed: readonly IAdoptionPatchTarget[];
+    ok: readonly IAdoptionPatchTarget[];
+};
+//# sourceMappingURL=onboarding-adoption.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"onboarding-adoption.d.ts","sourceRoot":"","sources":["../src/onboarding-adoption.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,qBAAqB,EAAE,MAAM,2BAA2B,CAAC;AACvE,OAAO,KAAK,EAOV,eAAe,EAChB,MAAM,iBAAiB,CAAC;AAGzB,oBAAY,gBAAgB;IAC1B,WAAW,kBAAkB;IAC7B,YAAY,kBAAkB;IAC9B,aAAa,mBAAmB;IAChC,QAAQ,aAAa;IACrB,cAAc,oBAAoB;IAClC,OAAO,YAAY;CACpB;AAED,oBAAY,YAAY;IACtB,IAAI,SAAS;IACb,IAAI,SAAS;IACb,YAAY,iBAAiB;IAC7B,QAAQ,aAAa;IACrB,QAAQ,aAAa;IACrB,QAAQ,aAAa;CACtB;AAED,MAAM,WAAW,aAAa;IAC5B,IAAI,EAAE,YAAY,CAAC;IACnB,EAAE,EAAE,MAAM,CAAC;IACX,KAAK,EAAE,MAAM,CAAC;IACd,QAAQ,EAAE,gBAAgB,CAAC;IAC3B,sDAAsD;IACtD,MAAM,EAAE,MAAM,CAAC;IACf,sDAAsD;IACtD,SAAS,EAAE,MAAM,CAAC;IAClB,4DAA4D;IAC5D,OAAO,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,aAAa;IAC5B,mDAAmD;IACnD,UAAU,EAAE,MAAM,GAAG,QAAQ,GAAG,KAAK,CAAC;IACtC,gFAAgF;IAChF,QAAQ,EAAE,SAAS,YAAY,EAAE,CAAC;IAClC,iCAAiC;IACjC,QAAQ,EAAE,SAAS,YAAY,EAAE,CAAC;IAClC,KAAK,EAAE,SAAS,aAAa,EAAE,CAAC;IAChC,wCAAwC;IACxC,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,gBAAgB,EAAE,MAAM,CAAC,CAAC,CAAC;IACpD,wDAAwD;IACxD,UAAU,EAAE,QAAQ,CAAC,MAAM,CAAC,gBAAgB,EAAE,SAAS,aAAa,EAAE,CAAC,CAAC,CAAC;CAC1E;AAED,MAAM,WAAW,uBAAuB;IACtC,UAAU,EAAE,qBAAqB,CAAC;IAClC,IAAI,EAAE,eAAe,CAAC;IACtB,6CAA6C;IAC7C,UAAU,CAAC,EAAE,MAAM,GAAG,QAAQ,GAAG,KAAK,CAAC;IACvC,+EAA+E;IAC/E,OAAO,CAAC,EAAE,SAAS,YAAY,EAAE,CAAC;IAClC,sDAAsD;IACtD,OAAO,CAAC,EAAE,SAAS,YAAY,EAAE,CAAC;IAClC,8EAA8E;IAC9E,qCAAqC,CAAC,EAAE,OAAO,CAAC;CACjD;AA+ID;;;;GAIG;AACH,wBAAgB,2BAA2B,CACzC,KAAK,EAAE,uBAAuB,GAC7B,aAAa,CAkJf;AAyDD,wBAAgB,0BAA0B,CAAC,IAAI,EAAE,aAAa,GAAG,MAAM,CAsCtE;AAED,MAAM,MAAM,mBAAmB,GAAG,QAAQ,GAAG,SAAS,CAAC;AAEvD,MAAM,WAAW,2BAA2B;IAC1C;gEAC4D;IAC5D,MAAM,CAAC,EAAE,mBAAmB,CAAC;IAC7B;oCACgC;IAChC,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,oBAAoB;IACnC,YAAY,EAAE,MAAM,CAAC;IACrB,6EAA6E;IAC7E,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,uDAAuD;IACvD,OAAO,EAAE,OAAO,CAAC;IACjB,gCAAgC;IAChC,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,0BAA0B;IACzC,IAAI,EAAE,MAAM,CAAC;IACb,OAAO,EAAE,oBAAoB,EAAE,CAAC;IAChC,MAAM,EAAE,mBAAmB,CAAC;CAC7B;AAED;;;;;;;;;GASG;AACH,wBAAgB,2BAA2B,CACzC,IAAI,EAAE,aAAa,EACnB,OAAO,GAAE,2BAAgC,GACxC,0BAA0B,CAqE5B;AAED,4DAA4D;AAC5D,wBAAgB,mBAAmB,CAAC,IAAI,EAAE,aAAa,GAAG,MAAM,CAE/D;AA+GD,MAAM,WAAW,wBAAwB;IACvC,WAAW,EAAE,MAAM,CAAC;IACpB,IAAI,EAAE,aAAa,CAAC;IACpB,sCAAsC;IACtC,MAAM,CAAC,EAAE,mBAAmB,CAAC;IAC7B;;kFAE8E;IAC9E,cAAc,CAAC,EAAE,OAAO,CAAC;IACzB;6CACyC;IACzC,gBAAgB,CAAC,EAAE,OAAO,CAAC;CAC5B;AAED,MAAM,WAAW,yBAAyB;IACxC,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,KAAK,CAAC;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,KAAK,EAAE,MAAM,CAAA;KAAE,CAAC,CAAC;IAC9C,MAAM,EAAE,mBAAmB,CAAC;IAC5B,6EAA6E;IAC7E,OAAO,EAAE,oBAAoB,EAAE,CAAC;IAChC,iDAAiD;IACjD,SAAS,EAAE,MAAM,CAAC;IAClB,4EAA4E;IAC5E,QAAQ,EAAE,SAAS,MAAM,EAAE,CAAC;IAC5B,sEAAsE;IACtE,QAAQ,EAAE,OAAO,CAAC;CACnB;AAED,wBAAgB,kBAAkB,CAChC,KAAK,EAAE,wBAAwB,GAC9B,yBAAyB,CAoE3B;AA4FD;;kEAEkE;AAClE,wBAAgB,oBAAoB,CAClC,WAAW,EAAE,MAAM,EACnB,OAAO,EAAE,SAAS,oBAAoB,EAAE,GACvC;IAAE,OAAO,EAAE,SAAS,oBAAoB,EAAE,CAAC;IAAC,EAAE,EAAE,SAAS,oBAAoB,EAAE,CAAA;CAAE,CAmBnF"}