lkostrowski / create-component-app Goto Github PK

(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 ?

• You can use templates from the community 🎉
• Create your components guided from terminal with a lot of choices
• You can create a configuration file in your current project directory
• You can also pass a configuration file from params
• You can use your own custom templates
• Share your template to the community

$ npm install -g create-component-app

$ cd ~/my-projects
$ create-component-app

• Create different kind of components:
  • stateless
  • class
  • pure
  • custom
• Set name of the new component
• Integrate connect function of redux
• Include an index file
• Set a different component extension
  • js
  • jsx
• Set a different style extension
  • css
  • scss
  • sass
  • less
• Include a storybook file
• Include a test file (with enzyme)
• Set the destionation path of the new component

Create-component-app uses cosmiconfig for configuration file support. This means you can configure cca via:

• A .ccarc file, written in YAML or JSON, with optional extensions: .yaml/.yml/.json.
• A cca.config.js file that exports an object.
• A "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:

1. Create a JSON file config.json:
2. and pass the path to config param

$ 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.

• (Optional) Add to the settings templatesDirPath - a custom path to the user custom templates folder.
• (Optional) Add to the settings templates - a list of used templates (with a default) to filter the list
• (Optional) The user can choose between the available templates or use create-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