Tianyi Cui
65165b5d54
The two hook bridges (dsh-hooks-claude, dsh-hooks-codex) would otherwise duplicate
the bulk of the protocol — Codex deliberately reimplements a SUBSET of the Claude
Code protocol (same hooks.json shape, exit-code/stdout contract, command-hook
model). This library holds the genuinely-identical primitives; each bridge owns
only what differs (per-event stdin payload, env/substitution, decision mapping).
New packages/hooks/ group; hook-protocol is a LIBRARY (no plugin, registers/injects
nothing):
- matcher: matchesMatcher(pattern, query, mode) — the one dialect axis collapsed to
a mode param (claude = literal-or-regex with pipe alternation; codex = always
unanchored regex). Match-all on absent/''/'*'; invalid regex matches nothing.
- codec: parseHookOutput(exit, stdout, stderr) → dialect-neutral HookOutput. Exit 0
→ lenient JSON; exit 2 → blocking error (stderr = reason, surfaced as
decision:'block'); other → non-blocking. Parses the CC superset
(continue/stopReason/decision/hookSpecificOutput.{permissionDecision,
additionalContext,updatedInput}/systemMessage); permissionDecision overrides the
legacy top-level decision.
- runner: runHook(bash, hook, opts, now) — runs a command hook via ctx.bash (stdin
payload + trusted-plugin env), honors timeoutSec, never throws (executor reject →
non-blocking-error HookOutput). Injected clock for testable durations.
- merge: mergeHookOutputs — most-restrictive fold (deny>ask>allow, sticky stop,
block reasons joined, context/system-messages accumulated).
- hook/* session events (declaration-merged into SessionEventMap, log-only like
compact/*) + appendHookInvoked/appendHookResult helpers.
updatedInput is parsed but NOT honored (deferred pre-tool-input-rewrite RFC); a
bridge logs+warns. 47 unit tests at per-file 100% (matcher per-mode, codec per
exit-code/field, runner plumbing w/ stub executor, merge precedence, hook/*
helpers). RFC: implemented/feature/2026-06-30-hook-protocol-lib.md.
59 lines
2.7 KiB
TypeScript
59 lines
2.7 KiB
TypeScript
import { describe, expect, it } from 'vitest'
|
|
import { matchesMatcher } from '@deepseek-ai/dsh-hook-protocol'
|
|
|
|
describe('matchesMatcher — match-all sentinels (both dialects)', () => {
|
|
for (const mode of ['claude', 'codex'] as const) {
|
|
it(`${mode}: absent / empty / '*' match everything`, () => {
|
|
expect(matchesMatcher(undefined, 'Bash', mode)).toBe(true)
|
|
expect(matchesMatcher('', 'anything', mode)).toBe(true)
|
|
expect(matchesMatcher('*', 'whatever', mode)).toBe(true)
|
|
})
|
|
}
|
|
})
|
|
|
|
describe('matchesMatcher — claude dialect (literal-or-regex)', () => {
|
|
it('a pure word-char pattern is a LITERAL exact match (not substring)', () => {
|
|
expect(matchesMatcher('Bash', 'Bash', 'claude')).toBe(true)
|
|
// literal exact: "Bash" must NOT match "BashOutput" (a regex would, substring)
|
|
expect(matchesMatcher('Bash', 'BashOutput', 'claude')).toBe(false)
|
|
})
|
|
|
|
it('a pipe pattern is literal ALTERNATION (exact match any alternative)', () => {
|
|
expect(matchesMatcher('Edit|Write', 'Edit', 'claude')).toBe(true)
|
|
expect(matchesMatcher('Edit|Write', 'Write', 'claude')).toBe(true)
|
|
expect(matchesMatcher('Edit|Write', 'Read', 'claude')).toBe(false)
|
|
// still exact per-alternative, not substring
|
|
expect(matchesMatcher('Edit|Write', 'EditFile', 'claude')).toBe(false)
|
|
})
|
|
|
|
it('a non-word pattern falls through to regex (unanchored)', () => {
|
|
expect(matchesMatcher('^Bash$', 'Bash', 'claude')).toBe(true)
|
|
expect(matchesMatcher('Bash.*', 'BashOutput', 'claude')).toBe(true)
|
|
expect(matchesMatcher('.*\\.ts$', 'foo.ts', 'claude')).toBe(true)
|
|
expect(matchesMatcher('.*\\.ts$', 'foo.js', 'claude')).toBe(false)
|
|
})
|
|
})
|
|
|
|
describe('matchesMatcher — codex dialect (always regex)', () => {
|
|
it('a word pattern is an unanchored regex (substring matches, unlike claude literal)', () => {
|
|
expect(matchesMatcher('Bash', 'Bash', 'codex')).toBe(true)
|
|
// codex has NO literal fast path: "Bash" is /Bash/, so it DOES match a substring
|
|
expect(matchesMatcher('Bash', 'BashOutput', 'codex')).toBe(true)
|
|
})
|
|
|
|
it('regex alternation and anchors work', () => {
|
|
expect(matchesMatcher('Edit|Write', 'Edit', 'codex')).toBe(true)
|
|
expect(matchesMatcher('^Bash$', 'Bash', 'codex')).toBe(true)
|
|
expect(matchesMatcher('^Bash$', 'BashOutput', 'codex')).toBe(false)
|
|
})
|
|
})
|
|
|
|
describe('matchesMatcher — invalid regex is a non-match (never throws)', () => {
|
|
it('an unbalanced pattern matches nothing rather than throwing', () => {
|
|
// '(' is not the claude-literal charset, so it goes to the regex path and is invalid.
|
|
expect(() => matchesMatcher('(', 'x', 'claude')).not.toThrow()
|
|
expect(matchesMatcher('(', 'x', 'claude')).toBe(false)
|
|
expect(matchesMatcher('[', 'x', 'codex')).toBe(false)
|
|
})
|
|
})
|