A command-line utility for generating goodness
Goodz allows for structured, repeatable code generation for development teams.
$ npm install -g goodz
$ yarn add goodz --dev
// package.json
"Scripts": {
"goodz": "goodz"
}
$ goodz --help
Usage
$ goodz Select from a list of generators
$ goodz <name> Run a generator of that name
Options
-h, --help Display the help screen
-d, --dir Specify base path directory
-v, --version Display the version number
Examples
$ goodz react.component
$ goodz react.component --dir app
Uses Plop and Inquirer underneath... ๐
Generates a functional React app. Based on Create React App, but with some added goodness.
$ goodz react.app
What is the name of your project?
Should this react app have Redux? (Y/n)
Generates a react component inside your app, based on atomic design principles
$ goodz react.component
Name of component?" (e.g. Button)
Where should this component live?
choices: ["atoms", "molecules", "organisms", "templates"]
Do you need a Stateless or Stateful component?
choices: ["Stateless", "Stateful"]
Should this component be connected to the redux store? (y/N)
What functions would you like to include?
choices: ["constructor", "componentDidMount", "componentWillMount"]
*statefull components only*
What redux functions would you like to include?
choices: ["componentWillReceiveProps", "mapStateToProps", "mapDispatchToProps"]
*connected components only*
โโโ src
โโโ components
โโโ atoms
โโโ Button
|โโ Button.js - Component file
|โโ Button.style.js - Scoped styled component
|โโ index.js - For easy reference
โโโ __tests__
โโโ Button.test.js - Jest unit test file
Generates a saga inside your Redux app
$ goodz react.saga
Saga Name? (e.g. counter)
Action Constant? (e.g. COUNTER_INCREMENT)
Reducer Constant? (e.g. COUNTER_CHANGED)
โโโ src
โโโ state
|โโ middleware.js
|โโ saga.js
โโโ store.js
โโโ counter
|โโ counter.actions.js
|โโ counter.reducer.js
|โโ counter.saga.js
โโโ index.js
Everyone deserves some goodness from time to time.
- Create React App - Set up a modern web app by running one command.
- Redux - A predictable state container for JavaScript apps.
- Redux Saga - An alternative side effect model for Redux apps.
- Styled Components - Visual primitives for the component age.
- Jest - Delightful JavaScript Testing.
- Enzyme - JavaScript Testing utilities for React.
MIT