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

Changing coverlet output format to receive a list of formats #2562

Merged
merged 3 commits into from
May 3, 2021
Merged

Changing coverlet output format to receive a list of formats #2562

merged 3 commits into from
May 3, 2021

Conversation

lucasteles
Copy link
Contributor

@lucasteles lucasteles commented Dec 23, 2020

Description

Shoud be possible to pass multiples output formats to coverlet

See here

fixes #2563

@lucasteles lucasteles changed the title changing the output format to receive a list of formats Changing coverlet output format to receive a list of formats Dec 23, 2020
@lucasteles
Copy link
Contributor Author

lucasteles commented Dec 23, 2020

I cant figure why the build broke

@github-actions
Copy link
Contributor

There has not been any activity in this pull request for the last 3 months so it will be closed in 14 days if there is no activity.

@github-actions github-actions bot added the stale label Mar 24, 2021
@yazeedobaid
Copy link
Collaborator

The build for this PR should be fixed now after merging #2574.

@lucasteles
Copy link
Contributor Author

@yazeedobaid it worked! thanks! can you review this?

@yazeedobaid
Copy link
Collaborator

@lucasteles Thanks for the update!
Here my notes on the PR:

  1. As mentioned in the issue for this PR, if output formats have multiple values it should enclose them in quotes and escape these quotes. Please see Coverlet documentation page. Also as I understand Coverlet in FAKE is used with dotnet test command, so the escaping should not affect Linux or build environments per this note in Coverlet documentation also?
  2. The API now accepts a list of output formats, so users who use the module need to update their code to make the output format argument passed as a list, even if they use one output format. I'm not sure but this introduces a breaking change to the API. What do you think?

Thanks

@lucasteles
Copy link
Contributor Author

Thanks @yazeedobaid !

1 - About the escape quotes, I thought that FAKE already do that because other comma separated params are not escaped inside the command construction, but I do not checked it in the code tho, am I wrong?

2 - Yeah, I see this as a breaking change, we could create other property which is a list of outputs types and keep the old way too, so when we have a list we prioritise it, when not, just use the old single output. But this can turn the API a bit confusing. WDYT?

@github-actions github-actions bot closed this Apr 24, 2021
@yazeedobaid yazeedobaid reopened this Apr 26, 2021
@yazeedobaid
Copy link
Collaborator

@lucasteles Thanks for the update!
For the first point did you see any need to add the escape quotes to the arguments? If it is working for you without them then I guess it is ok. For the breaking change, as you said it will make the API a bit confusing. So we can add this as a minor breaking change in the next FAKE minor release.

Also, could you please link this issue #2563 to the PR so that when it is merged the issue will be closed automatically.
Thanks

@lucasteles
Copy link
Contributor Author

lucasteles commented Apr 26, 2021

@yazeedobaid yeah, it worked

Also, could you please link this issue #2563 to the PR so that when it is merged the issue will be closed automatically.
Thanks

Done!

Copy link
Collaborator

@yazeedobaid yazeedobaid left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks

Copy link
Collaborator

@yazeedobaid yazeedobaid left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks

Copy link
Collaborator

@yazeedobaid yazeedobaid left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks

@yazeedobaid yazeedobaid merged commit b4e5e63 into fsprojects:release/next May 3, 2021
yazeedobaid pushed a commit that referenced this pull request Nov 11, 2021
* changing the output format to receive a list of formats

* wip

* Revert "wip"

This reverts commit 6bf28d9.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Coverlet output format should receive a list of formats
2 participants