chore: prevent doc + diagram drift (file-move + doc-and-diagram + lean-CLAUDE.md) #114
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,84 @@ | ||
| #!/usr/bin/env bash | ||
| # PostToolUse hook on Bash. When the command is `git mv` or `git rm`, finds the source | ||
| # path(s) and greps the repo for refs to them. Prints findings as additionalContext so | ||
| # the model sees the worklist in the same session the move happened. | ||
| # | ||
| # Purpose: catch doc/comment/Dockerfile drift in the same session a file gets moved or | ||
| # deleted — same compounding loop as check-claude-md-refs.sh but for renames/deletions | ||
| # instead of CLAUDE.md edits. | ||
| # | ||
| # Why git mv / git rm specifically (not plain mv / rm): plain mv/rm is used constantly | ||
| # for temp files, build artifacts, and ephemeral work. Restricting to git-tracked | ||
| # operations dramatically cuts false-positive noise. The cost is missing the case where | ||
| # someone uses plain `mv` on a tracked file — that's the gap CodeRabbit's | ||
| # path_instruction for file rename/delete picks up at review time. | ||
| # | ||
| # See CLAUDE.md "File-move discipline" for the canonical rule. | ||
|
|
||
| set -uo pipefail | ||
|
|
||
| REPO_ROOT="/Users/joshuadell/NovaCraft" | ||
|
|
||
| command=$(jq -r '.tool_input.command // ""' 2>/dev/null) | ||
|
|
||
| # Only fire on git mv / git rm. Plain mv/rm is too noisy. | ||
| case "$command" in | ||
| *"git mv "*) ;; | ||
| *"git rm "*) ;; | ||
| *) exit 0 ;; | ||
| esac | ||
|
|
||
| old_paths=() | ||
|
|
||
| # git mv <src> <dst> — capture the FIRST positional arg (the source). | ||
| if [[ "$command" =~ git[[:space:]]+mv[[:space:]]+([^[:space:]]+) ]]; then | ||
| src="${BASH_REMATCH[1]}" | ||
| case "$src" in | ||
| -*) ;; # skip if it looked like a flag | ||
| *) old_paths+=("$src") ;; | ||
| esac | ||
| fi | ||
|
|
||
| # git rm [flags] <path>... — capture all non-flag tokens after `git rm`. | ||
| if [[ "$command" =~ git[[:space:]]+rm[[:space:]] ]]; then | ||
| args=$(echo "$command" | sed -E 's/^.*git[[:space:]]+rm[[:space:]]+//' | tr -s ' ') | ||
| for token in $args; do | ||
| case "$token" in | ||
| -*) continue ;; | ||
| "") continue ;; | ||
| *) old_paths+=("$token") ;; | ||
| esac | ||
| done | ||
| fi | ||
|
|
||
| # Nothing to do. | ||
| if [ ${#old_paths[@]} -eq 0 ]; then | ||
| exit 0 | ||
| fi | ||
|
|
||
| # For each old path, grep for refs and collect findings. --fixed-strings so paths | ||
| # containing dots / slashes match literally instead of as regex. | ||
| findings="" | ||
| for old_path in "${old_paths[@]}"; do | ||
| case "$old_path" in | ||
| ""|"*"|"."|"./"|".."|"./*") continue ;; | ||
| esac | ||
|
|
||
| matches=$(grep -rln --fixed-strings "$old_path" \ | ||
| --include='*.md' --include='*.cs' --include='*.props' --include='*.csproj' \ | ||
| --include='*.yml' --include='*.yaml' --include='*.sh' \ | ||
| --include='Dockerfile*' \ | ||
| "$REPO_ROOT" 2>/dev/null \ | ||
| | head -30 \ | ||
| || true) | ||
| if [ -n "$matches" ]; then | ||
| findings+=$(printf "Refs to '%s' still present in:\n%s\n\n" "$old_path" "$matches") | ||
| fi | ||
| done | ||
|
|
||
| if [ -z "$findings" ]; then | ||
| exit 0 | ||
| fi | ||
|
|
||
| msg=$(printf 'File-move/delete detected. Refs to the OLD path may need updating before commit:\n\n%s\nUpdate the paraphrases in the same PR. See CLAUDE.md "File-move discipline".' "$findings") | ||
| jq -n --arg m "$msg" '{hookSpecificOutput: {hookEventName: "PostToolUse", additionalContext: $m}}' | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Exclude the documented allowlist file from drift matches.
Line 67 currently scans all markdown files, which will also flag
.claude/audits/INDEX.md; that file is explicitly allowlisted and should be skipped to avoid false positives.Suggested patch
As per coding guidelines, “Allowlist:
.claude/audits/INDEX.md… do NOT flag links from INDEX.md as drift.”🤖 Prompt for AI Agents