fix: nyc command with shard option

[bryanjtc]

Fixes: #256
Added a new environment variable to check if the shard cli option is used to run the nyc command conditionally.

📦 Published PR as canary version: 0.10.1--canary.257.aa7a0c9.0

✨ Test out this PR locally via:

npm install @storybook/test-runner@0.10.1--canary.257.aa7a0c9.0
# or 
yarn add @storybook/test-runner@0.10.1--canary.257.aa7a0c9.0

Version

Published prerelease version: v0.11.0-future.4

Changelog

🚀 Enhancement

• Bundle with tsup and replace babel-jest #250 (@bryanjtc @yannbf @ndelangen)

🐛 Bug Fix

• fix: nyc command with shard option #257 (@bryanjtc @yannbf)
• Improve ejected config types #297 (@yannbf)
• fix: Remove last reference to regenerator-runtime #303 (@bryanjtc)
• fix(test-storybook): Fix test-runner-jest.config.js file not being found in STORYBOOK_CONFIG_DIR on Windows #296 (@unshame)
• Upgrade glob to v10 #299 (@valentinpalkovic)

Authors: 5

• Bryan Thomas (@bryanjtc)
• Norbert de Langen (@ndelangen)
• UnShame (@unshame)
• Valentin Palkovic (@valentinpalkovic)
• Yann Braga (@yannbf)

[codecov-commenter]

Codecov Report

Patch coverage has no change and project coverage change: -1.33 ⚠️

Comparison is base (63fd8ae) 76.63% compared to head (aa7a0c9) 75.30%.

Additional details and impacted files

@@            Coverage Diff             @@
##           future     #257      +/-   ##
==========================================
- Coverage   76.63%   75.30%   -1.33%     
==========================================
  Files          11        8       -3     
  Lines         184      166      -18     
  Branches       39       35       -4     
==========================================
- Hits          141      125      -16     
+ Misses         43       41       -2     

see 3 files with indirect coverage changes

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

[yannbf]

Hey @bryanjtc thank you so much for this contribution (and the many others)!

Does this mean that for developers using shard option, they should figure out how to do the reporting themselves?

[bryanjtc]

Hey @bryanjtc thank you so much for this contribution (and the many others)!

Does this mean that for developers using shard option, they should figure out how to do the reporting themselves?

Yes. Especifically the coverage.json file for each ci job should be renamed using the shardIndex value.
Then a new ci job has to merge this coverage.json files using the nyc merge command to output the complete report.

[yannbf]

Could you assist in writing some sort of recipe? Also there should be extra changes in reportCoverage I assume? To have the renaming bit right

[bryanjtc]

Could you assist in writing some sort of recipe? Also there should be extra changes in reportCoverage I assume? To have the renaming bit right

yeah

[bryanjtc]

@yannbf Done. The renaming part should be done in the yml ci file. I added a recipe for github, gitlab and circle ci.

[yannbf]

You're the best @bryanjtc, thanks a lot for this contribution! There were some small issues regarding watch mode so I added a few fixes as well.

[github-actions]

🚀 PR was released in v0.11.0 🚀