warp-reactor
v1.0.0-alpha.1.10
Published
A basic generator CLI for react components
Downloads
15
Readme
Warp-Reactor
Warp-Reactor is a simple CLI (command-line interface) for generating react components based on the angular-cli project.
Installation
Install via npm
npm install -g warp-reactor
Usage
Initialize warp-reactor in your react project.
warp-reactor init
| option | action |
|----------|----------|
|‑‑styles | Defines the file extension for the style file to be imported by the component: warp-reactor init --styles scss
|
|‑‑path | Defines the root directory of your components: warp-reactor init --path src
|
Generating Components
Now you can begin generating components.
warp-reactor generate component [component-name]
| option | shorthand | action | |----------|----------|----------| |‑‑extension | ‑e | Defines the file extension for the component file | |‑‑styles | ‑s | Specifies the style type and overrides the style attribute specified in reactor.json file | | ‑‑path | ‑p | Specifies the sub directory in which to generate. Appends to the end of the path specified in reactor.json | | ‑‑no‑dir | | If set, the files will be generated without a parent directory |
Examples:
warp-reactor generate component test-component
Running the generate
command with a path for the name generates a new component at the specified path with the name of the last path element.
warp-reactor init --styles scss --path src
warp-reactor generate component test-directory/test-component
Generates test-component.js and test-component.scss to the src/test-directory/test-component directory.
If you would like a component to not be generated in it's own directory, generate it with the --no-dir
flag
warp-reactor generate component test-component --nodir
Create a new React app with warp-reactor
warp-reactor new [app-name]
| option | action | |----------|----------| |‑‑current‑dir | Creates the new app in the current directory | |‑‑skip‑install | Skips installing dependencies listed in the package.json |