Skip to content

yannvr/react-components-cli

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

50 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

React styled component generator

"Automate every single boring and repetitive tasks" -- DevOps Handbook

Create a styled component with test (Jest ready) including optionals story and style component. Supports Typescript.

Create components based on the following structure (example given in js)

  • src/components/new-component/index.jsx
  • src/components/new-component/test.jsx
  • src/components/new-component/story.js (optional)
  • src/components/new-component/style.js (optional)

Installation

  • yarn global add react-components-cli

Note: You will need to add yarn global bin to your path like adding export PATH="$(yarn global bin):$PATH" in your .bashrc or .zshrc (or whatever on windows)

Usage

  • Create any components type using prompts:
    • create-component (note: if global not found, add yarn global dir to your PATH)

Examples

  • create-component -- --name FunctionComponent --directory src/components --componentType stateless --styled true --story false --componentCase camel will create a function component <FunctionComponent /> in src/component/profile including test and story files

screen recording

TODO

  • Cypress template

Note: the template can generate unstyled component but you'll just have to remove styled component references. PR welcome for different handling templates with other conventions/libraries