generator-react-lib-ts

Yeoman generator for react lib with typescript

Installation

Install Yeoman first:

npm install -g yo

Then you can install this generator

npm install -g generator-react-lib-ts

Done!

Of course you can also do it with Yarn or integrate it into your npm/yarn scripts

Generating a new component

# make sure yo and generator-react-lib-ts is installed globally or let npm/scripts to do it. 
yo react-lib-ts
 
# Then the generator will ask you to input the name of your library, the path for your lib folder, 
# and let you choose the type for your library. 
 

Usage

The following commands are available in your project:

# build your library. The output is uglified umd bundle with source map files. 
yarn build
 
# run tests. Powered by jest. 
yarn test
 
# linting your code. 
yarn lint
 
# start local storybook demos 
yarn storybook
 
# build local static storybook output 
yarn build:demo

Release notes

2.0.0

• Refresh the whole pipeline. Brand new build, lint processes.
• Introduces storybook for better local develop experience.

1.5.0

• Sass support for custom styling.

1.4.0

• Test performance optimazation.
• Better tslint rules and tsconfig for better readibility(Not compatible with older rules)

1.3.0

• If you want to create a component based on fabric-ui, you will see the option to support it!

1.2.0

• Upgrading to react 16.8.2
• Adding functional component with react hooks template
• Fixed tsconfig issues and tslint issues.

1.1.0

• Embrace babel to compile typescript. ts-loader deprecated.
• Allow "yarn run dev" to start a live demo page on your localhost:8080 with HMR support.
• Update docs