redux-fluent - npm Package Compare versions

Comparing version 0.7.1 to 0.8.0

index.js

@@ -1,7 +0,7 @@
-'use strict';
+// eslint-disable-next-line spaced-comment
+/// <reference path="./dist/index.d.ts" />
 
-if (process.env.NODE_ENV === 'production') {
-  module.exports = require('./build/redux-fluent.production.js');
-} else {
-  module.exports = require('./build/redux-fluent.development.js');
-}
+// eslint-disable-next-line import/no-dynamic-require
+module.exports = require(
+  `./dist/redux-fluent.${process.env.NODE_ENV === 'production' ? 'production' : 'development'}.js`,
+);

package.json

 {
   "name": "redux-fluent",
-  "license": "ISC",
-  "version": "0.7.1",
+  "license": "MIT",
+  "version": "0.8.0",
   "homepage": "https://github.com/Code-Y/redux-fluent#readme",
-  "description": "Tiny and eloquent way to manage a redux-like state manager",
-  "author": "Code-Y (https://github.com/Code-Y)",
-  "contributors": [
-    "Luca Pau <[e-mail]> (https://github.com/Lughino)",
-    "Giuseppe Mandato <[e-mail]> (https://github.com/hitmands)"
+  "description": "Enjoy Redux - Less Boilerplate / Go Functional",
+  "author": "Code-Y",
+  "sideEffects": false,
+  "main": "index.js",
+  "types": "dist/redux-fluent.d.ts",
+  "files": [
+    "/dist",
+    "/node_modules",
+    "CHANGELOG.md",
+    "LICENSE",
+    "index.js"
   ],
-  "keywords": [
-    "redux",
-    "ngrx-store",
-    "typescript",
-    "state-management"
-  ],
-  "main": "index.js",
   "scripts": {
+    "lint": "eslint *.js src/**/*.ts",
+    "build": "webpack --config webpack.config.js",
     "test": "jest --coverage",
-    "build": "npm run webpack -- --env.name production",
-    "webpack": "webpack --config webpack.config.js",
-    "cz": "git-cz"
+    "release": "standard-version -m \"chore(release): %s [skip ci]\""
   },
+  "husky": {
+    "hooks": {
+      "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
+    }
+  },
   "repository": {
@@ -32,33 +36,52 @@ "type": "git",
   },
-  "devDependencies": {
-    "@types/jest": "^21.1.9",
-    "codeclimate-test-reporter": "^0.5.0",
-    "commitizen": "^2.9.6",
-    "cz-conventional-changelog": "^2.1.0",
-    "jest": "^21.2.1",
-    "ts-jest": "^21.2.4",
-    "ts-loader": "^3.2.0",
-    "tslint": "^5.8.0",
-    "tslint-config-airbnb": "^5.4.2",
-    "tslint-loader": "^3.5.3",
-    "typescript": "^2.6.2",
-    "webpack": "^3.10.0"
+  "contributors": [
+    "Giuseppe Mandato (https://github.com/hitmands)",
+    "Luca Pau (https://github.com/Lughino)"
+  ],
+  "keywords": [
+    "redux",
+    "functional programming",
+    "ramda",
+    "typings"
+  ],
+  "publishConfig": {
+    "access": "public"
   },
-  "jest": {
-    "transform": {
-      "^.+\\.tsx?$": "<rootDir>/node_modules/ts-jest/preprocessor.js"
-    },
-    "testRegex": "(/__tests__/.*|(\\.|/)(test|spec))\\.(jsx?|tsx?)$",
-    "moduleFileExtensions": [
-      "ts",
-      "tsx",
-      "js",
-      "jsx",
-      "json"
-    ]
+  "peerDependencies": {
+    "flux-standard-action": "^2.0.3",
+    "redux": "^4.0.1"
   },
-  "private": false,
-  "publishConfig": {
-    "access": "public"
+  "devDependencies": {
+    "@commitlint/cli": "^7.5.2",
+    "@commitlint/config-conventional": "^7.5.0",
+    "@commitlint/travis-cli": "^7.5.2",
+    "@types/chai": "^4.1.6",
+    "@types/jest": "^23.3.2",
+    "@types/node": "^10.12.0",
+    "@types/ramda": "^0.25.39",
+    "@types/sinon": "^5.0.2",
+    "@types/sinon-chai": "^3.2.0",
+    "@typescript-eslint/eslint-plugin": "^1.4.2",
+    "@typescript-eslint/parser": "^1.4.2",
+    "awesome-typescript-loader": "^5.2.1",
+    "chai": "^4.1.2",
+    "eslint": "^5.14.1",
+    "eslint-config-airbnb-base": "^13.1.0",
+    "eslint-loader": "^2.1.1",
+    "eslint-plugin-chai-friendly": "^0.4.1",
+    "eslint-plugin-import": "^2.14.0",
+    "eslint-plugin-jest": "^21.22.1",
+    "flux-standard-action": "^2.0.3",
+    "husky": "^1.3.1",
+    "jest": "^23.6.0",
+    "ramda": "^0.25.0",
+    "redux": "^4.0.1",
+    "sinon": "^6.3.4",
+    "sinon-chai": "^3.2.0",
+    "standard-version": "^5.0.1",
+    "ts-jest": "^23.10.4",
+    "typescript": "^3.1.3",
+    "webpack": "^4.19.1",
+    "webpack-cli": "^3.1.0"
   }
 }

README.md

@@ -1,6 +0,175 @@
-# redux-fluent
+# <a href='https://github.com/Code-Y/redux-fluent'><img src='https://raw.githubusercontent.com/Code-Y/redux-fluent/master/redux-fluent-logo.png' height='60' alt='Redux Fluent' aria-label='https://github.com/Code-Y/redux-fluent' /></a> redux-fluent
 [![Build Status](https://travis-ci.org/Code-Y/redux-fluent.svg?branch=master)](https://travis-ci.org/Code-Y/redux-fluent)
-[![Code Climate](https://codeclimate.com/github/Code-Y/redux-fluent/badges/gpa.svg)](https://codeclimate.com/github/Code-Y/redux-fluent)
-[![Test Coverage](https://api.codeclimate.com/v1/badges/02e8b0d9ba383c19ae50/test_coverage)](https://codeclimate.com/github/Code-Y/redux-fluent/test_coverage)
+[![npm version](https://img.shields.io/npm/v/redux-fluent.svg)](https://www.npmjs.com/package/redux-fluent)
+[![License](https://img.shields.io/npm/l/redux-fluent.svg)](https://github.com/Code-Y/redux-fluent/blob/master/LICENSE)
+[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org)
+[![npm downloads](https://img.shields.io/npm/dm/redux-fluent.svg)](https://www.npmjs.com/package/redux-fluent)
+[![Maintainability](https://api.codeclimate.com/v1/badges/2e98502fb6072892995d/maintainability)](https://codeclimate.com/github/Code-Y/redux-fluent/maintainability)
+[![Test Coverage](https://api.codeclimate.com/v1/badges/2e98502fb6072892995d/test_coverage)](https://codeclimate.com/github/Code-Y/redux-fluent/test_coverage)
 
-Tiny and eloquent way to manage a redux-like state manager
+Tiny and eloquent way of bringing redux to the next level (*~3K*, dependencies free, typings included).
+
+[Try it out on RunKit](https://runkit.com/hitmands/redux-fluent-playground)
+
+## Motivation
+
+**[Redux](https://redux.js.org/)** is **great**, every recent web application has most likely been built on top of it, **and we can really make it better!**
+
+  - **λ Go Functional**, Everything is a function and reducers are built by function composition rather than piling up if and switch-case statements: [*Let's introduce Redux Fluent Reducers*](#createreducer).
+  - **Reducers at scale**, due to being handling multiple actions, reducers tend to grow and become difficult to maintain: [*Let's introduce Redux Fluent Action Handlers*](#oftype).
+  - **Less boilerplate**, Flux architecture is usually verbose and some of their concepts, such as `Action`, `Action Type` and `Action Creator` could all be implemented in a single entity: [*Let's introduce Redux Fluent Actions*](#createaction).
+  - **FSA compliance**, FSA Actions may have a `error: boolean` field, which indicates whether the action represents a failure or not. Respecting this pattern leads to a series of if statements inside reducers, compromising both readability and maintainability, so the community normally tends to split error and failures into two separate actions (eg: `ADD_TODO_SUCCESS` and `ADD_TODO_ERROR`) which reduces cognitive complexity on one hand but produces even more boilerplate on the other. *Let's embrace FSA and abstract error handling with filterable action handlers*.
+
+## Installation
+
+```bash
+yarn add redux-fluent redux
+```
+
+## Getting Started
+
+```javascript
+/** todos.actions.js **/
+import { createAction } from 'redux-fluent';
+
+export const addTodo = createAction('todos | add');
+console.log(addTodo.type); // 'todos | add'
+```
+
+```javascript
+/** todos.reducer.js **/
+import { createReducer, ofType } from 'redux-fluent';
+import * as actions from './todos.actions.js';
+
+const addTodo = (state, { payload }) => state.concat(payload);
+
+export const todos = createReducer('todos')
+  .actions(
+    ofType(actions.addTodo).map(addTodo),
+    /* and so on */
+  )
+  .default(() => []);
+```
+
+```javascript
+/** application.js **/
+import { createStore } from 'redux';
+import { combineReducers } from 'redux-fluent';
+import * as actions from './todos.actions.js';
+import { todos } from './todos.reducer.js';
+
+const rootReducer = combineReducers(todos, ...);
+const store = createStore(rootReducer);
+console.log(store.getState()); // { todos: [] }
+
+store.dispatch(actions.addTodo({ title: 'Walk Gipsy' }));
+console.log(store.getState()); // { todos: [{ title: 'Walk Gipsy' }] }
+```
+
+## Documentation
+
+  - [`createReducer()`](#createreducer)
+  - [`createAction()`](#createaction)
+  - [`ofType()`](#oftype)
+  - [`withConfig()`](#withconfig)
+  - [`combineReducers()`](#combinereducers)
+  - [`createReducersMapObject()`](#createreducersmapobject)
+
+### `createReducer()`
+`createReducer` is a function combinator whose purpose is to output a [redux reducer](https://redux.js.org/basics/reducers) by combining action handlers and `getDefaultState` together.
+```typescript
+import { createReducer } from 'redux-fluent';
+
+const reducer = createReducer(name)
+  .actions(
+    ...handlers: (state, action, config?) => state,
+  )
+  .default(
+    getDefaultState: (state: void, action, config?) => state,
+  );
+```
+
+### `createAction()`
+`createAction` is a factory function whose purpose is to output an [action creator](https://redux.js.org/basics/actions#action-creators) responsible of shaping your actions. The resulting function holds a field `type` giving you access to the action type.
+```typescript
+import { createAction } from 'redux-fluent';
+
+const action = createAction(
+  type: string,
+  payloadCreator?: (rawPayload, rawMeta, type) => payload,
+  metaCreator?: (rawPayload, rawMeta, type) => meta,
+);
+
+console.log(action.type);
+```
+
+### `ofType()`
+As we just said, a reducer is nothing more than a function combinator, it does not contain any business logic. The job of actually mutating the state is left to the Action Handlers. Embracing the [Single Responsibility Principle](https://en.wikipedia.org/wiki/Single_responsibility_principle), we can build simple, easy to test, dedicated functions that do only one thing.
+```typescript
+import { ofType } from 'redux-fluent';
+
+ofType(action: ReduxFluentActionCreator).map((state: any, action: AnyAction) => state);
+ofType(type: string).map((state: any, action: AnyAction) => state);
+ofType(action: { type: string }).map((state: any, action: AnyAction) => state);
+
+// write your action handlers by only focusing on the actual task,
+// let `ofType` take care of the orchestration (i.e. intercepting actions).
+ofType('todos | add').map(
+  (state, action) => state.concat(action.payload),
+);
+```
+
+### `withConfig()`
+Redux Fluent also comes with some additional features to help you write your code that scales. Functions that only rely on their arguments are easy to test and share, so you can provide an additional argument `config: any` (multiple `config` are shallowly merged).
+```typescript
+import * as R from 'ramda';
+import { withConfig, createReducer, ofType } from 'redux-fluent';
+
+withConfig(config: any);
+
+const todos = createReducer('todos')
+  .actions(
+    ofType('todos | doSomething').map(
+      (state, action, { doSomething }) => doSomething(state, action),
+    ),
+    ofType('todos | doSomethingElse').map(
+      (state, action, { doSomethingElse }) => doSomethingElse(state, action),
+    ),
+  )
+  .default(() => []);
+
+export default R.pipe(
+  withConfig({ doSomething: R.tap(console.log) }),
+  withConfig({ doSomethingElse: R.tap(console.log) }),
+)(todos);
+```
+
+### `combineReducers()`
+This api is not strictly needed, you can still use [`redux#combineReducers`](https://redux.js.org/api/combinereducers). With Redux Fluent, by the way, both namespace and reducer are defined in the same place so that you don't need to take care of the shape when combining them.
+```typescript
+import { createStore } from 'redux';
+import { combineReducers } from 'redux-fluent';
+import { todosReducer, notesReducer, otherReducer } from './reducers';
+
+combineReducers(...reducers: ReduxFluentReducer[]);
+
+const rootReducer = combineReducers(todosReducer, notesReducer, otherReducer, ...);
+const store = createStore(rootReducer);
+```
+
+### `createReducersMapObject()`
+This api lets you combine your reducers with [`redux#combineReducers`](https://redux.js.org/api/combinereducers), and can be useful when mixing redux fluent reducers with any other reducer. 
+```typescript
+import { createStore, combineReducers } from 'redux';
+import { createReducersMapObject } from 'redux-fluent';
+import { todosReducer, notesReducer, otherReducer } from './reducers';
+
+createReducersMapObject(...reducers: ReduxFluentReducer[]);
+
+const reducersMapObject = createReducersMapObject(todosReducer, notesReducer, otherReducer, ...);
+const rootReducer = combineReducers({
+  ...reducersMapObject,
+  anyOtherReducer: (state, action) => 'any other state',
+});
+const store = createStore(rootReducer);
+```

New alerts

Major refactor

Supply chain risk

Package has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.

Found 1 instance in 1 package

Dynamic require

Supply chain risk

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

Found 1 instance in 1 package

Minified code

Quality

This package contains minified code. This may be harmless in some cases where minified code is included in packaged libraries, however packages on npm should not minify code.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

69573

increased by43.28%

Number of package files

16

increased by100%

Lines of code

410

increased by14.21%

Number of lines in readme file

176

increased by2414.29%

Worsened metrics

Dependency count

2

increased byInfinity%

Dev dependency count

31

increased by158.33%

Number of low quality alerts

2

increased by100%

Number of low supply chain risk alerts

2

increased by100%

Number of medium supply chain risk alerts

1

increased byInfinity%

No dependency changes