fix(hooks): find formatter configs in parent dirs by tsubasakong · Pull Request #364 · affaan-m/everything-claude-code

tsubasakong · 2026-03-08T15:11:56Z

Description

Summary\n- let post-edit-format treat formatter config files as project-root markers, not just package.json\n- add broader Prettier config variants to the shared detection list\n- add a hook test covering config-only repos with nested files\n\nCloses #362.\n

Validation:

No additional local validation recorded.

Type of Change

Checklist

Tests pass locally (node tests/run-all.js)
Validation scripts pass
Follows conventional commits format
Updated relevant documentation

coderabbitai · 2026-03-08T15:12:11Z

📝 Walkthrough

Walkthrough

The post-edit-format hook now discovers formatter configurations through marker-based detection by walking parent directories, supporting multiple Biome and Prettier config file variants instead of relying solely on package.json. Tests verify this functionality in repos without package.json.

Changes

Cohort / File(s)	Summary
Formatter Root Detection `scripts/hooks/post-edit-format.js`	Refactored `findProjectRoot()` to use centralized `BIOME_CONFIGS` and `PRETTIER_CONFIGS` marker arrays for multi-variant config discovery. Expanded supported configuration files and updated directory traversal logic to check markers before ascending filesystem.
Test Coverage `tests/hooks/hooks.test.js`	Added test scenario verifying formatter config discovery in parent directories when `package.json` is absent. Test creates synthetic repo with formatter config, nested file, and mocked `npx` to validate root detection and command invocation. Note: test block appears duplicated in file.

Estimated code review effort

🎯 3 (Moderate) | ⏱️ ~20 minutes

Possibly related PRs

#252: Modifies scripts/hooks/post-edit-format.js to add auto-detection of Biome vs Prettier config files through parent directory traversal.

Poem

🐰 Hops through directories with delight,
No more package.json chains so tight!
Biome, Prettier configs now in sight—
Formatter markers guide the way,
Root discovery saves the day! 🎉

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Docstring Coverage	⚠️ Warning	Docstring coverage is 33.33% which is insufficient. The required threshold is 80.00%.	Write docstrings for the functions missing them to satisfy the coverage threshold.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title accurately describes the main change: updating the hooks to find formatter configs in parent directories, which matches the primary objective of the PR.
Linked Issues check	✅ Passed	The PR successfully addresses issue `#362` by implementing parent-directory traversal for formatter config discovery using marker-based detection with BIOME_CONFIGS and PRETTIER_CONFIGS.
Out of Scope Changes check	✅ Passed	All changes are directly related to resolving issue `#362`: the post-edit-format.js modifications implement the marker-based root detection, and test additions validate the new functionality.
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

Create PR with unit tests
Post copyable unit tests in a comment

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

cubic-dev-ai

No issues found across 2 files

coderabbitai

Actionable comments posted: 1

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)

scripts/hooks/post-edit-format.js (1)

39-64: ⚠️ Potential issue | 🟠 Major

Keep walking past package.json-only directories.

Line 55 returns on the first marker, so a nested package.json still masks a shared root .prettierrc/biome.json. In a workspace like packages/foo/package.json plus a repo-root formatter config, detectFormatter() only inspects packages/foo and formatting is skipped.

🐛 Suggested fix

-const PROJECT_ROOT_MARKERS = ['package.json', ...BIOME_CONFIGS, ...PRETTIER_CONFIGS];
+const PROJECT_CONFIG_MARKERS = [...BIOME_CONFIGS, ...PRETTIER_CONFIGS];

 function findProjectRoot(startDir) {
   let dir = startDir;
+  let packageRoot = null;

   while (true) {
-    if (PROJECT_ROOT_MARKERS.some(marker => fs.existsSync(path.join(dir, marker)))) {
+    if (PROJECT_CONFIG_MARKERS.some(marker => fs.existsSync(path.join(dir, marker)))) {
       return dir;
     }
+
+    if (!packageRoot && fs.existsSync(path.join(dir, 'package.json'))) {
+      packageRoot = dir;
+    }

     const parentDir = path.dirname(dir);
     if (parentDir === dir) break;
     dir = parentDir;
   }

-  return startDir;
+  return packageRoot || startDir;
 }

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@scripts/hooks/post-edit-format.js` around lines 39 - 64, findProjectRoot
currently returns immediately when it sees any PROJECT_ROOT_MARKERS (including
package.json), which causes nested package.json dirs to mask a repo-level
formatter config; change findProjectRoot so it prefers formatter configs
(PRETTIER_CONFIGS or BIOME_CONFIGS) over package.json: while walking up, if you
find any PRETTIER_CONFIGS or BIOME_CONFIGS file return that dir; if you find
package.json record it as a fallback but continue walking; after reaching
filesystem root return the recorded package.json dir if any, otherwise return
startDir. Update the logic in findProjectRoot and reference
PROJECT_ROOT_MARKERS, PRETTIER_CONFIGS, BIOME_CONFIGS, and the findProjectRoot
function name when making the change.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@tests/hooks/hooks.test.js`:
- Around line 716-726: The test only writes a Unix `npx` shim
(fs.writeFileSync(path.join(binDir, 'npx'), ...)) but the hook script
(scripts/hooks/post-edit-format.js) resolves `npx.cmd` on Windows; update the
test to create the Windows shim as well (e.g., write a corresponding `npx.cmd`
file in binDir that writes the same logFile) or write both `npx` and `npx.cmd`
unconditionally so runScript and post-edit-format.js find the shim on all
platforms; modify the fs.writeFileSync calls that create the shim(s) in the test
near runScript to include the Windows variant (ensure executable/mode behavior
is handled appropriately).

---

Outside diff comments:
In `@scripts/hooks/post-edit-format.js`:
- Around line 39-64: findProjectRoot currently returns immediately when it sees
any PROJECT_ROOT_MARKERS (including package.json), which causes nested
package.json dirs to mask a repo-level formatter config; change findProjectRoot
so it prefers formatter configs (PRETTIER_CONFIGS or BIOME_CONFIGS) over
package.json: while walking up, if you find any PRETTIER_CONFIGS or
BIOME_CONFIGS file return that dir; if you find package.json record it as a
fallback but continue walking; after reaching filesystem root return the
recorded package.json dir if any, otherwise return startDir. Update the logic in
findProjectRoot and reference PROJECT_ROOT_MARKERS, PRETTIER_CONFIGS,
BIOME_CONFIGS, and the findProjectRoot function name when making the change.

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 4fce34e9-c905-4a02-884e-9fa98d6c312b

📥 Commits

Reviewing files that changed from the base of the PR and between 6090401 and 0bd4a11.

📒 Files selected for processing (2)

scripts/hooks/post-edit-format.js
tests/hooks/hooks.test.js

coderabbitai · 2026-03-08T15:18:28Z

tests/hooks/hooks.test.js

+    fs.writeFileSync(
+      path.join(binDir, 'npx'),
+      `#!/usr/bin/env node\nconst fs = require('fs');\nfs.writeFileSync(${JSON.stringify(logFile)}, JSON.stringify({ cwd: process.cwd(), args: process.argv.slice(2) }));\n`,
+      { mode: 0o755 }
+    );
+
+    try {
+      const stdinJson = JSON.stringify({ tool_input: { file_path: targetFile } });
+      const result = await runScript(path.join(scriptsDir, 'post-edit-format.js'), stdinJson, {
+        PATH: `${binDir}${path.delimiter}${process.env.PATH || ''}`,
+      });


⚠️ Potential issue | 🟠 Major

Make the formatter shim work on Windows too.

Lines 716-726 only create an npx stub, but scripts/hooks/post-edit-format.js resolves npx.cmd on Windows. The hook will miss this shim there, so the new assertion on logFile becomes platform-dependent.

🪟 Suggested fix

+ const shimJs = path.join(binDir, 'npx-shim.js'); + fs.writeFileSync( + shimJs, + `const fs = require('fs');\nfs.writeFileSync(${JSON.stringify(logFile)}, JSON.stringify({ cwd: process.cwd(), args: process.argv.slice(2) }));\n` + ); fs.writeFileSync( path.join(binDir, 'npx'), - `#!/usr/bin/env node\nconst fs = require('fs');\nfs.writeFileSync(${JSON.stringify(logFile)}, JSON.stringify({ cwd: process.cwd(), args: process.argv.slice(2) }));\n`, + `#!/usr/bin/env node\nrequire(${JSON.stringify(shimJs)});\n`, { mode: 0o755 } ); + fs.writeFileSync( + path.join(binDir, 'npx.cmd'), + `@echo off\r\nnode "%~dp0\\npx-shim.js" %*\r\n`, + { mode: 0o755 } + );

As per coding guidelines, "Ensure cross-platform compatibility for Windows, macOS, and Linux via Node.js scripts".

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

fs.writeFileSync(

path.join(binDir, 'npx'),

`#!/usr/bin/env node\nconst fs = require('fs');\nfs.writeFileSync(${JSON.stringify(logFile)}, JSON.stringify({ cwd: process.cwd(), args: process.argv.slice(2) }));\n`,

{ mode: 0o755 }

);

try {

const stdinJson = JSON.stringify({ tool_input: { file_path: targetFile } });

const result = await runScript(path.join(scriptsDir, 'post-edit-format.js'), stdinJson, {

PATH: `${binDir}${path.delimiter}${process.env.PATH || ''}`,

});

const shimJs = path.join(binDir, 'npx-shim.js');

fs.writeFileSync(

shimJs,

`const fs = require('fs');\nfs.writeFileSync(${JSON.stringify(logFile)}, JSON.stringify({ cwd: process.cwd(), args: process.argv.slice(2) }));\n`

);

fs.writeFileSync(

path.join(binDir, 'npx'),

`#!/usr/bin/env node\nrequire(${JSON.stringify(shimJs)});\n`,

{ mode: 0o755 }

);

fs.writeFileSync(

path.join(binDir, 'npx.cmd'),

`@echo off\r\nnode "%~dp0\\npx-shim.js" %*\r\n`,

{ mode: 0o755 }

);

try {

const stdinJson = JSON.stringify({ tool_input: { file_path: targetFile } });

const result = await runScript(path.join(scriptsDir, 'post-edit-format.js'), stdinJson, {

PATH: `${binDir}${path.delimiter}${process.env.PATH || ''}`,

});

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed. In `@tests/hooks/hooks.test.js` around lines 716 - 726, The test only writes a Unix `npx` shim (fs.writeFileSync(path.join(binDir, 'npx'), ...)) but the hook script (scripts/hooks/post-edit-format.js) resolves `npx.cmd` on Windows; update the test to create the Windows shim as well (e.g., write a corresponding `npx.cmd` file in binDir that writes the same logFile) or write both `npx` and `npx.cmd` unconditionally so runScript and post-edit-format.js find the shim on all platforms; modify the fs.writeFileSync calls that create the shim(s) in the test near runScript to include the Windows variant (ensure executable/mode behavior is handled appropriately).

affaan-m