Use a custom esm cache for coverage testing. #6
Conversation
davidlehn
requested review from
dlongley,
mattcollier,
dmitrizagidulin,
gannan08,
JoshDunnDev and
JSAssassin
test/package.json
Outdated
| @@ -4,8 +4,8 @@ | |||
| "private": true, | |||
| "scripts": { | |||
| "test": "node --preserve-symlinks test.js test", | |||
| "coverage": "cross-env NODE_ENV=test nyc --reporter=lcov --reporter=text-summary npm test", | |||
| "coverage-ci": "cross-env NODE_ENV=test nyc --reporter=lcov npm test", | |||
| "coverage": "cross-env NODE_ENV=test ESM_OPTIONS='{cache:\"node_modules/.cache/esm-coverage\"}' nyc --reporter=lcov --reporter=text-summary npm test", | |||
There was a problem hiding this comment.
nice, can this be part of the package.json or other .npmFOO thing?
There was a problem hiding this comment.
I would like to make this more DRY, but I wasn't sure how that didn't add complexity. We only want ESM_OPTIONS set for coverage commands, so any sort of global config doesn't seem like it would work. I had tried a cross-env-shell version that had a single common command and passed args to it, but that seemed more complex. I pushed a patch to change to disable the cache. Perhaps in the future esm can be fixed or ESM_DISABLE_CACHE=true will work for this use case.
|
For anyone testing, you may need to remove |
Codecov Report
@@ Coverage Diff @@
## main #6 +/- ##
=======================================
Coverage 93.33% 93.33%
=======================================
Files 4 4
Lines 75 75
=======================================
Hits 70 70
Misses 5 5 Continue to review full report at Codecov.
|
- Disabling the esm cache was a preferred fix rather than than more verbose setting of a cache directory. - This also may ease the transition to ESM_DISABLE_CACHE if that becomes more functional for this use case.
davidlehn
force-pushed
the
fix-coverage
branch
from
e0c8501 to
c08a686
Compare
This replaces #4 as a way to fix coverage testing.
c8may still be an option, but this patch is to fix the underlyingesmissue.This fix sets a custom
esmcache directory when running coverage testing. Without a fix like this, mixed running of regular testing and coverage testing can result in incorrect coverage results.This pattern may end up applying to many other packages. Please test and suggest improvements.