@dxos/plugin-github 0.7.4 → 0.13.0

package/dist/types/src/walkthrough/plan.d.ts

@@ -0,0 +1,55 @@
+import { type PatchFile } from './patch.ts';
+/**
+ * Two-stage generation for a pull request whose diff does not fit one prompt.
+ *
+ * One-shot generation over a trimmed diff fails in a specific way on a large change: the model
+ * writes the first two sections in full, then runs out of room and leaves the rest to the appended
+ * `## Also changed` section — so the bigger the pull request, the less of it the walkthrough
+ * actually covers. Here a planner sees only the file list and decides the chapters, then each
+ * chapter is narrated against its own files, and the chapters are concatenated.
+ */
+/** A chapter the planner assigned files to. */
+export type Chapter = {
+    title: string;
+    /** Paths from the file list, exactly as given. */
+    files: string[];
+    /** Why this chapter exists, handed to the chapter writer as its brief. */
+    summary?: string;
+};
+export type Plan = {
+    /** The H1 for the whole document. */
+    title: string;
+    /** Two or three sentences opening the document, before the first chapter. */
+    overview: string;
+    chapters: Chapter[];
+};
+/**
+ * Diffs longer than this get the two-stage treatment.
+ *
+ * Twice the one-shot budget: below that, trimming drops a file or two and the single prompt still
+ * sees the shape of the change, and a second model call would buy nothing.
+ */
+export declare const DEFAULT_CHAPTER_THRESHOLD_CHARS = 32000;
+export declare const PLANNER_SYSTEM_PROMPT: string;
+/** The file list the planner sees: path, size of change, and nothing else. */
+export declare const buildPlannerPrompt: (facts: {
+    owner: string;
+    repo: string;
+    number: number;
+    title: string;
+    description?: string;
+}, diff: string) => string;
+/**
+ * Reads the planner's answer.
+ *
+ * Tolerant of a fenced block or surrounding prose, because a refusal to parse costs the whole run
+ * and the recovery — falling back to one-shot — is worse than reading a fence.
+ */
+export declare const parsePlan: (response: string, paths: readonly string[]) => Plan | undefined;
+/** The diff of one chapter's files, in patch order. */
+export declare const chapterDiff: (files: readonly PatchFile[], chapter: Chapter) => string;
+export declare const CHAPTER_SYSTEM_PROMPT: string;
+export declare const buildChapterPrompt: (plan: Plan, chapter: Chapter, diff: string) => string;
+/** Stitches the planner's opening and the chapter bodies into one document. */
+export declare const assembleWalkthrough: (plan: Plan, chapters: string[]) => string;
+//# sourceMappingURL=plan.d.ts.map

package/dist/types/src/walkthrough/plan.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"plan.d.ts","sourceRoot":"","sources":["../../../../src/walkthrough/plan.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,KAAK,SAAS,EAAc,MAAM,YAAY,CAAC;AAExD;;;;;;;;GAQG;AAEH,+CAA+C;AAC/C,MAAM,MAAM,OAAO,GAAG;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,kDAAkD;IAClD,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,0EAA0E;IAC1E,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB,CAAC;AAEF,MAAM,MAAM,IAAI,GAAG;IACjB,qCAAqC;IACrC,KAAK,EAAE,MAAM,CAAC;IACd,6EAA6E;IAC7E,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,OAAO,EAAE,CAAC;CACrB,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,+BAA+B,QAAS,CAAC;AAEtD,eAAO,MAAM,qBAAqB,QAsBtB,CAAC;AAEb,8EAA8E;AAC9E,eAAO,MAAM,kBAAkB,UACtB;IAAE,KAAK,EAAE,MAAM,CAAC;IAAC,IAAI,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,MAAM,CAAC;IAAC,KAAK,EAAE,MAAM,CAAC;IAAC,WAAW,CAAC,EAAE,MAAM,CAAA;CAAE,QACrF,MAAM,KACX,MAYF,CAAC;AAEF;;;;;GAKG;AACH,eAAO,MAAM,SAAS,aAAc,MAAM,SAAS,SAAS,MAAM,EAAE,KAAG,IAAI,GAAG,SAiD7E,CAAC;AAwCF,uDAAuD;AACvD,eAAO,MAAM,WAAW,UAAW,SAAS,SAAS,EAAE,WAAW,OAAO,KAAG,MAM3E,CAAC;AAEF,eAAO,MAAM,qBAAqB,QAgCtB,CAAC;AAEb,eAAO,MAAM,kBAAkB,SAAU,IAAI,WAAW,OAAO,QAAQ,MAAM,KAAG,MAkBjE,CAAC;AAEhB,+EAA+E;AAC/E,eAAO,MAAM,mBAAmB,SAAU,IAAI,YAAY,MAAM,EAAE,KAAG,MAMjD,CAAC"}

package/dist/types/src/walkthrough/plan.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=plan.test.d.ts.map

package/dist/types/src/walkthrough/plan.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"plan.test.d.ts","sourceRoot":"","sources":["../../../../src/walkthrough/plan.test.ts"],"names":[],"mappings":""}

package/dist/types/src/walkthrough/prompt.d.ts

@@ -0,0 +1,33 @@
+/** What the model is told about the change. */
+export type WalkthroughInput = {
+    owner: string;
+    repo: string;
+    number: number;
+    title: string;
+    description?: string;
+    baseBranch?: string;
+    headBranch?: string;
+    /** The whole unified diff, as git wrote it. */
+    diff: string;
+};
+export type PromptOptions = {
+    /**
+     * Character budget for the diff. Files are dropped smallest-budget-first when it is exceeded;
+     * anything dropped still reaches the reader, because the postprocess appends every hunk the prose
+     * does not claim.
+     */
+    maxDiffChars?: number;
+};
+/**
+ * What the model is for: the ORDER and the REASONS, never the diff content.
+ *
+ * Every chunk is emitted as an empty fence carrying a path and a line range, which a postprocess
+ * fills from the patch itself. A model asked to transcribe a diff gets lines subtly wrong, and a
+ * review artefact that misquotes the change is worse than no artefact.
+ */
+export declare const SYSTEM_PROMPT: string;
+/** The user-side content: what the change is, followed by the diff the fences will be filled from. */
+export declare const buildPrompt: (input: WalkthroughInput, options?: PromptOptions) => string;
+/** Chunks the model cannot have claimed, because the diff never showed them. */
+export declare const promptOmissions: (input: WalkthroughInput, options?: PromptOptions) => string[];
+//# sourceMappingURL=prompt.d.ts.map

package/dist/types/src/walkthrough/prompt.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"prompt.d.ts","sourceRoot":"","sources":["../../../../src/walkthrough/prompt.ts"],"names":[],"mappings":"AAOA,+CAA+C;AAC/C,MAAM,MAAM,gBAAgB,GAAG;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,UAAU,CAAC,EAAE,MAAM,CAAC;IACpB,+CAA+C;IAC/C,IAAI,EAAE,MAAM,CAAC;CACd,CAAC;AAEF,MAAM,MAAM,aAAa,GAAG;IAC1B;;;;OAIG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;CACvB,CAAC;AAaF;;;;;;GAMG;AACH,eAAO,MAAM,aAAa,QAwCd,CAAC;AAuCb,sGAAsG;AACtG,eAAO,MAAM,WAAW,UAAW,gBAAgB,YAAW,aAAa,KAAQ,MAelF,CAAC;AAEF,gFAAgF;AAChF,eAAO,MAAM,eAAe,UAAW,gBAAgB,YAAW,aAAa,KAAQ,MAAM,EACb,CAAC"}

package/dist/types/src/walkthrough/prompt.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=prompt.test.d.ts.map

package/dist/types/src/walkthrough/prompt.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"prompt.test.d.ts","sourceRoot":"","sources":["../../../../src/walkthrough/prompt.test.ts"],"names":[],"mappings":""}

package/dist/types/src/walkthrough/score.d.ts

@@ -0,0 +1,43 @@
+/**
+ * One graded dimension.
+ *
+ * `evidence` carries the offending excerpts rather than a count alone, because a score a human
+ * cannot attribute to a line is a number nobody acts on.
+ */
+export type Dimension = {
+    name: string;
+    /** Clamped to [0, 1]; 1 is the behaviour the prompt asks for. */
+    score: number;
+    /** What the score was computed over, so a 0.9 on a two-sentence body is not read as a pass. */
+    sampled: number;
+    evidence: string[];
+};
+export type WalkthroughScore = {
+    correctness: Dimension[];
+    readability: Dimension[];
+};
+/** Words that mark generated prose rather than writing; see `.agents/skills/readable-prose`. */
+export declare const SLOP_WORDS: string[];
+/** Fancy ways to say "is" or "has", which cost a reader a beat and say nothing. */
+export declare const SLOP_PHRASES: string[];
+/** Body with every fenced block removed, so prose metrics never grade the diff itself. */
+/**
+ * The document without its appendix.
+ *
+ * `fillWalkthrough` appends every unclaimed hunk under `## Also changed`, so a stored walkthrough
+ * contains a fence for every hunk in the patch. Counting those would score full coverage for a
+ * document that described nothing.
+ */
+export declare const withoutAppendix: (body: string) => string;
+export declare const proseOf: (body: string) => string;
+/**
+ * Grades a walkthrough against the patch it describes.
+ *
+ * Deterministic on purpose: these are the checks that need no model, run on every generation, and
+ * bound what an LLM judge is then asked (see `docs/WALKTHROUGH-EVALS.md`). Correctness dimensions
+ * ask whether the document lies; readability dimensions ask what it costs to read.
+ */
+export declare const scoreWalkthrough: (body: string, patch: string) => WalkthroughScore;
+/** Mean of a set of dimensions, which is what an eval reports as the row's mark. */
+export declare const meanScore: (dimensions: Dimension[]) => number;
+//# sourceMappingURL=score.d.ts.map

package/dist/types/src/walkthrough/score.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"score.d.ts","sourceRoot":"","sources":["../../../../src/walkthrough/score.ts"],"names":[],"mappings":"AAOA;;;;;GAKG;AACH,MAAM,MAAM,SAAS,GAAG;IACtB,IAAI,EAAE,MAAM,CAAC;IACb,iEAAiE;IACjE,KAAK,EAAE,MAAM,CAAC;IACd,+FAA+F;IAC/F,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,EAAE,MAAM,EAAE,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,WAAW,EAAE,SAAS,EAAE,CAAC;IACzB,WAAW,EAAE,SAAS,EAAE,CAAC;CAC1B,CAAC;AAEF,gGAAgG;AAChG,eAAO,MAAM,UAAU,UAqBtB,CAAC;AAEF,mFAAmF;AACnF,eAAO,MAAM,YAAY,UAUxB,CAAC;AAaF,0FAA0F;AAC1F;;;;;;GAMG;AACH,eAAO,MAAM,eAAe,SAAU,MAAM,KAAG,MAAgD,CAAC;AAShG,eAAO,MAAM,OAAO,SAAU,MAAM,KAAG,MAA0D,CAAC;AAkKlG;;;;;;GAMG;AACH,eAAO,MAAM,gBAAgB,SAAU,MAAM,SAAS,MAAM,KAAG,gBAoK9D,CAAC;AAEF,oFAAoF;AACpF,eAAO,MAAM,SAAS,eAAgB,SAAS,EAAE,KAAG,MACmE,CAAC"}

package/dist/types/src/walkthrough/score.test.d.ts

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=score.test.d.ts.map

package/dist/types/src/walkthrough/score.test.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"score.test.d.ts","sourceRoot":"","sources":["../../../../src/walkthrough/score.test.ts"],"names":[],"mappings":""}