vfs-create-widget v1.0.4
vfs-create-widget
CLI for creating react widgets and connect them to VFS Azure feed
Credits: based on the project from Travis Fischer named create-react-library
Features
- Easy-to-use CLI
- Handles all modern JS features
- Bundles
commonjs
andes
module formats - create-react-app for example usage and local dev
- Rollup for bundling
- Babel for transpiling
- Jest for testing
- Supports complicated peer-dependencies
- Supports CSS modules
- Sourcemap creation
Install globally
This package requires node >= 10
.
npm install -g create-react-library
Usage with npx
npx create-react-library
(npx comes with npm 5.2+ and higher, see instructions for older npm versions)
Creating a New Module
vfs-create-widget
Answer some basic prompts about your module, and then the CLI will perform the following steps:
- copy over the template
- link packages together for local development
At this point, your new module should resemble this screenshot and is all setup for local development.
Development
Local development is broken into two parts (ideally using two tabs).
First, run rollup to watch your src/
module and automatically recompile it into dist/
whenever you make changes.
npm start # runs rollup with watch flag
The second part will be running the example/
create-react-app that's linked to the local version of your module.
# (in another tab)
cd example
npm start # runs create-react-app dev server
Now, anytime you make a change to your library in src/
or to the example app's example/src
, create-react-app
will live-reload your local dev server so you can iterate on your component in real-time.
Publishing to Azure feed
npm version <new_version>
npm publish
This builds commonjs
and es
versions of your module to dist/
and then publishes your module to npm
.
Make sure that any npm modules you want as peer dependencies are properly marked as peerDependencies
in package.json
. The rollup config will automatically recognize them as peers and not try to bundle them in your module.
Use with React Hooks
If you use react-hooks in your project, when you debug your example you may run into an exception Invalid Hook Call Warning. This issue explains the reason, your lib and example use a different instance, one solution is rewrite the react
path in your example's package.json
to 'file:../node_modules/react' or 'link:../node_modules/react'.
Examples
Multiple Named Exports
Here is a branch which demonstrates how to use multiple named exports. The module in this branch exports two components, Foo
and Bar
, and shows how to use them from the example app.
Material-UI
Here is a branch which demonstrates how to make use of a relatively complicated peer dependency, material-ui. It shows the power of rollup-plugin-peer-deps-external which makes it a breeze to create reusable modules that include complicated material-ui subcomponents without having them bundled as a part of your module.
Boilerplate
The CLI is based on this boilerplate, which you can optionally read about here.