Expose tree report as standalone cbi-tree utility #167
Conversation
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
Pennycook
added
enhancement
This initial commit just moves the existing functionality. Other changes to reflect the new standalone nature of the utility (e.g., improved formatting, additional options) will follow in subsequent commits. Signed-off-by: John Pennycook <[email protected]>
The currently intended workflow for cbi-tree is to run codebasin first, and ensure that it accurately analyzes the code base. As such, we do not need to display the full set of warnings from cbi-tree. Over time, we can improve this workflow by making the relationship explicit (e.g., by having codebasin produce a results directory that cbi-tree reads). Signed-off-by: John Pennycook <[email protected]>
Only printed by cbi-tree. Signed-off-by: John Pennycook <[email protected]>
Excludes unused files from the output and computed metrics. Signed-off-by: John Pennycook <[email protected]>
Signed-off-by: John Pennycook <[email protected]>
Signed-off-by: John Pennycook <[email protected]>
Signed-off-by: John Pennycook <[email protected]>
|
The new regression test introduced in d37e8c0 resulted in a horrible merge conflict (because the tests look very similar). The easiest solution was just to rebase the new |
Although --prune is a "long option", that's not what the "long" in "is_long" refers to. Because --prune doesn't have a shorthand and doesn't accept an argument, the description of the option is not long enough to generate an initial newline. Signed-off-by: John Pennycook <[email protected]>
laserkelvin
approved these changes
Apr 3, 2025
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.
Related issues
Proposed changes
-R treeoption fromcodebasin, replacing it with a standalonecbi-treescript.--levelsoption inspired bytree, which gives users control over how deep the tree should be.--pruneoption inspired bytree, which gives users control over handling of unused files.@laserkelvin, since you originally requested this functionality, I'd appreciate it if you could download this one and experiment with it a little bit in addition to reviewing the code, to make sure that it behaves the way that you would expect.
I was a little uncertain about the output format, because it's no longer a report that is generated from
codebasin. At the time of opening this PR, the output looks like this:...where we lose quite a lot of vertical space to the legend and column headings. Utilities like
ls -landtreedon't provide any sort of explanation as part of their default output, and I wonder if we should follow that precedent. For example, is this better: