Skip to content

Latest commit

 

History

History
53 lines (41 loc) · 1.96 KB

readme.md

File metadata and controls

53 lines (41 loc) · 1.96 KB
Raw

React Library Generator

Powerful CLI for creating a React libraries

React library generator is a CLI that helps you to build a scaffold for your library. It's fully customizable, and you can determine what you want. Also, this CLI create documentation for your library and provide various test utilities.

Features

  • Simple to use CLI and fully customizable
  • ES6 and Flow syntax support
  • Testing (Jest, Ava, Enzyme)
  • Different supported style languages (Sass, Less, PostCSS, CSS)
  • Documentation (Docz)
  • Rollup for Bundling
  • Bundles es and cjs module formats
  • Babel for Transpiling
  • Source map creation
  • Automatic code linting via esLint
  • Supports peer-dependencies
  • Protect your git branches with Husky
  • Check Library name availability on NPM before generating

Installation

npm i -g react-library-generator

yarn add global react-library-generator

Usage

$ react-library-generator

Library structure

The following file tree has represented the structure of the library. You can develop your component on the src folder and writes tests on the tests folders. 😄

At the moment, we use Docz for documentation and demo. but In the future, we provide other utilities such as Storybook for documentation.

Note! We don't intend to restrict you to this structure, so all parts can be changed.

License

MIT © Jalal Azimi