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 users to not include macros in their coverage report #56

Closed
ksew1 opened this issue Sep 12, 2024 · 0 comments · Fixed by #57
Closed

Allow users to not include macros in their coverage report #56

ksew1 opened this issue Sep 12, 2024 · 0 comments · Fixed by #57
Assignees
Labels
cairo-coverage Should be done in cairo-coverage

Comments

@ksew1
Copy link
Member

ksew1 commented Sep 12, 2024

Users may not want to include code generated by macros in their coverage report, as they often can't modify the output produced by them. Currently, we can't distinguish between inline macros, attribute macros, and derive macros; this should change in #44. For now, we can add option to include all macros or exclude all of them.

Additionally, we need to redesign our CLI so we don't need to add another flag like --include-macros, as this can possibly create more conflicts. Currently, there are two components that can be included: test functions and macros. We will create a flag named --include that will take a list of additional components that should be included in the coverage report.

CLI Usage Example

cairo-coverage --include test-functions macros
@ksew1 ksew1 self-assigned this Sep 12, 2024
@ksew1 ksew1 added the cairo-coverage Should be done in cairo-coverage label Sep 12, 2024
@ksew1 ksew1 changed the title Allow users to not inclued macros in their coverage report Allow users to not include macros in their coverage report Sep 12, 2024
@ksew1 ksew1 linked a pull request Sep 12, 2024 that will close this issue
@ksew1 ksew1 closed this as completed in #57 Sep 13, 2024
@ksew1 ksew1 closed this as completed in d2cc5c6 Sep 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cairo-coverage Should be done in cairo-coverage
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant