search

saucelabs / sauce-docs

Documentation for the Sauce Labs Platform
https://docs.saucelabs.com
MIT License
20 stars 98 forks source link

Incorrect package in Storybook integration guide #2975

Closed zachwolf closed 1 week ago

zachwolf commented 2 weeks ago

📃 Documentation Issue

Have you read the Contributing Guidelines on issues?

Description

Doc URL: Storybook Integration (Deployed) and markdown

While following the getting started guide, suggested command npx test-storybook --eject fails with could not determine executable to run. I believe this command is incorrect

test-storybook is a package that hasn't been updated in ~7 years

Getting Started Step 1 links to Storybook's instructions, which mentions @storybook/test-runner. Switching to npx that package outputs what I assume is the correct behavior per the existing docs, e.g.: "The above should have created a file in the root directory, test-runner-jest.config.js"

Suggested Fix

Update instructions to use storybook's package

- npx test-storybook --eject
+ npx @storybook/test-runner --eject

Documentation Checklist

omacranger commented 2 weeks ago

Hey! Thanks for pointing this out! The current guide works if the package is already installed since it's finding the test-storybook 'binary' installed by @storybook/test-runner at /node_modules/.bin/test-storybook. I think that's a good point though and this should be updated. Let me put a PR together.