Merge pull request #2553 from dyoshikawa/resolve-scrap-issue-2487-committed-check-outputs

feat(gitignore): do not ignore check outputs the upstream reads from the committed repo

Author: dyoshikawa

.gitignore

@@ -406,8 +406,6 @@ rulesync.local.jsonc
 **/.vibeignore
 **/.warpindexingignore
 **/.agents/checks/
-**/.cursor/BUGBOT.md
 **/.hermes/plugins/rulesync-checks/checks/
-**/.rovodev/.review-agent.md
 !.rulesync/.aiignore
 # End of Rulesync

docs/reference/file-formats.md

@@ -527,7 +527,7 @@ Amp, Cursor, Hermes Agent, Rovo Dev CLI and Takt consume checks. Amp receives on
 - **Project scope:** `.agents/checks/<name>.md`
 - **Global scope** (`--global`): `~/.config/amp/checks/<name>.md`
 
-For Cursor, checks are [Bugbot](https://cursor.com/docs/bugbot) code review instructions, and Bugbot reads one aggregated instruction file per directory rather than a file per check — so every check targeting Cursor collapses into the repository-root `.cursor/BUGBOT.md`. Each check becomes one section: an HTML-comment marker carrying the check name, an `## <name>` heading, and the check body as the instruction text (the `description` is used when the body is empty). Bugbot reads the file as free prose, so a check's `severity` and `tools` have no equivalent there — they are not written and do not come back on import, and neither is `description` whenever the check also has a body. Project scope only: Bugbot reads repository files and there is no user-level instruction file. Example output:
+For Cursor, checks are [Bugbot](https://cursor.com/docs/bugbot) code review instructions, and Bugbot reads one aggregated instruction file per directory rather than a file per check — so every check targeting Cursor collapses into the repository-root `.cursor/BUGBOT.md`. Each check becomes one section: an HTML-comment marker carrying the check name, an `## <name>` heading, and the check body as the instruction text (the `description` is used when the body is empty). Bugbot reads the file as free prose, so a check's `severity` and `tools` have no equivalent there — they are not written and do not come back on import, and neither is `description` whenever the check also has a body. Project scope only: Bugbot reads repository files and there is no user-level instruction file. Because Bugbot only sees the file when it is **committed**, the derived `.gitignore` deliberately does not ignore `.cursor/BUGBOT.md` (Rovo Dev's `.rovodev/.review-agent.md` gets the same treatment) — commit the generated file for the reviewer to pick it up. Example output:
 
 ```md
 <!-- rulesync:check:security -->

src/cli/commands/gitignore-derive.ts

@@ -40,6 +40,12 @@ const fileToGlob = (relativeDirPath: string | undefined, relativeFilePath: strin
   return `**/${toPosix(hasDir ? `${relativeDirPath}/${relativeFilePath}` : relativeFilePath)}`;
 };
 
+const isCommittedOutput = (factory: unknown): boolean => {
+  if (typeof factory !== "object" || factory === null || !("meta" in factory)) return false;
+  const meta = (factory as { meta?: { committedOutput?: boolean } }).meta;
+  return meta?.committedOutput === true;
+};
+
 const supportsProject = (factory: unknown): boolean => {
   if (typeof factory !== "object" || factory === null || !("meta" in factory)) return true;
   const meta = (factory as { meta?: { supportsProject?: boolean } }).meta;
@@ -67,6 +73,10 @@ const deriveDirEntries = (factories: FactoryMap, feature: Feature): GitignoreEnt
   for (const [target, factory] of factories) {
     if (TARGETS_NOT_DERIVED.has(target)) continue;
     if (!supportsProject(factory)) continue;
+    // Outputs the upstream tool reads from the committed repository (Cursor
+    // Bugbot's BUGBOT.md, Rovo Dev's .review-agent.md) must not be gitignored:
+    // ignoring them would disable the very feature the adapter generates.
+    if (isCommittedOutput(factory)) continue;
     const paths = getProjectPaths(factory) as {
       relativeDirPath?: string;
       relativeFilePath?: string;
@@ -91,6 +101,7 @@ const deriveFileEntries = (factories: FactoryMap, feature: Feature): GitignoreEn
   for (const [target, factory] of factories) {
     if (TARGETS_NOT_DERIVED.has(target)) continue;
     if (!supportsProject(factory)) continue;
+    if (isCommittedOutput(factory)) continue;
     const paths = getProjectPaths(factory) as {
       relativeDirPath?: string;
       relativeFilePath?: string;

src/cli/commands/gitignore-entries.test.ts

@@ -471,3 +471,22 @@ describe("filterGitignoreEntries", () => {
     });
   });
 });
+
+describe("committedOutput check outputs", () => {
+  it("never derives gitignore entries for outputs upstream reads from the committed repo", async () => {
+    const derive = await import("./gitignore-derive.js");
+    const entries = derive.deriveAllGitignoreEntries().map((tag) => tag.entry);
+    // Bugbot / Rovo Dev's reviewer only see these files when committed;
+    // ignoring them would disable the checks feature (#2487).
+    expect(entries).not.toContain("**/.cursor/BUGBOT.md");
+    expect(entries).not.toContain("**/.rovodev/.review-agent.md");
+  });
+
+  it("keeps the committedOutput flag meaningful (at least one checks factory sets it)", async () => {
+    const { toolCheckFactories } = await import("../../features/checks/checks-processor.js");
+    const flagged = [...toolCheckFactories.values()].filter(
+      (factory) => factory.meta.committedOutput === true,
+    );
+    expect(flagged.length).toBeGreaterThan(0);
+  });
+});

src/features/checks/checks-processor.ts

@@ -53,6 +53,15 @@ type ToolCheckFactory = {
     supportsGlobal: boolean;
     /** File pattern for import (e.g., "*.md") */
     filePattern: string;
+    /**
+     * Whether the upstream reviewer reads this output from the **committed**
+     * repository (Cursor Bugbot, Rovo Dev's code reviewer). The gitignore
+     * derivation skips such outputs — ignoring them would disable the very
+     * feature the adapter generates. Future checks adapters whose upstream
+     * reads from the committed tree (e.g. Goose `.agents/checks/`) should set
+     * this too.
+     */
+    committedOutput?: boolean;
   };
 };
 
@@ -87,7 +96,9 @@ export const toolCheckFactories = new Map<ChecksProcessorToolTarget, ToolCheckFa
       // check targeting Cursor collapses into the root `.cursor/BUGBOT.md`.
       // https://cursor.com/docs/bugbot
       class: CursorCheck,
-      meta: { supportsGlobal: false, filePattern: CURSOR_BUGBOT_FILE_NAME },
+      // `committedOutput`: Bugbot only sees BUGBOT.md when it is checked into
+      // the repository, so the derived .gitignore must not ignore it.
+      meta: { supportsGlobal: false, filePattern: CURSOR_BUGBOT_FILE_NAME, committedOutput: true },
     },
   ],
   [
@@ -104,7 +115,14 @@ export const toolCheckFactories = new Map<ChecksProcessorToolTarget, ToolCheckFa
       // every check targeting it collapses into `.rovodev/.review-agent.md`.
       // https://support.atlassian.com/rovo/docs/set-custom-instructions-for-code-reviews/
       class: RovodevCheck,
-      meta: { supportsGlobal: false, filePattern: ROVODEV_REVIEW_AGENT_FILE_NAME },
+      // `committedOutput`: Rovo Dev's code reviewer reads .review-agent.md
+      // from the committed repository, so the derived .gitignore must not
+      // ignore it.
+      meta: {
+        supportsGlobal: false,
+        filePattern: ROVODEV_REVIEW_AGENT_FILE_NAME,
+        committedOutput: true,
+      },
     },
   ],
   [