JimmyBeldone/mk-react-comp

React CLI allowing you to create react components from the command line with lots of customizations.

Make React Components

React CLI allowing you to create react components from the command line with lots of customizations. webpack-bundle-analyser to visualize size of output files with an interactive zoomable treemap.

Make React Components

Installation

Via Yarn (or NPM)

Make sure to install this module globally so you can run the command from anywhere.

yarn global add mk-react-comp

or

npm install -g mk-react-comp

Usage

Usage:
    $ mkreact [action] <component(s) name(s)> [options]

Action:
    (optional) Actions can be defined in 'mkreactconfig.js' to choose path where components will be created

Options:
    -v, --version              Outputs the version number (e.g rc -v)
    -h, --help                 Prints out usage options
    -d, --dir                  Creates a [component name] directory with component file inside. (Default is only the component file)
    -p, --pkg                  Includes a package.json file with component
    --stateless, -s            Generates the stateless functional component. (Default is ES6 class).
    --jsx                      Creates the component with `.jsx` extenstion. (Default is `.js`)
    --entry                    Bootstraps the component with the 'ReactDOM.render' function.
    --css,--styl,--less, -scss Create and choose your css preprocessor to generate
    --full, -f                 Generate folder with a .js file for functional part, a .jsx file with stateless functional component as template, and a style file
    --lifecycle, -l            Include React lifecycle functions in template
    --redux, -r                Includes redux lib import and its functions

mkreactconfig.js

This file must be in your app's root folder

You can use this file to define actions that will generate your components in provided path

// Config File exemple
module.exports = [ {
      lib: 'containers',
      path: './src/views/containers/'
  },
  {
      lib: 'components',
      path: './src/views/components/'
  },
  {
      lib: 'pages',
      path: './src/views/pages/'
  },
  {
      lib: 'layouts',
      path: './src/views/layouts/'
  }
]

This way, you can now use containers as action :

mkreact containers Header,Footer -d --styl

will generate

root
 └-- src
    └-- views
       └-- containers
          └-- Header
              ├-- Header.js
              └-- Header.styl
          └-- Footer
              ├-- Footer.js
              └-- Footer.styl

Examples

Create Home component file that mounts to the DOM

mkreact Home --entry

will generate this Home.js file

import React, { PureComponent } from 'react'
import PropTypes from 'prop-types'
import ReactDOM from 'react-dom'

export default class Home extends PureComponent {
    render() {
        return (
            <div className="home">

            </div>
        )
    }
}

ReactDOM.render(<Home/>, document.getElementById('app'))

Create Header component folder with appropriate component files and a package.json

mkreact components Header -d --jsx -pkg --styl

will generate 3 files

└─ Header/
   ├─ Header.jsx         -> With ES6 Markup of a React component
   ├─ Header.styl        -> Stylus stylesheet
   └─ package.json       -> With name, main and version number markup included

Contributing

Contributions are welcome ! See contributing guidelines

License

MIT

Copyright (c) 2019 Jimmy Beldone