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

chore(ps): add code coverage reports #2278

Merged
merged 2 commits into from
Mar 29, 2023
Merged

Conversation

zwhitfield3
Copy link
Contributor

@zwhitfield3 zwhitfield3 commented Mar 27, 2023

Why the change?

GUS Card

As per our review of unit tests and coverage for the ps package, this PR does the following:

  • Adds nyc package to add code coverage reports ✅
  • Ensures that our code coverage reports over 85% test coverage of statements ✅

Additional Notes

  • No additional test failure scenarios to include. Incorrect user inputs have been accounted for.

How to verify?

  1. Pull down branch
  2. Run tests
  3. Confirm test coverage report is visible and that it reports over 85% test coverage of statements

@zwhitfield3 zwhitfield3 requested a review from a team as a code owner March 27, 2023 21:04
@zwhitfield3 zwhitfield3 force-pushed the zw/test-coverage-ps branch from 9f9b07c to 58b71a2 Compare March 27, 2023 21:27
@zwhitfield3 zwhitfield3 temporarily deployed to AcceptanceTests March 27, 2023 21:27 — with GitHub Actions Inactive
@zwhitfield3 zwhitfield3 temporarily deployed to AcceptanceTests March 27, 2023 21:27 — with GitHub Actions Inactive
@zwhitfield3 zwhitfield3 changed the title Add nyc with working script & update .gitignore chore(ps): add code coverage reports Mar 27, 2023
@kenyaplenty
Copy link

Everything looks good to me in terms of the code, but when I run yarn test in the package, I get the following output after the code coverage report. Is there something wrong with my setup? Is this supposed to be happening?

Screenshot 2023-03-28 at 4 41 20 PM

@zwhitfield3 zwhitfield3 temporarily deployed to AcceptanceTests March 28, 2023 23:13 — with GitHub Actions Inactive
@zwhitfield3 zwhitfield3 temporarily deployed to AcceptanceTests March 28, 2023 23:13 — with GitHub Actions Inactive
@zwhitfield3
Copy link
Contributor Author

@kenyaplenty I turned off the explicit-module-boundary-types rule that looks for an explicit return statement in the run functions for the cli commands. The framework doesn't require return statements for the run function in commands as per oclif documentation examples.

As for the support typescript versions, we'll have to update the typescript-estree dependency in a few other command dependencies at a later date. It is not blocking for this PR.

Copy link

@kenyaplenty kenyaplenty left a comment

Choose a reason for hiding this comment

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

LGTM

@zwhitfield3 zwhitfield3 merged commit 1e5c55e into master Mar 29, 2023
@zwhitfield3 zwhitfield3 deleted the zw/test-coverage-ps branch March 29, 2023 16:30
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.

2 participants