Refactor: cleaner top-level directory structure#138
Merged
Conversation
Phase 1 step 1 of the directory restructure. The dual content tree was called out in CLAUDE.md as cleanup; both trees were already in sync except for anti-patterns-catalog.js, which moves to site/data/. - Delete content/site/skills/ and content/site/tutorials/ (duplicates of site/content/, which is what Astro's content collection actually reads). - Move content/site/anti-patterns-catalog.js -> site/data/. - Update scripts/lib/sub-pages-data.js and scripts/build.js to read from site/content/ and site/data/. - Drop content/site/ from validateProse target list (site/content was already there). - Rewrite the "Two content trees" section in CLAUDE.md as a single-tree pointer; update stale dev-server text mentioning the deleted server/index.js. Tests: 186/186 pass. Skills build: clean. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Phase 1 step 2 of the directory restructure. The path was redundantly
nested ("source/" wrapper plus "skills/impeccable/" — singular content
hidden behind the plural). Collapses to flat skill/SKILL.md +
skill/reference/ + skill/scripts/.
- Move source/skills/impeccable/ -> skill/.
- Rewrite scripts/lib/utils.js readSourceFiles(): drop the multi-skill
iteration (CLAUDE.md commits to a single user-invocable skill); read
skill/SKILL.md directly.
- Update scripts/build.js, scripts/generate-og-image.js, and the
sub-pages data layer to point at skill/.
- Update tests/lib/utils.test.js: drop the "multi-skill" and "dir-name
fallback" cases, update single-skill paths to skill/.
- Update tests/build.test.js similarly: drop "multiple skills"
integration test, update paths.
- Update non-glob path joins in tests/framework-fixtures.test.mjs,
tests/live-e2e/session.mjs, tests/live-e2e/agents/llm-agent.mjs,
tools/live-loop.mjs.
- Update prose/text references in CLAUDE.md, AGENTS.md, DEVELOP.md,
README.md, scripts/lib/sub-pages-data.js, bin/commands/skills.mjs,
site/data/anti-patterns-catalog.js, site/pages/docs/[...slug].astro,
docs/adr-live-variant-mode.md, docs/plans/.
Eval framework note: the separate impeccable-evals repo reads
../impeccable/source/skills/impeccable/ and needs a coordinated
rename to ../impeccable/skill/.
Tests: 186/186 pass. Skills build: clean.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Phase 1 step 3 of the directory restructure. The internal docs/ dir (ADRs and plans) clashed with the site's /docs route. Renaming it "notes/" makes the difference unambiguous: notes/ is project-internal process, /docs is the user-facing route under site/pages/docs/. No code references the dir; the rename is a clean git mv. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Phase 2 step 4 of the directory restructure. Public assets and the Astro publicDir now live alongside the rest of the site, so site/ is fully self-contained for static content. - git mv public site/public. - astro.config.mjs: add publicDir: './site/public'. Astro defaults to ./public at the project root, so the override is required. - scripts/build.js: write generated _data, _headers, _redirects, _routes.json, and js/detect-antipatterns-browser.js into site/public/. Also delete the dead _REMOVED() Bun static-site builder (replaced by Astro at #130; the placeholder no longer earns its keep). - scripts/build.js validateProse: replace the stale public/index.html reference (deleted at the Astro migration) with site/pages/index.astro in the count-validation file list, restoring homepage drift detection. - scripts/generate-og-image.js: write OG image into site/public/. - scripts/screenshot-antipatterns.js: read examples from + write screenshots to site/public/antipattern-{examples,images}/. - scripts/lib/sub-pages-data.js: load command demos from site/public/js/demos/commands. - .gitignore: rename the public/* generator-output entries to site/public/*. - CLAUDE.md: refresh CSS/data-file paths (still pointing at the old pre-Astro public/css/ + public/js/ tree), point the changelog and command-add checklists at site/pages/index.astro and site/scripts/data.js + site/scripts/components/framework-viz.js. Cloudflare Pages note: functions/ stays at the repo root because CF Pages auto-discovers it there with no configuration knob to relocate. Moving it under site/ would either break deployment or require a build-time copy step that adds more complexity than the cleanup is worth. Tests: 186/186 pass. Skills + site build clean. _headers, _redirects, _routes.json, _data/ all land in build/ correctly. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Phase 2 step 5 of the directory restructure. The CLI surface was split
across three top-level dirs whose names were easy to mistake for each
other (especially src/ vs source/ pre-step-2). Consolidates under cli/.
- git mv bin -> cli/bin (CLI entry + skills sub-command)
- git mv src -> cli/engine (detect-antipatterns engine + browser variant)
- git mv lib -> cli/lib (download-providers helper)
Update package.json:
- bin.impeccable: cli/bin/cli.js
- main + exports: cli/engine/detect-antipatterns.mjs and the
./browser variant
- files: ["cli/", "LICENSE"]
Update internal references:
- cli/bin/cli.js: dynamic import points at ../engine/, package.json
read goes one level deeper (../../package.json).
- functions/api/download/[type]/[provider]/[id].js + bundle/[provider].js:
cli/lib/download-providers.js path.
- scripts/build.js, scripts/build-browser-detector.js,
scripts/build-extension.js: cli/engine path constants.
- scripts/lib/sub-pages-data.js, scripts/lib/utils.js, skill/scripts/
live-server.mjs: comment refs.
- tests/detect-antipatterns{,-browser,-fixtures}.test.{js,mjs},
tests/windows-path-fix.test.js: import + read paths.
- AGENTS.md, CLAUDE.md: doc paths.
Verified:
- npx node cli/bin/cli.js --version, --help, detect --help all work.
- bun run build, bun run build:browser, bun run build:extension all
clean. Browser detector lands at cli/engine/detect-antipatterns-browser.js;
extension/detector/detect.js still emits to the same location.
- bun run test: 186/186 pass.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
Bugbot caught two runtime path leaks where the comment got renamed to cli/engine/ but the actual code still used the old src/ segment. - skill/scripts/live-server.mjs: detectPaths array now joins cli, engine, detect-antipatterns-browser.js for both the repo-relative lookup (4 dirs up from .claude/skills/impeccable/scripts/ to repo root) and the npm node_modules fallback. Without this fix, the detection overlay would silently not load during live-server sessions. - scripts/build.js: the post-build copy of the browser detector into site/public/js/ was reading from src/. The if (fs.existsSync(...)) guard meant the copy was silently skipping, so antipattern-examples pages would 404 on /js/detect-antipatterns-browser.js once the site was deployed. Tests: 186/186 pass. Build clean. site/public/js/detect-antipatterns-browser.js re-emits as expected. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Deploying impeccable with
|
| Latest commit: |
39b43a4
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://99c99e12.impeccable-2rv.pages.dev |
| Branch Preview URL: | https://refactor-directory-structure.impeccable-2rv.pages.dev |
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 1 potential issue.
❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.
Reviewed by Cursor Bugbot for commit 26d78dc. Configure here.
Bugbot caught three call sites in cli/bin/commands/skills.mjs that import '../../skill/scripts/cleanup-deprecated.mjs'. Pre-rename, that was correct from bin/commands/ (one parent to bin/, one to repo root). After moving the file from bin/commands/ to cli/bin/commands/, the path is one directory deeper, so it needs three .. segments to reach the repo root. Without the fix, every cleanup invocation throws on import and gets swallowed by the surrounding try/catch — silent skip. cli/bin/cli.js's package.json read already uses '../../package.json' (the same depth pattern), confirming three levels is correct. Verified: dynamic import resolves and exports the expected functions. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Same root cause as the two bugbot finds: some references in moved or
related files weren't tracked because they didn't match a simple
sed pattern. Caught the rest by walking each moved dir's depth and
each Astro-migration deletion.
Stale path references (post-Astro migration, missed earlier):
- CLAUDE.md: legacy URL redirects "live in server/index.js" -> point
at the actual sources (scripts/build.js generateCFConfig +
site/public/_redirects).
- AGENTS.md: counts.js path (public/ -> site/public/), changelog file
(public/index.html -> site/pages/index.astro), screenshots note
(public/ -> site/), source-of-truth dirs (source/, src/ -> skill/,
cli/).
- tests/detect-antipatterns-browser.test.mjs: comment about routes
"in server/index.js".
- skill/reference/live.md: workflow.css example for "this repo" was
pre-Astro (public/css/) -> site/styles/. (User-project Vite/Next
example unchanged.)
Stale path that pointed at moved files:
- tests/skills-cli.test.js: CLI path was '..', 'bin', 'cli.js'; now
'..', 'cli', 'bin', 'cli.js'. Test isn't wired into bun run test
but it would have failed if invoked.
Dead files (orphaned by Astro migration, never cleaned up):
- tests/server/download-validation.test.js: imported from
../../server/lib/{validation,api-handlers}.js which were deleted in
b8f09c8. Test was a silent failure waiting to happen.
- scripts/lib/render-markdown.js: 156-line module with zero consumers
(the only caller, scripts/lib/render-page.js, was deleted in the
Astro cleanup).
- scripts/build.js: dead commented-out generateSubPages import.
Tests: 186/186 pass. Build clean.
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
Cloudflare Pages rejects the build with `Unsupported package manager specification (bun@1.3.11)`. The packageManager field follows Corepack's syntax which only validates npm/pnpm/yarn — `bun@X.Y.Z` parses as a malformed Corepack directive even though Bun itself treats it as a hint. Pre-existing on main since d874af0 (CF Pages deploy on main also failing); just surfaces here because the PR triggers a fresh deploy. CF Pages auto-detects Bun anyway (the build log confirms: "Detected the following tools from environment: bun@1.3.11, pnpm@10.11.1, nodejs@22.16.0"). Removing the field unblocks the deploy without changing local dev behavior. Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Two-phase top-level directory restructure to kill the worst confusions in the repo layout. Three pain points the user named, plus a few I noticed along the way:
site/content/andcontent/site/are two different trees for the same files (CLAUDE.md acknowledged the dual-tree as cleanup debt).source/(skill source) andsrc/(CLI source) are visually similar and easy to confuse.docs/(internal ADRs and plans) clashed with the site's/docsroute.bin/,src/, andlib/. Site infra was scattered acrosssite/,public/, andastro.config.mjs.What changed
Phase 1 — three commits:
e952f31Mergecontent/site/intosite/content/. Moveanti-patterns-catalog.jstosite/data/.d1f7553Renamesource/skills/impeccable/→skill/. Drop the redundantskills/impeccable/nesting and rewritereadSourceFilesfor the flat single-skill layout.d5b576dRename internaldocs/→notes/to remove the clash with the site's/docsroute.Phase 2 — two commits:
c249335Movepublic/→site/public/(Astro convention). ConfigurepublicDirinastro.config.mjs. Update generator paths inscripts/build.js,scripts/generate-og-image.js,scripts/screenshot-antipatterns.js, andscripts/lib/sub-pages-data.js. Refresh.gitignorefor the relocated build artifacts. Delete the dead_REMOVED()Bun static-site builder. Refresh CLAUDE.md (CSS section, generated-pages section, command-add checklist) for the post-Astro layout.db9b46aConsolidatebin/+src/+lib/undercli/:cli/bin/(entry + sub-commands),cli/engine/(detect-antipatterns engine + browser variant),cli/lib/(download-providers helper). Updatepackage.jsonbin/main/exports/files. Update relative imports, browser detector + extension build paths, Cloudflare Pages function imports, tests, and docs.What did not change
.claude/,.cursor/,.agents/, …) —npx skillsreads them there.plugin/at the repo root —.claude-plugin/marketplace.jsonreferences./plugin.functions/at the repo root — Cloudflare Pages auto-discovers./functions/and there's no wrangler.toml knob to relocate. Moving it would either break the deploy or require a build-time copy step that adds more complexity than the cleanup is worth.The CLI's npm-published surface (
npx impeccable,import 'impeccable',import 'impeccable/browser') is unchanged — onlypackage.jsonpaths point at the new layout.Eval framework follow-up
The separate
~/code/impeccable-evals/repo reads the skill from this repo. Path constants there have been updated in a tracking commit (5691a44on that repo's main, not pushed). Will go up alongside this PR.Test plan
bun run buildclean for skills + Astrobun run build:browserregeneratescli/engine/detect-antipatterns-browser.jsbun run build:extensionregeneratesextension/detector/detect.js+ zipbun run test— 186/186 passnode cli/bin/cli.js --versionand--helpwork_headers,_redirects,_routes.json,_data/all land inbuild/for Cloudflare Pagesbun🤖 Generated with Claude Code
Note
Medium Risk
Medium risk because it rewires many path assumptions (skill source, CLI engine entrypoints, Astro
publicDir, and generated-asset locations), which could break builds, installs, or runtime script loading if any path is missed.Overview
Aligns the repo with a new top-level layout: skill source references are updated from
source/skills/impeccabletoskill/, and the site’s public assets/generator outputs are moved undersite/publicwith Astro configured viapublicDir.Updates live-mode tooling to load the detector bundle from the new CLI engine location (
cli/engine/detect-antipatterns-browser.js), adjusts CLI entrypoints/imports to point atcli/engine, and refreshes docs/ignores to match the relocated generated content and build artifacts.Reviewed by Cursor Bugbot for commit 39b43a4. Bugbot is set up for automated code reviews on this repo. Configure here.