GitHub/storybook
1
0
Fork 0
mirror of https://github.com/storybookjs/storybook.git synced 2025-04-05 06:41:17 +08:00
Code Issues Packages Projects Releases Wiki Activity

Update Codemod docs

Browse Source
This commit is contained in:
Michael Shilman 2019-07-14 13:28:57 +08:00
parent 84b2bd0684
commit a554f4ff2c
1 changed files with 18 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
lib/codemod/README.md
View File

@ -3,8 +3,26 @@
Storybook Codemods is a collection of codemod scripts written with JSCodeshift.
It will help you migrate breaking changes & deprecations.
## CLI Integration
The preferred way to run these codemods is via the CLI's `migrate` command.
To get a list of available codemods:
```
npx -p @storybook/cli sb migrate --list
```
To run a codemod:
```
npx -p @storybook/cli sb migrate name-of-codemod --glob "**/*.stories.js"
```
## Installation
If you want to run these codemods by hand:
```sh
yarn add jscodeshift @storybook/codemod --dev
```