Skip to content

Revert "feat: allow users to add their own review style prompts" #115

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
amonkhouse merged 1 commit into from
Aug 7, 2026
Merged

Revert "feat: allow users to add their own review style prompts" #115

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 0 additions & 2 deletions .github/workflows/claude-review.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -196,8 +196,6 @@ jobs:
- name: Build review prompt
id: prompt
run: npx ts-node .tooling/scripts/build-review-prompt.ts
env:
PR_AUTHOR: ${{ github.event.pull_request.user.login }}

- name: Cleanup previous AI review comments
uses: actions/github-script@v7
Expand Down
6 changes: 0 additions & 6 deletions docs/actions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -304,12 +304,6 @@ prompt: |
Ignore style and formatting issues entirely.
```

**Personal Review Styles:**

Individuals can customize the *tone* of reviews on their own PRs, across every
repo that uses this workflow, without touching any repo's `.claude-review.yml`.
See `review-styles/README.md` for setup and details.

**Security Notes:**

- Requires approval for external contributors to prevent prompt injection
Expand Down
54 changes: 0 additions & 54 deletions review-styles/README.md
View file
Open in desktop

This file was deleted.

5 changes: 0 additions & 5 deletions review-styles/amonkhouse.md
View file
Open in desktop

This file was deleted.

224 changes: 0 additions & 224 deletions scripts/build-review-prompt.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,14 +1,8 @@
import * as fs from "fs"
import {
assemblePrompt,
buildPrompt,
DEFAULT_PROMPT,
HOW_TO_WRITE,
loadPersonalStyle,
loadRepoConfig,
PROMPT_CLOSING,
PROMPT_HEADER,
parsePersonalStyle,
} from "./build-review-prompt"

jest.mock("fs")
Expand Down Expand Up @@ -110,7 +104,6 @@ prompt: |
describe("buildPrompt", () => {
beforeEach(() => {
jest.clearAllMocks()
delete process.env.PR_AUTHOR
})

it("returns default prompt when no config exists", () => {
Expand Down Expand Up @@ -185,223 +178,6 @@ ignore_paths:
expect(result).toContain("## Files to Skip")
expect(result).toContain("- **/*.generated.ts")
})

it("applies the PR author's personal style when PR_AUTHOR is set", () => {
process.env.PR_AUTHOR = "Amonkhouse"
mockFs.existsSync.mockImplementation(
p => typeof p === "string" && p.endsWith("amonkhouse.md")
)
mockFs.readFileSync.mockImplementation(p => {
if (typeof p === "string" && p.endsWith("amonkhouse.md")) {
return "Be blunt and terse."
}
throw new Error(`unexpected read: ${String(p)}`)
})

const result = buildPrompt()

expect(result).toContain("## Reviewer Style Preferences (amonkhouse)")
expect(result).toContain("Be blunt and terse.")
expect(result).toContain("### Summary") // default prompt structure retained
})

it("ignores personal style when no PR_AUTHOR is set", () => {
mockFs.existsSync.mockReturnValue(false)

const result = buildPrompt()

expect(result).not.toContain("Reviewer Style Preferences")
expect(result).toBe(DEFAULT_PROMPT)
})

it("repo-level prompt override still beats a personal style", () => {
process.env.PR_AUTHOR = "amonkhouse"
mockFs.existsSync.mockReturnValue(true)
mockFs.readFileSync.mockImplementation(p => {
if (typeof p === "string" && p.endsWith(".claude-review.yml")) {
return `
prompt: |
You are a custom security reviewer.
`
}
return "Be blunt and terse."
})

const result = buildPrompt()

expect(result).toContain("You are a custom security reviewer.")
expect(result).not.toContain("Reviewer Style Preferences")
})
})

describe("parsePersonalStyle", () => {
it("defaults to augment mode with no frontmatter", () => {
const result = parsePersonalStyle("amonkhouse", "Be blunt and terse.")

expect(result).toEqual({
login: "amonkhouse",
mode: "augment",
content: "Be blunt and terse.",
})
})

it("reads mode from frontmatter", () => {
const result = parsePersonalStyle(
"amonkhouse",
"---\nmode: replace_style\n---\nBe blunt and terse.\n"
)

expect(result.mode).toBe("replace_style")
expect(result.content).toBe("Be blunt and terse.")
})

it("falls back to augment and warns on an unknown mode", () => {
const consoleSpy = jest.spyOn(console, "error").mockImplementation()

const result = parsePersonalStyle(
"amonkhouse",
"---\nmode: nonsense\n---\nBe blunt and terse.\n"
)

expect(result.mode).toBe("augment")
expect(consoleSpy).toHaveBeenCalledWith(
expect.stringContaining("Unknown mode")
)
consoleSpy.mockRestore()
})

it("falls back to augment and warns on malformed frontmatter", () => {
const consoleSpy = jest.spyOn(console, "error").mockImplementation()

const result = parsePersonalStyle(
"amonkhouse",
"---\nmode: [unterminated\n---\nBe blunt and terse.\n"
)

expect(result.mode).toBe("augment")
expect(consoleSpy).toHaveBeenCalled()
consoleSpy.mockRestore()
})

it("supports override mode", () => {
const result = parsePersonalStyle(
"amonkhouse",
"---\nmode: override\n---\nYou are a custom reviewer.\n"
)

expect(result.mode).toBe("override")
expect(result.content).toBe("You are a custom reviewer.")
})
})

describe("loadPersonalStyle", () => {
beforeEach(() => {
jest.clearAllMocks()
})

it("returns null when no author is given", () => {
expect(loadPersonalStyle(undefined)).toBeNull()
})

it("returns null when no style file exists for the author", () => {
mockFs.existsSync.mockReturnValue(false)

expect(loadPersonalStyle("amonkhouse")).toBeNull()
})

it("lowercases the login when resolving the file path", () => {
mockFs.existsSync.mockImplementation(
p => typeof p === "string" && p.endsWith("review-styles/amonkhouse.md")
)
mockFs.readFileSync.mockReturnValue("Be blunt and terse.")

const result = loadPersonalStyle("AmonKHouse")

expect(result?.login).toBe("amonkhouse")
expect(result?.content).toBe("Be blunt and terse.")
})

it("returns null and logs a warning on read error", () => {
const consoleSpy = jest.spyOn(console, "error").mockImplementation()
mockFs.existsSync.mockReturnValue(true)
mockFs.readFileSync.mockImplementation(() => {
throw new Error("Read error")
})

const result = loadPersonalStyle("amonkhouse")

expect(result).toBeNull()
expect(consoleSpy).toHaveBeenCalledWith(
expect.stringContaining("Failed to read review-styles/amonkhouse.md")
)
consoleSpy.mockRestore()
})
})

describe("assemblePrompt", () => {
it("returns the default prompt when there is no repo config or personal style", () => {
expect(assemblePrompt(null, null)).toBe(DEFAULT_PROMPT)
})

it("augment mode keeps the default prompt and appends a style section", () => {
const result = assemblePrompt(null, {
login: "amonkhouse",
mode: "augment",
content: "Be blunt and terse.",
})

expect(result).toContain(DEFAULT_PROMPT)
expect(result).toContain("## Reviewer Style Preferences (amonkhouse)")
expect(result).toContain("Be blunt and terse.")
expect(result).toContain("prefer these")
})

it("replace_style mode keeps guardrails and format but swaps the tone block", () => {
const result = assemblePrompt(null, {
login: "amonkhouse",
mode: "replace_style",
content: "Be blunt and terse.",
})

expect(result).toContain(PROMPT_HEADER)
expect(result).toContain(PROMPT_CLOSING)
expect(result).toContain("## How to write\nBe blunt and terse.")
expect(result).not.toContain(HOW_TO_WRITE)
expect(result).not.toContain("Reviewer Style Preferences")
})

it("override mode returns only the personal content", () => {
const result = assemblePrompt(
{ focus_areas: ["Watch for N+1 queries"] },
{
login: "amonkhouse",
mode: "override",
content: "You are a custom reviewer.",
}
)

expect(result).toBe("You are a custom reviewer.")
})

it("augment mode still applies repo focus areas and ignore paths", () => {
const result = assemblePrompt(
{
focus_areas: ["Watch for N+1 queries"],
ignore_paths: ["**/*.generated.ts"],
},
{ login: "amonkhouse", mode: "augment", content: "Be blunt and terse." }
)

expect(result).toContain("## Additional Focus Areas")
expect(result).toContain("- Watch for N+1 queries")
expect(result).toContain("## Files to Skip")
expect(result).toContain("- **/*.generated.ts")
expect(result).toContain("## Reviewer Style Preferences (amonkhouse)")
// Style preferences should come after repo customizations
expect(result.indexOf("## Files to Skip")).toBeLessThan(
result.indexOf("## Reviewer Style Preferences")
)
})
})

describe("DEFAULT_PROMPT", () => {
Expand Down
Loading
Loading