| 1 | ## CCreator
|
| 2 |
|
| 3 | CLI app for simple and fast create component folder with all necessary files
|
| 4 |
|
| 5 | ### Get started
|
| 6 | #### Install
|
| 7 |
|
| 8 | `npm i -g ccreator` or `npm i ccreator` if you need install package local
|
| 9 |
|
| 10 | #### Usage
|
| 11 |
|
| 12 | `ccreator`: create component
|
| 13 |
|
| 14 | `ccreator <componentName> <options>` - create component with in `componentName` folder, using default settings
|
| 15 |
|
| 16 | `ccreator <componentName> -f` - force create component with in `componentName` folder, using default settings
|
| 17 |
|
| 18 |
|
| 19 | #### Configure
|
| 20 | App can be configured using `ccreator.config.json` in the root of your project.
|
| 21 |
|
| 22 | Config file contains the following fields:
|
| 23 |
|
| 24 | | Name | Type | Default | Description |
|
| 25 | | ------------ | ------------ | ------------ | ------------ |
|
| 26 | | tmplPath | string | - | path to template files |
|
| 27 | | indexFileName | string | "index" | "index" or "component". index.js or [compoenentName].js |
|
| 28 | | stylesFileName | string | "component" | "styles" or "component". styles.css or [component-name].css |
|
| 29 | | mockFolder | string | "\__mock\__" | name of folder for mocking data |
|
| 30 | | mockFileName | string | "mock" | name of mocking data file |
|
| 31 | | mockFileExtension | string | "json" | extension of mocking data file | |
| \ | No newline at end of file |