piyush-bhatt/generate-component-react

CLI generator for ReactJS components based on specified name and options.

generate-component-react

generate-component-react is a CLI generator for ReactJS components based on specified name and options.

Content

• Installation
• Usage
  • Functional Component
  • Class Based Component
  • Options
• Examples
• Contributing
• License

Installation

Use the package manager npm to install

npm install -g generate-component-react

Usage

Make sure to execute the commands from your app root directory

Functional Component

generate component <component-name> -f

or

gc <component-name> --function

Class Based Component

generate component <component-name> -c

or

gc <component-name> --class

Options

Following options can be used optionally,

--css : add a CSS module for the generated component, e.g.,

generate component <component-name> --class --css

-s or --state : add state to the generated component, e.g.,

generate component <component-name> --class --state

Examples

• Sample component (functional component with state and css):

  generate component sample --function --css --state
  
  CREATED <app-root-dir>\src\sample\sample.css
  CREATED <app-root-dir>\src\sample\sample.js
  CREATED <app-root-dir>\src\sample\index.js

• Sample component (class based component without state but with css):

  generate component sample --class --css
  
  CREATED <app-root-dir>\src\sample\sample.css
  CREATED <app-root-dir>\src\sample\sample.js
  CREATED <app-root-dir>\src\sample\index.js

• Sample component (functional component in nested directory without state and css):

  generate component components/sample --function
  
  CREATED <app-root-dir>\src\components\sample\sample.js
  CREATED <app-root-dir>\src\components\sample\index.js

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

License

MIT