Docs: Update test-runner-coverage.md NPM example

[gavhuang]

What I did

Remove extra dashes from NPM example. If a developer attempts to run as-is, empty coverage reports are generated.

Checklist for Contributors

Testing

The changes in this PR are covered in the following automated tests:

• stories
• unit tests
• integration tests
• end-to-end tests

Manual testing

N/A

Documentation

• Add or update documentation reflecting your changes
• If you are deprecating/removing a feature, make sure to update
  MIGRATION.MD

Checklist for Maintainers

• When this PR is ready for testing, make sure to add ci:normal, ci:merged or ci:daily GH label to it to run a specific set of sandboxes. The particular set of sandboxes can be found in code/lib/cli-storybook/src/sandbox-templates.ts

• Make sure this PR contains one of the labels below:

  Available labels

  • bug: Internal changes that fixes incorrect behavior.
  • maintenance: User-facing maintenance tasks.
  • dependencies: Upgrading (sometimes downgrading) dependencies.
  • build: Internal-facing build tooling & test updates. Will not show up in release changelog.
  • cleanup: Minor cleanup style change. Will not show up in release changelog.
  • documentation: Documentation only changes. Will not show up in release changelog.
  • feature request: Introducing a new feature.
  • BREAKING CHANGE: Changes that break compatibility in some way with current major version.
  • other: Changes that don't fit in the above categories.

🦋 Canary release

This PR does not have a canary release associated. You can request a canary release of this pull request by mentioning the @storybookjs/core team here.

core team members can create a canary release here or locally with gh workflow run --repo storybookjs/storybook canary-release-pr.yml --field pr=<PR_NUMBER>

Greptile Summary

Updates the npm command syntax in test coverage documentation by removing extra dashes that were causing empty coverage reports.

• Fixed npm command from npm run test-storybook -- --coverage to npm run test-storybook --coverage in /docs/_snippets/test-runner-coverage.md
• Existing pnpm and yarn commands were already correct and remain unchanged

[greptile-apps]

LGTM

_{1 file(s) reviewed, no comment(s)
Edit PR Review Bot Settings | Greptile}

[kylegach]

Hi, @gavhuang. Thanks for this PR.

I just checked in a project using [email protected] and the snippet worked as expected:

• npm run test-storybook -- --coverage: Ran with coverage enabled
• npm run test-storybook --coverage: Ran without coverage enabled

So, I'm not sure why it did not work for your project, but the snippet is correct.

I also looked up the behavior of the -- when running npm scripts, which also matches the current snippet:

Any positional arguments are passed to the specified script. Use -- to pass --prefixed flags and options which would otherwise be parsed by npm.
— npm docs

[gavhuang]

@kylegach thanks! I believe this is where I went wrong:

In my package.json, I had:

"scripts": {
  "test-storybook": "test-storybook -- --coverage",
},

So when I run npm run test-storybook, this is incorrect because I should be explicitly passing in the flag like so:

"scripts": {
  "test-storybook": "test-storybook --coverage",
},

[kylegach]

Oh! Yes, that's exactly it.

The extra -- is only necessary when executing via npm run ....

Nicely found!