mjangir / reactogen Goto Github PK

Reactogen is CLI tool to create your redux (duck structured) modules quickly by answering a few prompts. Though the project has been started for multipurpose but currently it supports only creating react redux modules.

You can install reactogen globally or locally in your project by running the following command: npm install reactogen -g

Once you are done with installing the tool, you just need to run the following command in any directory where you want your module to be generated. reactogen generate Running this command will prompt the following few questions:

Enter whatever the name of your module you want for e.g. users, createUser, UserRole. It will create the directory with this module name.

If you answer it as YES it will add the immutableJS imports in the state and selector files. Also it will make the state immutable.

If are not aware, Redux Actions is Flux Standard Action utilities for Redux. If you confirm this, all the action creators will return flux standard action and the code will be generated as:

import { createAction } from 'redux-actions';
import * as constants from './constants';

export const fetchUser = createAction(
  constants.FETCH_USER,
  (payload) => payload,
  (payload, meta) => meta
);

It will be a plain action object like below:

export function fetchUsers(payload, meta) {
  return {
    type: constants.FETCH_USERS,
    payload,
    meta,
  };
}

This is very important. Once you come to this question, hit the Enter and it will open an editor (notepad etc.). You need to put all your constant names line by line (only one constant should be in a line) and it will create the appropriate constant and action files in the module. Here are the supported constant name formats:

fetch_admin_users
fetchAdminUsers
FETCH_ADMIN_USERS
fetch-admin-users
fetch-Admin-Users
FETCH-ADMIN-USERS

In whatever above format you write your constants, they will be taken care of. All these will be giving a same constant with name FETCH_ADMIN_USERS and the action name fetchAdminUsers.

Coming to this question will also open an editor by hitting the Enter key and you need to put your state json schema there. Save it and close it.

Thats all A new module folder will be created with the following files:

1. constants.js - contains all the constants you put in editor
2. actions.js - contains all the action creators for given constants
3. reducer.js - This file will have all the action handlers for given constants
4. selectors.js - It will contain the root level state selectors using reselect
5. state.model.js - This is the state holder that contains your state with state modification methods for each action.