# redux-tool

> Redux apps are great, but often creating just one new user interaction requires touching 8, 9, even 10 or more files.

Latest version **1.0.0** (published 2017-05-23) · ISC license · 0 weekly downloads

## Install

```sh
npm install redux-tool
pnpm add redux-tool
yarn add redux-tool
bun add redux-tool
```

Provides the commands `redux-tool`, `redux-tool-saga`, `redux-tool-action`, `redux-tool-reducer`, `redux-tool-selector`, `redux-tool-component`.

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.0 |
| Published | 2017-05-23 |
| First published | 2017-05-23 |
| Weekly downloads | 0 |
| License | ISC |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 4 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | danielstern |

## Links

- npm: https://www.npmjs.com/package/redux-tool
- npm.io page: https://npm.io/package/redux-tool

## Dependencies (4)

- [lodash](https://npm.io/package/lodash.md) ^4.17.4
- [mkdirp](https://npm.io/package/mkdirp.md) ^0.5.1
- [optimist](https://npm.io/package/optimist.md) ^0.6.1
- [underscore.string](https://npm.io/package/underscore.string.md) ^3.3.4

## Recent versions

- 1.0.0 (latest) — 2017-05-23

## README

# Redux Tool
## Problem
Redux apps are great, but often creating just one new user interaction requires touching 8, 9, even 10 or more files.

## Solution
Redux-Tool, an *unopinionated* helper to create your Redux files for you, handling all the boilerplate .

Redux-Tool does all the repetitive tasks necessary to create your app,
- Creates all necessary new folders and up-to-date index files for those folders
- Creates new files using customizable boilerplate
- Uses all latest ES6 syntax
- Automatically creates utilities as required

## Installation
`npm install -g redux-tool`

This creates the following commands available in the command line,

```shell
redux-tool-selector [propertyName]
redux-tool-action [actionName] [argumentName]
redux-tool-reducer [propertyName] [defaultValue=0]
redux-tool-component [componentName]
redux-tool-saga [sagaName] [actionName="ACTION_NAME"]
```

Executing these commands will create boilerplate Redux code relative to the directory they are executed from.

## Usage
**Please note that you should always quickly commit your progress before using any CLI tool**

Redux tool is run from the command line.
It creates necessary files for a React-Redux application and updates the index. 
It assumes you are using ES6 with `import` statements.

Example:
`redux-tool-selector taxAmount`
 
Description: Create a file `./src/selectors/taxAmountSelector.js` and updates the index of the `./src/selectors/` directory.
  
###  Changing Templates
To change the templates, simply create a `redux-tool-config.js` file and indicate the templates there. See the `redux-tool-config.js` of this repository for a full example.

```javascript
module.exports = {
    templates:{
        selector:require('./templates/selector'),
    },
};
```
 
Templates are standard lodash-style templates. E.g,
 ```javascript
`export { <%= name %>} } from './<%= name %>';`
```

### Commands

---
_Source: https://npm.io/package/redux-tool · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._