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.
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
With npm
In the root of your react project
Installed globally
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
With npm
In the root of your react project
Installed globally
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.
--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 :
specifying a template with command line argument example:
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
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