| 1 | # README
|
| 2 |
|
| 3 | ## RXSS Generator
|
| 4 |
|
| 5 | The rxss generator generates components, class-components, containers, & stores based off of react and mobx. It is assumed that the file structure is the following
|
| 6 |
|
| 7 | ```
|
| 8 | . [project folder]
|
| 9 | +-- src
|
| 10 | | +-- components
|
| 11 | | +-- containers
|
| 12 | | +-- stores
|
| 13 | ```
|
| 14 |
|
| 15 | ### Installing
|
| 16 |
|
| 17 | ``` npm -i cli-rxss -D ``` or ``` yarn add cli-rxss -D ```
|
| 18 | ``` npm link cli-rxss ```
|
| 19 |
|
| 20 | ### Commands
|
| 21 |
|
| 22 | ```rxss -g [type] -n [name]```
|
| 23 |
|
| 24 | **The name must either be all lower case or snake-case-syntax in order to name the files properly**
|
| 25 |
|
| 26 | ### Available Types
|
| 27 | * component -> Creates a functional react component with spec file.
|
| 28 | * component:mobx -> Creates a functional react component wrapped in mobx-react observer with spec file.
|
| 29 | * class-component -> Creates a class based react component with spec file.
|
| 30 | * class-component:mobx -> Creates a class based react component wrapped in mobx-react observer with spec file.
|
| 31 | * container -> Creates a container react component with spec file.
|
| 32 | * container:mobx -> Creates a container react component wrapped in mobx-react observer with spec file.
|
| 33 | * store -> Creates a mob-x store with spec file.
|
| 34 |
|
| 35 | |
| \ | No newline at end of file |