generate-react-cli

generate-react-cli

Why?

To help speed up productivity in react projects. For example you can run one command (generate-react component <ComponentName>) to instantly generate a component with its corresponding files (stylesheet, test).

We are starting off with the bare minimum of just generating a component. We plan to add additional commands, options, and configurations in the future.

Few notes:

• We assume that your project was created using create-react-app. Therefore it is using Jest & Enzyme for testing.
• The CLI also has an opinion on how files are structured within the project. We follow Grouping by features or routes

Install

Run

npm i -g generate-react-cli

Commands

Generate Component

Run

generate-react component <ComponentName>

This will create a folder with your component name within the src/components directory, and it will generate 3 corresponding files (.js, .css, test.js) within it.

Options

You can also provide a custom path to where you want the component to be generated in:

generate-react component <ComponentName> -p src/pages => will create a component folder within the src/pages.

Coming Soon

• CLI custom configuration: e.g. preprocessor stylesheet type, choose different test framework, choose different file structure type, etc..

Have fun!

Changelog

1.1.0 (2019-08-04)

Features

• initial base features of generate react cli

Chores

• add readme