CLI for creating reusable, modern React ts libraries using Rollup and storybook.
This package was a upgrade for @21epub/create-parcel-react-library
Implement storybook Component UI environment for npm library creating.
- [x] Easy-to-use CLI
- [x] Handles all modern JS features
- [x] Bundles
- [x] storybook for Component UI implementation
- [x] Rollup for bundling
- [x] Babel for transpiling
- [x] Jest + testing-library for react testing
- [x] Supports complicated peer-dependencies
- [x] Supports CSS modules ( Both less and Sass ) with Storybook
- [x] TypeScript Only
- [x] Sourcemap creation
- [x] lint-staged support
- [X] Conventional commit by
- [X] standard-version support by
npm run release
- [X] Format on Save ( Vscode Editor )
- [X] Travis CI & Code coverage by custom configration
This package requires
node >= 10.
npm install -g @21epub/create-storybook-react-library
Usage with npx
No need to create an empty folder before running.
Creating a New Module
Answer some basic prompts about your module, and then the CLI will perform the following steps:
- copy over the template
- install dependencies via yarn or npm
- install peers vis yarn or npm (You have to do this since peers will not auto installed , dev start will cause error !)
- initialize local git repo
At this point, your new module is ready and is all setup for local development.
Development (with Storybook)
There's only one thing to do your development is enjoy your coding in
npm start # start your Storybook ENV
Now, anytime you make a change to your library in
src/ will live-reload your storybook dev so you can iterate on your component in real-time.
Get Start with Storybook and develop your Component, Reference docs
Update Peers Dependencies
peerDependencies in package.json or install new dependencies
npm run install-peers # reinstall peers after update
Commit Method Recommandation
npm run commit # lint before commit can save your time , and then conventional commit with git-cz
Publishing to npm
npm run release # Version and changelog git push --follow-tags origin master npm publish # The `prePublishOnly` hook will run before publish to build and test your package
es versions of your module to
dist/ and then publishes your module to
Make sure that any npm modules you want as peer dependencies are properly marked as
package.json. The rollup config will automatically recognize them as peers and not try to bundle them in your module.
MIT © 21epub