Get unlimited public & private packages + package-based permissions with npm Pro.Get started »

cralib

1.0.2 • Public • Published

cralib

CLI for creating reusable, modern React libraries using Rollup and create-react-app.

NPM Build Status JavaScript Style Guide

Intro

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
  • Supports complicated peer-dependencies
  • Hundreds of public modules created
  • Thorough documentation 😍

Install globally

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

npm install -g cralib

Usage with npx

npx cralib

(npx comes with npm 5.2+ and higher, see instructions for older npm versions)

Creating a New Module

cralib

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

At this point, your new module should resemble this screenshot and is all setup for local development.

Now, anytime you make a change to your library in packages/library/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.

License

MIT © GroverTB

Install

npm i cralib

DownloadsWeekly Downloads

0

Version

1.0.2

License

MIT

Unpacked Size

66.1 kB

Total Files

46

Last publish

Collaborators

  • avatar