gc-react

gc-react is a cli tool to generate react components quickly. You can use one of the templates or add your own to cut down on the boilerplate typing time and to reduce typos.

Installation

Choosing a template

Create a component

Delete a component

Options

Installation

1) Install the module

With npm

$ npm install gc-react --save-dev

With yarn

$ yarn add gc-react -D

2) Add the script to your package.json file

// package.json

"scripts":{

    ...
    
    "gc":"gc"

}

Note : You can also install the module globally

$ npm install -g gc-react

Creating a component

Make sure to replace 'component_name' with the name of the component you want to create.

With yarn

In the root of your react project

$ yarn gc create 'component_name'

With npm

In the root of your react project

$ npm run gc create 'component_name'

Installed globally

$ gc create 'component_name'

Deleting a component

Make sure to replace 'component_name' with the name of the component you want to create.

With yarn

In the root of your react project

$ yarn gc remove 'component_name'

With npm

In the root of your react project

$ npm run gc remove 'component_name'

Installed globally

$ gc remove 'component_name'

Options

You can specify options with command line arguments and/or by creating a gc-react.config.json file at the root of your project.

Typing --template yourtemplate all the time gets tedious, so you should at least create the file and specify the template.

// filename : gc-react.config.json

{
    "template" : 'fireship',
}

--dry-run

Logs the expected output without writing the files

--quiet

No console.log describing the execution

--global-styles

If specified, the command will try to find and add an import to a styles/global.scss file. Should be used with the ts-globalScss template.

Component Template

--template

Specify the template to start from. Currently available :

• fireship
• ts-globalScss
• js-nextjs
• ts-nextjs
• ts-tailwind

specifying a template with command line argument example:

$ gc create navbar --template fireship

If you want to add a new template or modify one, contact us and we will gladly add it.

Otherwise, you can overwrite the default template folder by creating your own at the root of your project.

Given that you have a 'template' folder at the root of your project, the tool will look for a 'template/$customTemplateName' folder instead of using one of the builtin ones

---

Using a gc-react.config.json file

// filename : gc-react.config.json

{
    "dryRun": boolean,
    "template" : string,
    "quiet: boolean
}

TODO

Add a warning when trying to remove a component that does not exists

Easier to read error when template from options or cli arguments does not exists