Tool to generate different types of React components from the terminal. 💻
(Introduction article v1) 🛠WIP v2
How much time do you spend copying and pasting the component folder to create a new one ?
This is a tool to generate different types of React components from the terminal.
What you can do with this tool ?
$ npm install -g create-component-app
$ cd ~/my-projects
$ create-component-app
connect
function of reduxjs
jsx
css
scss
sass
less
path
of the new componentCreate-component-app uses cosmiconfig for configuration file support. This means you can configure cca via:
.ccarc
file, written in YAML or JSON, with optional extensions: .yaml/.yml/.json
.cca.config.js
file that exports an object."cca"
key in your package.json
file.The configuration file will be resolved starting from the root of your project, and searching up the file tree until a config file is (or isn't) found.
An example configuration file can be found here: .ccarc.example, you can use this file by copying it to the root of your project.
Currently supported options are:
Option | Description |
---|---|
type |
Default type of the component ["stateless", "class", "pure"] |
templatesDirPath |
Default path to get the templates from the custom templates folder |
path |
Default path to create component file and folder |
jsExtension |
Default extension for your javascript file ["js", "jsx"] |
cssExtension |
Default extension for your css file ["css", "scss", "sass", "less", false] . Set to false if you don't want a style file |
includeTests |
Default flag to include a test file in the folder [true, false] |
includeStories |
Default flag to include a storybook file in the folder [true, false] |
indexFile |
Default flag to create an index file in the folder [false, true] |
connected |
Default flag to integrate connect redux in the index file [false, true] |
componentMethods |
Only for "class" and "pure", insert method inside the component (i.e. ["componentDidMount", "shouldComponentUpdate", "onClick"] ). render and constructor will be always included. |
fileNames |
Choose the specific filename for your component's file. (COMPONENT_NAME will be replaced) |
fileNames.testFileName |
specify the file name of your test file |
fileNames.componentFileName |
specify the component file name |
fileNames.styleFileName |
specify the style file name !!IMPORTANT: Include cssExtension. |
config.json
:$ create-component-app --config path/to/your/config.json
Passing a config file via the CLI overrides the configuration file loaded by cosmiconfig
$ create-component-app --path path/destionation
Passing a param via the CLI overrides the configuration file loaded by cosmiconfig
Simple steps to create your own templates docs/custom-templates
Now, the first question that you receive is Do you wanna choose a template?
if you answer yes, you can see the list of templates from the community.
templatesDirPath
- a custom path to the user custom templates folder.templates
- a list of used templates (with a default) to filter the listcreate-component-app -t templateName
Now, the community can offer their templates! How?
Check the issue list to contribute on some activities or to advice new features! The library is open to everybody, contribute improve your skills.
create-component-app
is maintained under the Semantic Versioning guidelines.
Use npm run watch
while coding.
MIT © Christian Varisco