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

Allow specifying coverage flags via a yaml file #532

Open
liamappelbe opened this issue Aug 1, 2024 · 2 comments
Open

Allow specifying coverage flags via a yaml file #532

liamappelbe opened this issue Aug 1, 2024 · 2 comments
Labels
good first issue A good starting issue for contributors (issues with this label will appear in /contribute) package:coverage type-enhancement A request for a change that isn't a bug

Comments

@liamappelbe
Copy link
Contributor

Spin off of #510

It's a common pattern for Dart tools to read the default values for all their command line flags from yaml. This lets developers specify flag values once per project, and not have to remember/retype them each time. We should do this for package:coverage's flags.

There are a couple of open questions:

  1. Should we read the config from a field in pubspec.yaml, or define a new coverage.yaml. Ffigen supports both, the analyzer and dart test only support the latter. I'd prefer to have our own yaml config.
  2. We have multiple tools (collect_coverage, format_coverage, run_and_collect, test_with_coverage, and more to come: Add a tool to find uncovered files #529). Do any of their flags have the same name? If not we can just mash them all together into one big config. If there are collisions we might need to group the flags by tool. We'll need to audit all the tool's command line flags and figure out which ones should be exposed in this config, and if any collide.
@liamappelbe liamappelbe added type-enhancement A request for a change that isn't a bug good first issue A good starting issue for contributors (issues with this label will appear in /contribute) labels Aug 1, 2024
@mosuem mosuem transferred this issue from dart-archive/coverage Aug 28, 2024
@khushi-hura
Copy link

Hey @liamappelbe I can work on this issue
Please assign this to me!

@liamappelbe
Copy link
Contributor Author

@khushi-hura The first step is to collect all our tool's command line flags and figure out if any collide, if any are deprecated or redundant, and figure out how we want to structure them in a yaml file. Why don't you look into it and post your findings here, and if your answers looks good I'll assign the bug to you and you can start implementing it. That'll be easier than getting my feedback on the design after you've already implemented it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
good first issue A good starting issue for contributors (issues with this label will appear in /contribute) package:coverage type-enhancement A request for a change that isn't a bug
Projects
None yet
Development

No branches or pull requests

3 participants