chore: configure jest coverage #1222
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
* next: Bump Maze Runner version for local running test(bugsnag-integrity): enforce integrity header for Expo
djskinner
commented
Jan 6, 2021
| @@ -1,5 +1,4 @@ | |||
| import BugsnagBrowserStatic from '..' | |||
| import { Breadcrumb, Session } from '../types/bugsnag' | |||
| import BugsnagBrowserStatic, { Breadcrumb, Session } from '../src/notifier' | |||
There was a problem hiding this comment.
Change to test against src rather than dist or coverage doesn't report correctly. As a consequence we lose the types, hence the colocated definitions file above that re-exports the types.
| @@ -1,22 +0,0 @@ | |||
| /* global jest */ | |||
There was a problem hiding this comment.
This appears to be unused
| @@ -27,11 +41,12 @@ module.exports = { | |||
| 'plugin-window-onerror', | |||
| 'plugin-strip-query-string', | |||
| 'plugin-interaction-breadcrumbs', | |||
| 'plugin-inline-script-content', | |||
There was a problem hiding this comment.
This oversight was picked up by the coverage report
bengourley
approved these changes
Jan 11, 2021
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Goal
To monitor code coverage and ensure high / increasing code quality.
Design
This is a fairly standard approach to generating code coverage reports with jest. jest supports many Istanbul reporters which are compatible with a range of viewers and CI setups.
This setup also includes files that do not have corresponding test files so provides a more accurate picture of the actual coverage of source.
This will also support (with additional work) danger bot to add code coverage comments on PRs.
Changeset
package.jsonmainproperty was being used to resolve the import. This lead to tests being run on thedist/output. Whilst testing on the final output has its merits it is more common to test against the source. If we run the tests against thedist/output the coverage for the source file will be reported as zero.package.jsontypesfield.Testing
automated build and tests passing