rc-generator
v0.1.0
Published
React components generator from CLI
Downloads
4
Readme
React generate
To keep the consistency in React projects, use this library to auto-generate code that was agreed and tested by the CornerJob tech team, this will speed up our performance as developers and also keep the code efficient and intuitive.
What we use?
We are using the following libraries in our React project. If your project uses these libraries then react-generate
is for you.
- immutable (v3.8.1+)
- redux-immutable (v3.1.0+)
- reselect (v2.5.4+)
- enzyme (v3.2.0+)
- jest (v20.0.4+)
- styled-components (v2.2.4+)
- jest-styled-components (v3.3.2+)
Getting Started
Install react-generate
using npm
:
npm install --save-dev react-generate
Let's get started by configuring your package.json
, you have to add a script to your package.json
so we can use it after.In this case, we will add the generate
script
// package.json
{
"scripts": {
"generate": "reactgen" // reactgen is the binary that this library uses!
}
}
Now we need some parameters to make this library work:
- srcPath (required): the path to the main source, we also need the
container
andcomponent
directories within it. - testFileExtension (optional): The sub-extension for the test files that we are going to generate
To set these parameters you need to use the package.json
, add the reactGenerate
object to set the parameters:
// package.json
{
"reactGenerate": {
"srcPath": "./src",
"testFileExtension": "test"
}
}
Finally, your can run the generator:
npm run generate -- [options]
Below, we have an example of the [options]
you can pass to the reactgen
command
Options:
-d, --domains Generates a domain
-t, --container Generates a container
-p, --component Generates a component
-h, --help output usage information