@webpieces/pr-gate 0.4.511 → 0.4.513

package/src/scripts/workflow/pr-context-writer.js

@@ -38,15 +38,28 @@ let PrContextWriter = class PrContextWriter {
      * *.sql / Dockerfile / .env* file a checklist most wants to key on). `includeDeletions` is on for the
      * same reason: a DELETED migration is exactly what a checklist wants to see.
      */
-    ensure(repoRoot, featureName, basis, diffDir = '') {
+    // eslint-disable-next-line @typescript-eslint/max-params
+    ensure(repoRoot, featureName, basis, stage, changedFiles, diffDir = '') {
         if (basis.unresolved)
             return new rules_config_1.ChecklistReviewContext();
+        // Reuse the caller's changed-file set when it has one. ChecklistScanner already computed exactly
+        // this list to do its matching, and recomputing it here was a second `git diff --name-only` per
+        // command for a list we were handed — and a second chance for the two to disagree.
+        const changed = changedFiles ?? this.changedFiles(repoRoot, basis);
+        const p = this.reviewJsonService.writePrContext(repoRoot, featureName, new rules_config_1.PrContext(basis.base, basis.headSha, [...changed], basis.dirty, basis.dirtyFiles, basis.diffCommand, diffDir, new Date().toISOString(), basis.hashMainHead), stage);
+        return new rules_config_1.ChecklistReviewContext(basis.base, p, basis.fileDiffCommand, diffDir, basis.dirty);
+    }
+    /** The context WITHOUT persisting it — for a caller that must write later (after materializing). */
+    contextFor(repoRoot, featureName, basis) {
+        if (basis.unresolved)
+            return new rules_config_1.ChecklistReviewContext();
+        return new rules_config_1.ChecklistReviewContext(basis.base, this.reviewJsonService.prContextPath(repoRoot, featureName), basis.fileDiffCommand, '', basis.dirty);
+    }
+    changedFiles(repoRoot, basis) {
         const opts = new rules_config_1.ChangedFilesOptions();
         opts.tsOnly = false;
         opts.includeDeletions = true;
-        const changed = this.diffScope.getChangedFiles(repoRoot, basis.base, undefined, opts);
-        const p = this.reviewJsonService.writePrContext(repoRoot, featureName, new rules_config_1.PrContext(basis.base, basis.headSha, changed, basis.dirty, basis.dirtyFiles, basis.diffCommand, diffDir, new Date().toISOString()));
-        return new rules_config_1.ChecklistReviewContext(basis.base, p, basis.fileDiffCommand, diffDir, basis.dirty);
+        return this.diffScope.getChangedFiles(repoRoot, basis.base, undefined, opts);
     }
 };
 exports.PrContextWriter = PrContextWriter;

package/src/scripts/workflow/pr-context-writer.js.map

@@ -1 +1 @@
-{"version":3,"file":"pr-context-writer.js","sourceRoot":"","sources":["../../../../../../../packages/tooling/pr-gate/src/scripts/workflow/pr-context-writer.ts"],"names":[],"mappings":";;;;AAAA,0DAEiC;AACjC,yCAA2D;AAG3D;;;;;;;;;;;GAWG;AAEI,IAAM,eAAe,GAArB,MAAM,eAAe;IAEH;IACA;IAFrB,YACqB,SAAoB,EACpB,iBAAoC;QADpC,cAAS,GAAT,SAAS,CAAW;QACpB,sBAAiB,GAAjB,iBAAiB,CAAmB;IACtD,CAAC;IAEJ;;;;;;;;;;;;;;OAcG;IACH,MAAM,CAAC,QAAgB,EAAE,WAAmB,EAAE,KAAgB,EAAE,OAAO,GAAG,EAAE;QACxE,IAAI,KAAK,CAAC,UAAU;YAAE,OAAO,IAAI,qCAAsB,EAAE,CAAC;QAC1D,MAAM,IAAI,GAAG,IAAI,kCAAmB,EAAE,CAAC;QACvC,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACpB,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC;QAC7B,MAAM,OAAO,GAAG,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,QAAQ,EAAE,KAAK,CAAC,IAAI,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;QACtF,MAAM,CAAC,GAAG,IAAI,CAAC,iBAAiB,CAAC,cAAc,CAAC,QAAQ,EAAE,WAAW,EAAE,IAAI,wBAAS,CAChF,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,OAAO,EAAE,OAAO,EAClC,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,UAAU,EAAE,KAAK,CAAC,WAAW,EAAE,OAAO,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,CACtF,CAAC,CAAC;QACH,OAAO,IAAI,qCAAsB,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,EAAE,KAAK,CAAC,eAAe,EAAE,OAAO,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;IAClG,CAAC;CACJ,CAAA;AAjCY,0CAAe;0BAAf,eAAe;IAD3B,IAAA,sBAAU,EAAC,8BAAkB,CAAC,SAAS,CAAC;6CAGL,wBAAS;QACD,gCAAiB;GAHhD,eAAe,CAiC3B","sourcesContent":["import {\n    ChangedFilesOptions, ChecklistReviewContext, DiffScope, PrContext, ReviewJsonService,\n} from '@webpieces/rules-config';\nimport { injectable, bindingScopeValues } from 'inversify';\nimport { DiffBasis } from './diff-basis';\n\n/**\n * Writes `pr-context.json` (the 3-point base/head sha + the FULL changed-file set) and returns the context\n * every printed review instruction inlines.\n *\n * Extracted so `wp-start-upsert-pr` and `wp-review-upsert-pr` cannot diverge. It used to live only in wp-start,\n * which meant `wp-review-upsert-pr` — the command wp-start tells the AI to run FIRST — silently rendered its\n * reviewer blocks with NO `git diff` command and NO full-file-set path whenever wp-start had not run this\n * cycle. A reviewer handed filenames and no way to read the diff is exactly the failure this instruction\n * exists to prevent, and it failed silently, which is worse.\n *\n * `@injectable(bindingScopeValues.Singleton)` so it is injected by type and drawn in the DI design.\n */\n@injectable(bindingScopeValues.Singleton)\nexport class PrContextWriter {\n    constructor(\n        private readonly diffScope: DiffScope,\n        private readonly reviewJsonService: ReviewJsonService,\n    ) {}\n\n    /**\n     * Compute + persist the context against the {@link DiffBasis} the CALLER already resolved, so the range\n     * a reviewer is told to diff is byte-identical to the one the pattern matching used. Returns an EMPTY\n     * context when the basis has no fork point — callers must say so out loud rather than quietly omit the\n     * lines it would have filled; see ChecklistInstructionsService.diffLines.\n     *\n     * Taking a DiffBasis rather than a bare `forkPoint: string` is the fix, not a refactor: with a lone sha\n     * this method had no way to know whether the tree was dirty, so it recorded `head:'HEAD'` and every\n     * downstream reader assembled a commit-to-commit command that shows nothing when work is uncommitted.\n     *\n     * Two things mirror ChecklistScanner deliberately: no head argument to `getChangedFiles` (so the working\n     * tree and untracked files are included, not just commits), and `tsOnly:false` (the default drops every\n     * *.sql / Dockerfile / .env* file a checklist most wants to key on). `includeDeletions` is on for the\n     * same reason: a DELETED migration is exactly what a checklist wants to see.\n     */\n    ensure(repoRoot: string, featureName: string, basis: DiffBasis, diffDir = ''): ChecklistReviewContext {\n        if (basis.unresolved) return new ChecklistReviewContext();\n        const opts = new ChangedFilesOptions();\n        opts.tsOnly = false;\n        opts.includeDeletions = true;\n        const changed = this.diffScope.getChangedFiles(repoRoot, basis.base, undefined, opts);\n        const p = this.reviewJsonService.writePrContext(repoRoot, featureName, new PrContext(\n            basis.base, basis.headSha, changed,\n            basis.dirty, basis.dirtyFiles, basis.diffCommand, diffDir, new Date().toISOString(),\n        ));\n        return new ChecklistReviewContext(basis.base, p, basis.fileDiffCommand, diffDir, basis.dirty);\n    }\n}\n"]}
+{"version":3,"file":"pr-context-writer.js","sourceRoot":"","sources":["../../../../../../../packages/tooling/pr-gate/src/scripts/workflow/pr-context-writer.ts"],"names":[],"mappings":";;;;AAAA,0DAEiC;AACjC,yCAA2D;AAG3D;;;;;;;;;;;GAWG;AAEI,IAAM,eAAe,GAArB,MAAM,eAAe;IAEH;IACA;IAFrB,YACqB,SAAoB,EACpB,iBAAoC;QADpC,cAAS,GAAT,SAAS,CAAW;QACpB,sBAAiB,GAAjB,iBAAiB,CAAmB;IACtD,CAAC;IAEJ;;;;;;;;;;;;;;OAcG;IACH,yDAAyD;IACzD,MAAM,CAAC,QAAgB,EAAE,WAAmB,EAAE,KAAgB,EAAE,KAAa,EAAE,YAAgC,EAAE,OAAO,GAAG,EAAE;QACzH,IAAI,KAAK,CAAC,UAAU;YAAE,OAAO,IAAI,qCAAsB,EAAE,CAAC;QAC1D,iGAAiG;QACjG,gGAAgG;QAChG,mFAAmF;QACnF,MAAM,OAAO,GAAG,YAAY,IAAI,IAAI,CAAC,YAAY,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;QACnE,MAAM,CAAC,GAAG,IAAI,CAAC,iBAAiB,CAAC,cAAc,CAAC,QAAQ,EAAE,WAAW,EAAE,IAAI,wBAAS,CAChF,KAAK,CAAC,IAAI,EAAE,KAAK,CAAC,OAAO,EAAE,CAAC,GAAG,OAAO,CAAC,EACvC,KAAK,CAAC,KAAK,EAAE,KAAK,CAAC,UAAU,EAAE,KAAK,CAAC,WAAW,EAAE,OAAO,EAAE,IAAI,IAAI,EAAE,CAAC,WAAW,EAAE,EACnF,KAAK,CAAC,YAAY,CACrB,EAAE,KAAK,CAAC,CAAC;QACV,OAAO,IAAI,qCAAsB,CAAC,KAAK,CAAC,IAAI,EAAE,CAAC,EAAE,KAAK,CAAC,eAAe,EAAE,OAAO,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;IAClG,CAAC;IAED,oGAAoG;IACpG,UAAU,CAAC,QAAgB,EAAE,WAAmB,EAAE,KAAgB;QAC9D,IAAI,KAAK,CAAC,UAAU;YAAE,OAAO,IAAI,qCAAsB,EAAE,CAAC;QAC1D,OAAO,IAAI,qCAAsB,CAC7B,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,iBAAiB,CAAC,aAAa,CAAC,QAAQ,EAAE,WAAW,CAAC,EACvE,KAAK,CAAC,eAAe,EAAE,EAAE,EAAE,KAAK,CAAC,KAAK,CAAC,CAAC;IAChD,CAAC;IAEO,YAAY,CAAC,QAAgB,EAAE,KAAgB;QACnD,MAAM,IAAI,GAAG,IAAI,kCAAmB,EAAE,CAAC;QACvC,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC;QACpB,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC;QAC7B,OAAO,IAAI,CAAC,SAAS,CAAC,eAAe,CAAC,QAAQ,EAAE,KAAK,CAAC,IAAI,EAAE,SAAS,EAAE,IAAI,CAAC,CAAC;IACjF,CAAC;CACJ,CAAA;AAlDY,0CAAe;0BAAf,eAAe;IAD3B,IAAA,sBAAU,EAAC,8BAAkB,CAAC,SAAS,CAAC;6CAGL,wBAAS;QACD,gCAAiB;GAHhD,eAAe,CAkD3B","sourcesContent":["import {\n    ChangedFilesOptions, ChecklistReviewContext, DiffScope, PrContext, ReviewJsonService,\n} from '@webpieces/rules-config';\nimport { injectable, bindingScopeValues } from 'inversify';\nimport { DiffBasis } from './diff-basis';\n\n/**\n * Writes `pr-context.json` (the 3-point base/head sha + the FULL changed-file set) and returns the context\n * every printed review instruction inlines.\n *\n * Extracted so `wp-start-upsert-pr` and `wp-review-upsert-pr` cannot diverge. It used to live only in wp-start,\n * which meant `wp-review-upsert-pr` — the command wp-start tells the AI to run FIRST — silently rendered its\n * reviewer blocks with NO `git diff` command and NO full-file-set path whenever wp-start had not run this\n * cycle. A reviewer handed filenames and no way to read the diff is exactly the failure this instruction\n * exists to prevent, and it failed silently, which is worse.\n *\n * `@injectable(bindingScopeValues.Singleton)` so it is injected by type and drawn in the DI design.\n */\n@injectable(bindingScopeValues.Singleton)\nexport class PrContextWriter {\n    constructor(\n        private readonly diffScope: DiffScope,\n        private readonly reviewJsonService: ReviewJsonService,\n    ) {}\n\n    /**\n     * Compute + persist the context against the {@link DiffBasis} the CALLER already resolved, so the range\n     * a reviewer is told to diff is byte-identical to the one the pattern matching used. Returns an EMPTY\n     * context when the basis has no fork point — callers must say so out loud rather than quietly omit the\n     * lines it would have filled; see ChecklistInstructionsService.diffLines.\n     *\n     * Taking a DiffBasis rather than a bare `forkPoint: string` is the fix, not a refactor: with a lone sha\n     * this method had no way to know whether the tree was dirty, so it recorded `head:'HEAD'` and every\n     * downstream reader assembled a commit-to-commit command that shows nothing when work is uncommitted.\n     *\n     * Two things mirror ChecklistScanner deliberately: no head argument to `getChangedFiles` (so the working\n     * tree and untracked files are included, not just commits), and `tsOnly:false` (the default drops every\n     * *.sql / Dockerfile / .env* file a checklist most wants to key on). `includeDeletions` is on for the\n     * same reason: a DELETED migration is exactly what a checklist wants to see.\n     */\n    // eslint-disable-next-line @typescript-eslint/max-params\n    ensure(repoRoot: string, featureName: string, basis: DiffBasis, stage: string, changedFiles?: readonly string[], diffDir = ''): ChecklistReviewContext {\n        if (basis.unresolved) return new ChecklistReviewContext();\n        // Reuse the caller's changed-file set when it has one. ChecklistScanner already computed exactly\n        // this list to do its matching, and recomputing it here was a second `git diff --name-only` per\n        // command for a list we were handed — and a second chance for the two to disagree.\n        const changed = changedFiles ?? this.changedFiles(repoRoot, basis);\n        const p = this.reviewJsonService.writePrContext(repoRoot, featureName, new PrContext(\n            basis.base, basis.headSha, [...changed],\n            basis.dirty, basis.dirtyFiles, basis.diffCommand, diffDir, new Date().toISOString(),\n            basis.hashMainHead,\n        ), stage);\n        return new ChecklistReviewContext(basis.base, p, basis.fileDiffCommand, diffDir, basis.dirty);\n    }\n\n    /** The context WITHOUT persisting it — for a caller that must write later (after materializing). */\n    contextFor(repoRoot: string, featureName: string, basis: DiffBasis): ChecklistReviewContext {\n        if (basis.unresolved) return new ChecklistReviewContext();\n        return new ChecklistReviewContext(\n            basis.base, this.reviewJsonService.prContextPath(repoRoot, featureName),\n            basis.fileDiffCommand, '', basis.dirty);\n    }\n\n    private changedFiles(repoRoot: string, basis: DiffBasis): string[] {\n        const opts = new ChangedFilesOptions();\n        opts.tsOnly = false;\n        opts.includeDeletions = true;\n        return this.diffScope.getChangedFiles(repoRoot, basis.base, undefined, opts);\n    }\n}\n"]}