@derfrodo/reducer-gen

Installation

npm install --save-dev @derfrodo/reducer-gen

Installation guides will follow (hopefully soon)

Video

You may want to have a glance at this video on Youtube. Unfortunatelly, it is currently only available in German language. I may come up with some i18n in subtitles or even in audio if I dare to speak English publicly some time.

Quick Start

call via package.json script:

Add in package.json

{
    ...
    "scripts":
        {...
            "generateReducers": "reducer-gen --loglevel debug"
        ...}
}

package.json

...then use the script 🎉

npm run generateReducers

in cli

Arguments for cli

• loglevel: logLevelChoices
• filesSuffix (default: ".base.generated" )
• filesPrefix (default: "" )
• mainFilesSuffix (default: ".main.generated" )
• mainFilesPrefix (default: "" )
• createReducerContext (default: false)
• createContextDirectPropertyHooks (default: false)
  • will only be usefull if createReducerContext is also set to true
• addArrayFunctions (default: true)
• addBubbleFlagForActions (default: true)
• decoupleStateChangedCallbackByTimeout (default: false)

Deprecated Arguments, which will more or less do nothing (... sensible 😅 )

• generateSyncStateActions (default: false, deprecated - use @derfrodo/call-for-action 🤗)
• generateWebAppHybridHooks (default: false, deprecated - use @derfrodo/call-for-action 🤗)
• generateReactNativeHybridHooks (default: false, deprecated - use @derfrodo/call-for-action 🤗)

 logLevelChoices = [
    0,
    "TRACE",
    "DEBUG",
    "INFO",
    "WARN",
    "ERROR",
    "SILENT",
    1,
    2,
    3,
    4,
    5,
    "trace",
    "debug",
    "info",
    "warn",
    "error",
    "silent",
];

Migration from 0.1.x to 0.2.x

Actions modules and variables has been renamed to be "actions" instead of "action".

You may have to adjust file names for extended actions to match this requirements. Also you will need to rename your extended actions themselves. Imports may break (do not worry: Just change "actions" in the generated documents to "action" and perform the renaming with typescript. Everything should follow this renaming, then 😊 )

extended Reducers are expected to be exported as named exports

just add export to your extended reducer constant

For me ;)

@frodo: npm publish --access public

Make things faster thanks to CI/CD

Do you know, that you have already created a pipeline to prepare the package for you? Just navigate to the actions in github and download the latest package.

Afterwards you can publish the contend just by entering

npm publish --access public --tag beta

for publishing the downloaded version as beta, or

npm publish --access public

for publishing the downloaded version as stable. 🎉

Roadmap / Todos

In case you have some spare time to invest it into this project: There are some things, we may accomplish in this library still. 😎

• Add some kind of toggle mechanic for boolean values (action "TOGGLE_PROP")
• Add option to pass reducer function as value in action similar to modify state function of useState hook (action.next would be (prev:T, prevState:State)=>T )
• Allow templates to be passed
  • Templates (handlebar syntax) should be able to be passed to this generator, so we may generate also code for other languages
• create "useStatish" hooks
  • I think of them as easy to use hooks for state management without importing all stuff like dispatch, action creators etc all the time (e.g const [currentProp, setProp] = useNamedStateProperty("propertyName))
  • Keep in mind, that we want to keep using reducers like in redux and React reducers-hooks, so that using projects will always be able to opt out easily from this lib.
  • I do not want to establish another global state framework here ☝
• Define an github action to perform all tests and create zip files
  • Archives will contain "publishable" node-packages of the current version, so we do not have to do this locally all the time
• Add unittests
  • Currently the coverage is horrible - as are the tests themselves.