Skip to content

feat(codexcli): add PermissionRequest hook event #1566

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
dyoshikawa merged 2 commits into from
Apr 27, 2026
+94 −2
Merged

feat(codexcli): add PermissionRequest hook event #1566

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
602c3e1
feat(codexcli): add PermissionRequest hook event
saitota Apr 25, 2026
2971920
style(codexcli): apply oxfmt to hooks test
saitota Apr 25, 2026
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: 1 addition & 1 deletion docs/reference/file-formats.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ Events present in the shared `hooks` block but unsupported by a given tool are s
| `beforeTabFileRead` | ✅ | — | — | — | — | — | — | — | — |
| `afterTabFileEdit` | ✅ | — | — | — | — | — | — | — | — |
| `beforeToolSelection` | — | — | — | — | — | — | ✅ | — | — |
| `permissionRequest` | — | ✅ | ✅ | ✅ | — | ✅ | — | — | ✅ |
| `permissionRequest` | — | ✅ | ✅ | ✅ | — | ✅ | — | ✅ | ✅ |
| `notification` | — | ✅ | — | — | — | ✅ | ✅ | — | — |
| `setup` | — | ✅ | — | — | — | ✅ | — | — | — |
| `worktreeCreate` | — | ✅ | — | — | — | — | — | — | — |
Expand Down
2 changes: 1 addition & 1 deletion skills/rulesync/file-formats.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,7 +125,7 @@ Events present in the shared `hooks` block but unsupported by a given tool are s
| `beforeTabFileRead` | ✅ | — | — | — | — | — | — | — | — |
| `afterTabFileEdit` | ✅ | — | — | — | — | — | — | — | — |
| `beforeToolSelection` | — | — | — | — | — | — | ✅ | — | — |
| `permissionRequest` | — | ✅ | ✅ | ✅ | — | ✅ | — | — | ✅ |
| `permissionRequest` | — | ✅ | ✅ | ✅ | — | ✅ | — | ✅ | ✅ |
| `notification` | — | ✅ | — | — | — | ✅ | ✅ | — | — |
| `setup` | — | ✅ | — | — | — | ✅ | — | — | — |
| `worktreeCreate` | — | ✅ | — | — | — | — | — | — | — |
Expand Down
90 changes: 90 additions & 0 deletions src/features/hooks/codexcli-hooks.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,62 @@ describe("CodexcliHooks", () => {
expect(parsed.hooks.Stop[0].hooks[0].command).toBe("echo stop");
});

it("should support permissionRequest event with matcher", async () => {
const rulesyncHooks = new RulesyncHooks(
createMockAiFileParams({
fileContent: JSON.stringify({
hooks: {
permissionRequest: [
{ command: ".rulesync/hooks/perm.sh", matcher: "Bash", timeout: 30 },
],
},
}),
}),
);

const codexHooks = await CodexcliHooks.fromRulesyncHooks({
baseDir: testDir,
rulesyncHooks,
validate: true,
});

const parsed = JSON.parse(codexHooks.getFileContent());
expect(parsed.hooks.PermissionRequest).toBeDefined();
expect(parsed.hooks.PermissionRequest[0].matcher).toBe("Bash");
expect(parsed.hooks.PermissionRequest[0].hooks[0].command).toBe(".rulesync/hooks/perm.sh");
expect(parsed.hooks.PermissionRequest[0].hooks[0].type).toBe("command");
expect(parsed.hooks.PermissionRequest[0].hooks[0].timeout).toBe(30);
});

it("should preserve apply_patch and MCP tool matchers on permissionRequest", async () => {
const rulesyncHooks = new RulesyncHooks(
createMockAiFileParams({
fileContent: JSON.stringify({
hooks: {
permissionRequest: [
{ command: "./scripts/audit-patch.sh", matcher: "apply_patch" },
{ command: "./scripts/audit-mcp.sh", matcher: "mcp__fs__read" },
],
},
}),
}),
);

const codexHooks = await CodexcliHooks.fromRulesyncHooks({
baseDir: testDir,
rulesyncHooks,
validate: true,
});

const parsed = JSON.parse(codexHooks.getFileContent());
expect(parsed.hooks.PermissionRequest).toHaveLength(2);
const byMatcher = Object.fromEntries(
parsed.hooks.PermissionRequest.map((entry: { matcher: string }) => [entry.matcher, entry]),
);
expect(byMatcher.apply_patch.hooks[0].command).toBe("./scripts/audit-patch.sh");
expect(byMatcher.mcp__fs__read.hooks[0].command).toBe("./scripts/audit-mcp.sh");
});

it("should not write config.toml as a side effect", async () => {
const rulesyncHooks = new RulesyncHooks(
createMockAiFileParams({
Expand Down Expand Up @@ -252,6 +308,40 @@ describe("CodexcliHooks", () => {
});
});

it("should convert PermissionRequest to canonical permissionRequest", () => {
const codexHooks = new CodexcliHooks(
createMockAiFileParams({
relativeDirPath: ".codex",
relativeFilePath: "hooks.json",
fileContent: JSON.stringify({
hooks: {
PermissionRequest: [
{
matcher: "Bash",
hooks: [
{
type: "command",
command: ".rulesync/hooks/perm.sh",
},
],
},
],
},
}),
}),
);

const rulesyncHooks = codexHooks.toRulesyncHooks();
const parsed = rulesyncHooks.getJson();

expect(parsed.hooks.permissionRequest).toBeDefined();
expect(parsed.hooks.permissionRequest?.[0]).toEqual({
type: "command",
command: ".rulesync/hooks/perm.sh",
matcher: "Bash",
});
});

it("should ignore invalid entries", () => {
const codexHooks = new CodexcliHooks(
createMockAiFileParams({
Expand Down
2 changes: 2 additions & 0 deletions src/types/hooks.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,6 +186,7 @@ export const CODEXCLI_HOOK_EVENTS: readonly HookEvent[] = [
"postToolUse",
"beforeSubmitPrompt",
"stop",
"permissionRequest",
];

const hooksRecordSchema = z.record(z.string(), z.array(HookDefinitionSchema));
Expand Down Expand Up @@ -365,6 +366,7 @@ export const CANONICAL_TO_CODEXCLI_EVENT_NAMES: Record<string, string> = {
postToolUse: "PostToolUse",
beforeSubmitPrompt: "UserPromptSubmit",
stop: "Stop",
permissionRequest: "PermissionRequest",
};

/**
Expand Down