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

Update readme for default outputDirectory setting #35

Open
jasonkaedingCGI opened this issue Apr 5, 2021 · 0 comments
Open

Update readme for default outputDirectory setting #35

jasonkaedingCGI opened this issue Apr 5, 2021 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@jasonkaedingCGI
Copy link

Describe the bug
The README.md file states that the default outputDirectory setting is the project root directory, but code demonstrates that it will default to the Jest coverageDirectory setting. It is a good thing that it does default to coverageDirectory, this allows me to configure the coverageDirectory in my CI build pipeline and everything works great and ends up in the right place!

To Reproduce
Steps to reproduce the behavior:

  1. Set up the jest-sonar reporter. Do NOT configure the outputDirectory setting.
  2. Configure the coverageDirectory to something far away from the project such as C:\test-results
  3. Run jest tests
  4. Look for the output file in coverageDirectory

Expected behavior
PLEASE DON'T CHANGE THE ACTUAL BEHAVIOR! It is useful as-is. Just update the docs so users are not confused.

Desktop (please complete the following information):

  • OS: Windows
  • NodeJS version 12.x

Additional context
Just a documentation update. I noticed how the code behaves by looking at https://github.com/sh33dafi/jest-sonar/blob/master/src/jest-sonar.js line 43.

@sh33dafi sh33dafi added documentation Improvements or additions to documentation good first issue Good for newcomers labels Apr 20, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants