Lodash-specific linting rules for ESLint.
Install ESLint either locally or globally.
$ npm install eslint --save-dev
If you installed
ESLint globally, you have to install the Lodash plugin globally too. Otherwise, install it locally.
$ npm install eslint-plugin-lodash --save-dev
plugins section and specify ESLint-Plugin-Lodash as a plugin.
You can additionally add settings for the plugin.
These are settings that can be shared by all of the rules. All settings are under the
lodash inside the general
settings object. For more info about shared settings, read the ESLint Configuration Guide.
imported in ES6 modules or
required in commonjs.
4). If you wish to use this plugin with Lodash v3, this value should be
3. (on by default in the config
Finally, enable all of the rules that you would like to use.
This plugin exports a
recommended configuration that enforces all the rules.
You can configure the plugin as follows:
If you work with the full Lodash object with the same variable name every time, you should use the
canonical configuration. This allows rules to run without explicitly importing Lodash in your code, and allows for faster execution for some of the rules:
Out of the box, this plugin supports the use of Lodash v4. To use with Lodash v3, the config needs to specify the version in the
settings, and can't use some rules.
The plugin also exports a
v3 config for ease of use.
Rules are divided into categories for your convenience. All rules are off by default, unless you use one of the plugin's configurations which turn all relevant rules on.
The following rules point out areas where you might have made mistakes.
thisArgfor Lodash method callbacks, depending on major version.
.value()on chains that have already ended (e.g. with
thisinside callbacks without binding them.
value()or non-chainable methods like
These rules are purely matters of style and are quite subjective.
.commit()on chains that should end with
property: array, string, or arrays only for paths with variables.
_.filterfor only truthy values.
_.mapwith a method call inside.
_.rejectover filter with
x.prop1 !== value
_.prototype.thruin the chain and not call functions in the initial value, e.g.
These rules are also stylistic choices, but they also recommend using Lodash instead of native functions and constructs.
For example, Lodash collection methods (e.g.
forEach) are generally faster than native collection methods.
_.constantover functions returning literals.
_.hasover expression chains like
a && a.b && a.b.c.
_.isNilover checks for both null and undefined.
_.map) over native and mixed chains.
_.map) over native array methods.
instanceofchecks when applicable.
_.matchesover conditions like
a.foo === 1 && a.bar === 2 && a.baz === 3.
_.noopover empty functions.
_.overEveryinstead of checks with
||for methods that have a boolean check iteratee.
a.indexOf(b) === 0.
_.mapwithout using the iteratee's arguments.
Contributions are always welcome! For more info, read our contribution guide.
ESLint-plugin-lodash is licensed under the MIT License.