Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Split tree functionality into standalone utility #152

Open
3 tasks
Pennycook opened this issue Jan 20, 2025 · 0 comments
Open
3 tasks

Split tree functionality into standalone utility #152

Pennycook opened this issue Jan 20, 2025 · 0 comments
Assignees
Labels
enhancement New feature or request
Milestone

Comments

@Pennycook
Copy link
Contributor

Feature/behavior summary

The functionality that is currently exposed by -R files should be exposed as a dedicated cbi-tree utility instead.

Request attributes

  • Would this be a refactor of existing code?
  • Does this proposal require new package dependencies?
  • Would this change break backwards compatibility?

Related issues

Initially proposed by @laserkelvin in #147.

Solution description

  • Remove the -R files option.
  • Add a new cbi-tree utility accepting similar options to codebasin (e.g., -x, analysis.toml).
  • Rename cbicov to cbi-cov (for consistency with cbi-tree, which is easier to read than cbitree).

Additional notes

Making cbi-tree into a standalone tool opens up some interesting possibilities for future work, including:

  • Adjusting the default output (e.g., to suppress warnings);
  • Adding new, tree-specific, command-line options.
@Pennycook Pennycook added the enhancement New feature or request label Jan 20, 2025
@Pennycook Pennycook self-assigned this Jan 20, 2025
@Pennycook Pennycook added this to the 2.0.0 milestone Jan 20, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant