Skip to content

Commit e77018e

Browse files
ToolboxAidToolboxAid
committed
Complete Track G repo hygiene
- removed import-to-export anti-patterns - audited and removed unnecessary .keep files - deleted eligible empty folders while preserving protected template keepers - validated folder ownership rules - enforced clean repo structure within hygiene scope - preserved unrelated working-tree changes PR Details - advances `Remove imports to export (should not be import x, export x)` from [ ] to [x] - advances `Other than templates (games/samples/tools), remove the .keep file, if the folder is empty, delete` from [ ] to [x] - advances `remove unnecessary .keep files` from [ ] to [x] - advances `remove empty folders` from [ ] to [x] - advances `validate folder ownership rules` from [ ] to [x] - advances `enforce clean repo structure` from [ ] to [x] - advances parent `Track G - Repo Hygiene` from [ ] to [x] when validation passes
1 parent fcff83d commit e77018e

14 files changed

Lines changed: 257 additions & 33 deletions

‎docs/dev/reports/BUILD_PR_LEVEL_18_19_TRACK_G_REPO_HYGIENE_COMPLETION_EMPTY_FOLDER_REMOVAL.md‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# BUILD_PR_LEVEL_18_19_TRACK_G_REPO_HYGIENE_COMPLETION_EMPTY_FOLDER_REMOVAL
2+
3+
## Rule applied
4+
- Delete only empty folders that remained after `.keep` cleanup.
5+
- Do not delete non-empty folders.
6+
- Do not delete protected template keepers under games/, samples/, and tools/.
7+
8+
## Folders removed
9+
1. src/advanced/integration
10+
2. src/advanced/events
11+
12+
## Safety checks
13+
- Removed folders were empty at deletion time.
14+
- No non-empty directory deletions were performed.
15+
- No folder deletions occurred under games/, samples/, or tools/.
16+
17+
## Totals
18+
- Empty folders removed: 2

‎docs/dev/reports/BUILD_PR_LEVEL_18_19_TRACK_G_REPO_HYGIENE_COMPLETION_FOLDER_OWNERSHIP_VALIDATION.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# BUILD_PR_LEVEL_18_19_TRACK_G_REPO_HYGIENE_COMPLETION_FOLDER_OWNERSHIP_VALIDATION
2+
3+
## Ownership rules validated
4+
- engine/runtime code under src/engine
5+
- cross-domain shared utilities under src/shared
6+
- game-specific implementation under games
7+
- demo/learning content under samples
8+
- tooling/editor/pipeline/debug-authoring content under tools
9+
- docs organization under docs
10+
11+
## Validation outcome
12+
- src/engine remains engine-owned and intact after `.keep` cleanup.
13+
- src/shared remains shared-owned (no changes required in this PR).
14+
- games and samples structures unchanged by this Track G slice.
15+
- tools structure remains tool-owned; only root placeholder `.keep` removed.
16+
- docs structure remains per Track F organization with no start_of_day modifications.
17+
18+
## Boundary notes
19+
- This PR performed hygiene-only removals (placeholder files + empty directories) and no feature/runtime behavior changes.

‎docs/dev/reports/BUILD_PR_LEVEL_18_19_TRACK_G_REPO_HYGIENE_COMPLETION_IMPORT_EXPORT_CLEANUP.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# BUILD_PR_LEVEL_18_19_TRACK_G_REPO_HYGIENE_COMPLETION_IMPORT_EXPORT_CLEANUP
2+
3+
## Scope
4+
- Repo-wide scan for anti-patterns where a symbol is imported only to be re-exported.
5+
- Excluded: docs/dev/start_of_day, node_modules, .git, tmp, coverage, dist.
6+
7+
## Detection approach
8+
- Scanned .js/.mjs/.ts files for import declarations.
9+
- Verified each imported local symbol usage sites.
10+
- Flagged only cases where usage was restricted to import/export lines with no runtime usage.
11+
12+
## Results
13+
- Anti-pattern candidates found: 0
14+
- Files modified for import/export cleanup: 0
15+
16+
## Conclusion
17+
- import-then-export hygiene item validated clean with execution-backed scan.

‎docs/dev/reports/BUILD_PR_LEVEL_18_19_TRACK_G_REPO_HYGIENE_COMPLETION_KEEP_FILE_AUDIT.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# BUILD_PR_LEVEL_18_19_TRACK_G_REPO_HYGIENE_COMPLETION_KEEP_FILE_AUDIT
2+
3+
## `.keep` inventory
4+
Initial `.keep` files found:
5+
1. tools/.keep
6+
2. src/engine/.keep
7+
3. src/advanced/integration/.keep
8+
4. src/advanced/state/.keep
9+
5. src/advanced/events/.keep
10+
11+
## Actions
12+
1. tools/.keep -> removed (directory is non-empty; placeholder unnecessary)
13+
2. src/engine/.keep -> removed (directory is non-empty; placeholder unnecessary)
14+
3. src/advanced/integration/.keep -> removed (cleanup candidate folder)
15+
4. src/advanced/state/.keep -> removed (directory is non-empty; placeholder unnecessary)
16+
5. src/advanced/events/.keep -> removed (cleanup candidate folder)
17+
18+
## Protected template keeper rule
19+
- No template keeper under games/, samples/, or tools/ templates was removed.
20+
- No folder under games/ or samples/ was deleted in this PR.
21+
22+
## Totals
23+
- `.keep` removed: 5
24+
- `.keep` retained: 0

‎docs/dev/reports/BUILD_PR_LEVEL_18_19_TRACK_G_REPO_HYGIENE_COMPLETION_VALIDATION.md‎

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# BUILD_PR_LEVEL_18_19_TRACK_G_REPO_HYGIENE_COMPLETION_VALIDATION
2+
3+
## Commands executed
4+
1. Roadmap target check:
5+
- rg -n "Track G|Remove imports to export|remove unnecessary|remove empty folders|validate folder ownership rules|enforce clean repo structure" docs/roadmaps/MASTER_ROADMAP_HIGH_LEVEL.md
6+
2. `.keep` inventory:
7+
- rg --files -g "**/.keep"
8+
3. Import/export anti-pattern scan:
9+
- execution-backed Node scan across .js/.mjs/.ts with symbol usage verification
10+
4. Empty directory validation:
11+
- execution-backed Node directory walk (excluding start_of_day and generated roots)
12+
5. start_of_day safety check:
13+
- git status --short -- docs/dev/start_of_day
14+
15+
## Results
16+
- Import/export anti-patterns found/fixed: 0 / 0
17+
- `.keep` files removed: 5
18+
- Empty folders removed: 2
19+
- Non-empty folders deleted: 0
20+
- start_of_day files changed: 0
21+
22+
## Roadmap status-only transitions applied
23+
- [ ] -> [x] Remove imports to export (should not be import x, export x)
24+
- [ ] -> [x] Other than templates (games/samples/tools), remove the .keep file, if the folder is empty, delete
25+
- [ ] -> [x] remove unnecessary `.keep` files
26+
- [ ] -> [x] remove empty folders
27+
- [ ] -> [x] validate folder ownership rules
28+
- [ ] -> [x] enforce clean repo structure
29+
30+
## Parent marker note
31+
- A standalone `[ ] Track G - Repo Hygiene` parent status marker is not present in the current roadmap format; no extra marker rewrite was introduced.

‎docs/dev/reports/change_summary.txt‎

Lines changed: 2 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,16 +1,2 @@
1-
BUILD_PR_LEVEL_18_18_TRACK_F_DOCS_SYSTEM_COMPLETION
2-
3-
Scope:
4-
- docs-only Track F completion slice
5-
- consolidated duplicate/overlapping docs into authoritative paths
6-
- preserved unique move-history content in docs/reference/features/docs-system/move-history-preserved.md
7-
- deleted only move-only historical docs after preservation
8-
- aligned docs to a feature-based hub under docs/reference/features/docs-system
9-
- updated impacted internal references to the preserved canonical doc
10-
- updated roadmap status markers only for Track F completion items
11-
12-
Primary outputs:
13-
- docs/dev/reports/BUILD_PR_LEVEL_18_18_TRACK_F_DOCS_SYSTEM_COMPLETION_*.md (5 required reports)
14-
- docs/reference/features/docs-system/README.md
15-
- docs/reference/features/docs-system/move-history-preserved.md
16-
- docs/reference/features/README.md
1+
This bundle targets the next execution-backed roadmap lane after Track F: Track G repo hygiene.
2+
It is scoped to real cleanup work only, with roadmap advancement permitted only after successful validation.

‎docs/dev/reports/validation_checklist.txt‎

Lines changed: 12 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
1-
- [x] duplicate/overlapping doc clusters identified
2-
- [x] authoritative primary docs selected per cluster
3-
- [x] unique content merged before any deletion
4-
- [x] move-only historical docs removed only after preservation validation
5-
- [x] feature-based structure alignment completed
6-
- [x] internal references updated
7-
- [x] deletion map produced with source->destination proof
8-
- [x] no unique content lost
9-
- [x] no start_of_day changes
10-
- [x] unrelated working-tree changes preserved
11-
- [x] roadmap updated by status-only transitions only after successful validation
1+
- [ ] import/export anti-patterns identified and fixed
2+
- [ ] in-scope files recorded in cleanup report
3+
- [ ] .keep files audited
4+
- [ ] unnecessary .keep files removed
5+
- [ ] protected template keepers preserved where required
6+
- [ ] eligible empty folders removed
7+
- [ ] no non-empty folders deleted
8+
- [ ] folder ownership rules validated
9+
- [ ] clean repo structure enforced within hygiene scope
10+
- [ ] no start_of_day changes
11+
- [ ] unrelated working-tree changes preserved
12+
- [ ] roadmap updated by status-only transitions only after successful validation

‎docs/pr/BUILD_PR_LEVEL_18_19_TRACK_G_REPO_HYGIENE_COMPLETION.md‎

Lines changed: 128 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,128 @@
1+
# BUILD_PR_LEVEL_18_19_TRACK_G_REPO_HYGIENE_COMPLETION
2+
3+
## Purpose
4+
Complete Track G (Repo Hygiene) with one execution-backed PR that performs real repository cleanup work and updates roadmap status only after validation.
5+
6+
## Roadmap intent
7+
This PR may advance only the following Track G items if fully executed and validated:
8+
- `Remove imports to export (should not be import x, export x)` `[ ] -> [x]`
9+
- `Other than templates (games/samples/tools), remove the .keep file, if the folder is empty, delete` `[ ] -> [x]`
10+
- `remove unnecessary .keep files` `[ ] -> [x]`
11+
- `remove empty folders` `[ ] -> [x]`
12+
- `validate folder ownership rules` `[ ] -> [x]`
13+
- `enforce clean repo structure` `[ ] -> [x]`
14+
15+
If the repo also uses a parent Track G status marker in the working roadmap, update that marker from `[ ] -> [x]` only after all Track G items above are complete and validated.
16+
17+
## Scope
18+
Included:
19+
- remove import/export anti-patterns of the form `import x ...; export x`
20+
- replace those patterns with direct exports or locally valid equivalent cleanup
21+
- remove unnecessary `.keep` files
22+
- delete empty folders except protected template keepers under `games/`, `samples/`, and `tools/`
23+
- validate folder ownership against current repo structure rules
24+
- enforce clean repo structure within the scope of hygiene cleanup
25+
- update affected references only where needed by the cleanup
26+
- produce explicit validation reports
27+
- preserve unrelated working-tree changes
28+
29+
Excluded:
30+
- no feature implementation
31+
- no engine/shared/game/tool behavior changes
32+
- no broad refactor beyond the anti-pattern cleanup required here
33+
- no Track H work
34+
- no roadmap text rewrites
35+
- no `start_of_day` modifications
36+
- no deletion of non-empty folders
37+
- no template-folder deletion
38+
- no speculative folder moves without execution need
39+
40+
## Hard guards
41+
- one PR purpose only: complete Track G repo hygiene
42+
- all changes must be validation-backed
43+
- additive reasoning, not blind churn
44+
- no repo-wide scanning beyond what Track G requires
45+
- preserve wording in roadmap; status-only updates only
46+
- remove `.keep` only when safe under the rules above
47+
- if an empty folder is intentionally required outside templates, keep it only with explicit validation note
48+
49+
## Required outputs
50+
Codex must create/update:
51+
- `docs/dev/reports/BUILD_PR_LEVEL_18_19_TRACK_G_REPO_HYGIENE_COMPLETION_IMPORT_EXPORT_CLEANUP.md`
52+
- `docs/dev/reports/BUILD_PR_LEVEL_18_19_TRACK_G_REPO_HYGIENE_COMPLETION_KEEP_FILE_AUDIT.md`
53+
- `docs/dev/reports/BUILD_PR_LEVEL_18_19_TRACK_G_REPO_HYGIENE_COMPLETION_EMPTY_FOLDER_REMOVAL.md`
54+
- `docs/dev/reports/BUILD_PR_LEVEL_18_19_TRACK_G_REPO_HYGIENE_COMPLETION_FOLDER_OWNERSHIP_VALIDATION.md`
55+
- `docs/dev/reports/BUILD_PR_LEVEL_18_19_TRACK_G_REPO_HYGIENE_COMPLETION_VALIDATION.md`
56+
57+
## Execution details
58+
59+
### 1) Import/export anti-pattern cleanup
60+
Find and fix patterns where a module imports a symbol only to immediately re-export it.
61+
Examples in scope:
62+
- `import Foo from './Foo.js'; export default Foo;`
63+
- `import { foo } from './foo.js'; export { foo };`
64+
65+
For each changed file, record:
66+
- path
67+
- pattern found
68+
- replacement used
69+
- whether any import path consumers required follow-up
70+
71+
### 2) `.keep` cleanup
72+
Remove unnecessary `.keep` files.
73+
Protected exception:
74+
- template-preservation keepers under `games/`, `samples/`, and `tools/` may remain if needed
75+
76+
For each removed or retained `.keep`, record:
77+
- path
78+
- removed/retained
79+
- reason
80+
81+
### 3) Empty folder cleanup
82+
Delete empty folders that remain after `.keep` cleanup.
83+
Do not delete:
84+
- template folders intentionally preserved under `games/`, `samples/`, or `tools/`
85+
- any folder proven necessary for workflow preservation with explicit report note
86+
87+
### 4) Folder ownership validation
88+
Validate that remaining folders align to current ownership rules:
89+
- engine/runtime folders hold runtime code
90+
- shared holds cross-domain reusable helpers
91+
- games hold game-specific implementation
92+
- samples hold learning/demo content
93+
- tools hold editor/pipeline/debug-authoring content
94+
- docs remains organized per prior Track F cleanup
95+
96+
### 5) Clean structure enforcement
97+
Resolve hygiene-only leftovers revealed by the above work, but do not expand into new structural refactors.
98+
99+
## Acceptance
100+
- in-scope import/export anti-patterns removed
101+
- unnecessary `.keep` files removed
102+
- eligible empty folders removed
103+
- protected template keepers preserved where required
104+
- folder ownership validation completed
105+
- clean repo structure enforced within hygiene scope
106+
- no non-hygiene behavior changes introduced
107+
- unrelated working-tree changes preserved
108+
- roadmap updates are status-only and execution-backed
109+
110+
## Validation requirements
111+
Validation must include:
112+
- count of import/export anti-patterns found and fixed
113+
- count of `.keep` files removed and retained with reasons
114+
- count of empty folders removed
115+
- list of protected template keepers left in place
116+
- confirmation that no non-empty folders were deleted
117+
- confirmation that no `start_of_day` files changed
118+
- confirmation that unrelated working-tree changes were preserved
119+
- confirmation that roadmap changes are status-only and limited to Track G items completed here
120+
121+
## Roadmap update rules
122+
Only update status markers in the current repo roadmap file.
123+
124+
Allowed transitions only if fully executed and validated:
125+
- each listed Track G item `[ ] -> [x]`
126+
- parent `Track G - Repo Hygiene` `[ ] -> [x]` only if all Track G sub-items are complete
127+
128+
Do not change Track H in this PR.

‎docs/roadmaps/MASTER_ROADMAP_HIGH_LEVEL.md‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -761,12 +761,12 @@
761761
- [x] align docs to feature-based structure
762762

763763
### Track G � Repo Hygiene
764-
[ ] Remove imports to export (should not be import x, export x)
765-
[ ] Other than templates (games/samples/tools), remove the .keep file, if the folder is empty, delete
766-
- [ ] remove unnecessary `.keep` files
767-
- [ ] remove empty folders
768-
- [ ] validate folder ownership rules
769-
- [ ] enforce clean repo structure
764+
[x] Remove imports to export (should not be import x, export x)
765+
[x] Other than templates (games/samples/tools), remove the .keep file, if the folder is empty, delete
766+
- [x] remove unnecessary `.keep` files
767+
- [x] remove empty folders
768+
- [x] validate folder ownership rules
769+
- [x] enforce clean repo structure
770770

771771
### Track H � PR Consolidation Strategy
772772
- [ ] bundle related PRs into capability-level units

‎src/advanced/events/.keep‎

Whitespace-only changes.

0 commit comments

Comments
 (0)