Skip to content

A simple CLI tool to view the graph of events and actions

Notifications You must be signed in to change notification settings

AmitMY/redux-viewer

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

redux-viewer

A simple CLI tool to view the graph of events and actions

example

Usage

Install the package globally:

npm i -g redux-viewer

Document every effect you have with the following format:

Property Status Description
@type mandatory Effect
@name mandatory Effect's name
@ofType mandatory What actions trigger the effect, comma seperated
@dependencies optional What stores is this effect using, comma seperated
@filter optional Human readable filter that guards the effect
@action optional What actions does this effect trigger, comma separated. If an action is optional, use ? in the end

A full example:

/**
 * @type Effect
 * @name someEffectName$
 * @ofType someAction, aDifferentAction
 * @dependencies feed, friends
 * @filter If something exists
 * @action callAction, anotherCallAction, maybeCallAction?
 */

Run the following command on your project:

rv -s src/

Contributing:

fork repository and then:

npm link
npm start

This will start viewer session pointing to example folder