Repository navigation
Generate FILE_TREE.md from the source tree and check it in CI - #79
Merged
Merged
Conversation
FILE_TREE.md was maintained by hand and drifted: the module counts were off (144 listed, 146 present) and InterlacingPR.lean and Grouping.lean were missing from the tree. - Add scripts/file_tree.py, which regenerates the whole file (counts, layer total and tree) from StatsMLlib/, and with --check exits 1 and prints a diff when the committed file is stale. - Regenerate FILE_TREE.md. - Add a file-tree CI job running the check. - Document the regeneration step in CONTRIBUTING.md. Co-Authored-By: Claude Opus 5.5 <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
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.
FILE_TREE.mdwas maintained by hand and kept drifting. Onmainit listed 144 modules where146 exist (
LinearAlgebra6 vs 7,Probability68 vs 69), andInterlacingPR.leanandGrouping.leanwere missing from the tree.Changes
scripts/file_tree.pyregenerates the whole file fromStatsMLlib/: per-layer counts, thetotal, the number of layer-one directories and the tree (directories first, then files, each
sorted).
--checkrewrites nothing; it prints a unified diff and exits 1 when the committedfile is stale. The generated file carries a "do not edit by hand" comment.
FILE_TREE.mdregenerated. Besides the fixes above,EmpiricalProcess/now sorts beforeEmpiricalRiskMinimization/.file-treejob runspython3 scripts/file_tree.py --check. It needs no Leantoolchain and takes seconds.
CONTRIBUTING.md: runpython3 scripts/file_tree.pyafter adding, moving or deleting amodule.
Testing
A throwaway harness ran the script on a temporary copy of the tree. All 10 scenarios passed:
🤖 Generated with Claude Code