Détail du package

eslint-plugin-lodash-fp

jfmengels248.3kMIT2.2.0-a1

ESLint rules for lodash/fp

eslint, plugin, eslint-plugin, eslintplugin

readme

eslint-plugin-lodash-fp

ESLint rules for lodash/fp

Install

$ npm install --save-dev eslint eslint-plugin-lodash-fp

Usage

Configure it in package.json.

{
  "name": "my-awesome-project",
  "eslintConfig": {
    "env": {
      "es6": true
    },
    "parserOptions": {
      "ecmaVersion": 7,
      "sourceType": "module"
    },
    "plugins": [
      "lodash-fp"
    ],
    "rules": {
      "lodash-fp/consistent-compose": "off",
      "lodash-fp/consistent-name": [
        "error",
        "_"
      ],
      "lodash-fp/no-argumentless-calls": "error",
      "lodash-fp/no-chain": "error",
      "lodash-fp/no-extraneous-args": "error",
      "lodash-fp/no-extraneous-function-wrapping": "error",
      "lodash-fp/no-extraneous-iteratee-args": "error",
      "lodash-fp/no-extraneous-partials": "error",
      "lodash-fp/no-for-each": "off",
      "lodash-fp/no-partial-of-curried": "error",
      "lodash-fp/no-single-composition": "error",
      "lodash-fp/no-submodule-destructuring": "error",
      "lodash-fp/no-unused-result": "error",
      "lodash-fp/prefer-compact": "error",
      "lodash-fp/prefer-composition-grouping": "error",
      "lodash-fp/prefer-constant": [
        "error",
        {
          "arrowFunctions": false
        }
      ],
      "lodash-fp/prefer-flat-map": "error",
      "lodash-fp/prefer-get": "error",
      "lodash-fp/prefer-identity": [
        "error",
        {
          "arrowFunctions": false
        }
      ],
      "lodash-fp/preferred-alias": "off",
      "lodash-fp/use-fp": "error"
    }
  }
}

Rules

consistent-compose - Enforce a consistent composition method.
consistent-name - Enforce a consistent name for Lodash.
no-argumentless-calls - Forbid argument-less calls of Lodash methods.
no-chain - Forbid the use of _.chain
no-extraneous-args - No extraneous arguments to methods with a fixed arity.
no-extraneous-function-wrapping - Avoid unnecessary function wrapping.
no-extraneous-partials - Avoid unnecessary intermediate partials in curried methods.
no-extraneous-iteratee-args - No extraneous parameters in iteratees.
no-for-each - Forbid the use of _.forEach
no-partial-of-curried - No use of _.partial on curried Lodash methods.
no-single-composition - Enforce at least two methods arguments for composition methods.
no-submodule-destructuring - Forbid destructuring of Lodash submodules.
no-unused-result - Enforce that the result of a Lodash method call gets used.
prefer-compact - Prefer _.compact over _.filter with identity function.
prefer-composition-grouping - Prefer grouping similar methods in composition methods.
prefer-constant - Prefer _.constant over functions returning literals.
prefer-flat-map - Prefer _.flatMap over consecutive _.map and _.flatten.
prefer-get - Prefer _.get over multiple &&.
prefer-identity - Prefer _.identity over functions returning their argument.
preferred-alias - Limit the use of aliases.
use-fp - Use lodash/fp instead of Lodash.

Recommended configuration

This plugin exports a recommended configuration that enforces good practices.

To enable this configuration, use the extends property in your package.json.

{
    "name": "my-awesome-project",
    "eslintConfig": {
        "extends": "plugin:lodash-fp/recommended"
    }
}

See ESLint documentation for more information about extending configuration files.

MIT © Jeroen Engels

changelog

Change Log

All notable changes to this project will be documented in this file. This project adheres to Semantic Versioning. This change log adheres to standards from Keep a CHANGELOG.

Unreleased

Added

Added lodash-fp to recommended preset ([#66], thanks @iddan]).
Added [no-extraneous-partials] rule (#68).

Fixed

Fixed no-unused-result by exempting _.defer and _.delay as side effect methods (#64, thanks @friday).

2.1.3 - 2016-11-08

Fixed

Fixed no-single-composition by allowing array expressions with multiple elements (#42, thanks @iam4x).

Misc

Replaced ast-utils by eslint-ast-utils (package was renamed).
Replaced isStaticRequire function by the similarly named function in eslint-ast-utils.

2.1.2 - 2016-11-03

Fixed

Fixed no-extraneous-function-wrapping not handling some constructs (now uses [ast-utils]).

2.1.1 - 2016-10-14

Fixed

Fixed no-single-composition triggering errors when using spread arguments.

2.1.0 - 2016-10-10

NOTE

This was published as a minor version by accident. It should have been a patch.

Fixed

Fixed incorrect errors for use-fp on package names starting with lodash- ([#41, thanks @penny-five)

2.0.1 - 2016-08-24

Fixed

Fixed crash in no-extraneous-function-wrapping when using return without an argument.
Fixed false report in no-extraneous-function-wrapping when using the last argument twice in the arguments (#38, thanks @godu).

2.0.0 - 2016-07-15

Removed

Breaking: Removed support for Node.js versions < v4.

Fixed

Fixed documentation for prefer-composition-grouping.
Added suggestion in prefer-composition-grouping to use _.overEvery/_.overSome to replace multiple _.filter/_.reject.
Added an exception for _.bindAll in no-unused-result (#36, thanks @dfadler).

Changed

Removed eslint as a dependency.

1.3.0 - 2016-05-26

Added

Added no-unused-result rule

Fixed

Fixed prefer-composition-grouping's error message (#30, thanks @gunar).
Fixed no-extraneous-iteratee-args's error message.
prefer-composition-grouping now handles aliases, and can report multiple errors in the same flow construct.

Changed

no-for-each now also reports uses of _.forIn and _.forOwn.

1.2.0 - 2016-05-08

Added

Added no-extraneous-iteratee-args rule
Added no-partial-of-curried rule
Added preferred-alias rule

Fixed

no-extraneous-args now also handles aliases.
Fixed crash in no-extraneous-function-wrapping.

Changed

no-extraneous-args now recommends an alternative whenever possible, and tells when to use an array for method that used rest args.

1.1.3 - 2016-05-02

Fixed

Fix false positives being returned for any Lodash method used that did not match consistent-compose method name option (#14, thanks @kavington)

1.1.2 - 2016-05-01

Fixed

Crash in no-submodule-destructuring when doing const {foo} = bar; (#13, thanks @kavington)
Typo in recommended configuration (#13, thanks @kavington)