Skip to content
🎣CLI for easily creating reusable react hooks.
JavaScript HTML TypeScript CSS
Branch: master
Clone or download
Latest commit aed19eb Jul 23, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
lib initial commit Jan 28, 2019
template fix: update babel-eslint and eslint Jul 23, 2019
.editorconfig add missing packages and editorconfig Apr 12, 2018
.eslintrc add basic integration tests Mar 9, 2018
.gitignore fix: move .env into example Jul 20, 2019
.npmignore add demo to readme Mar 5, 2018
.travis.yml
index.js use node-compat-require instead of webpack for node >= 4 support; upd… May 6, 2018
package.json 2.6.18 Jul 23, 2019
readme.md Update readme.md Apr 4, 2019
yarn.lock remove package-lock, update yarn.lock Jul 23, 2019

readme.md

create-react-hook

CLI for creating reusable React hooks using Rollup and create-react-app. Inspired by the amazing create-react-library

NPM Build Status JavaScript Style Guide

How and why I made this tool.

Features

  • Easy-to-use CLI
  • Handles all modern JS features
  • Bundles cjs and es module formats
  • create-react-app for example usage and local dev
  • Rollup for bundling
  • Babel for transpiling
  • Jest for testing
  • Supports complicated peer-dependencies
  • Optional support for TypeScript
  • Sourcemap creation

Install

This package requires node >= 4, but we recommend node >= 8.

npm install -g create-react-hook

Creating a New Hook

create-react-hook

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
  • link packages together for local development
  • initialize local git repo

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 NPM

npm publish

This builds cjs 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.

Deploying to Github Pages

npm run deploy

This creates a production build of the example create-react-app that showcases your library and then runs gh-pages to deploy the resulting bundle.

Examples

Libraries

Here are some example libraries that have been bootstrapped with create-react-hook.

Want to add yours to the list? Submit an issue.

License

MIT © Travis Fischer MIT © Herman Starikov

You can’t perform that action at this time.