Skip to content

Commit

Permalink
clarify about using global Lodash in README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ganimomer authored Mar 21, 2017
1 parent d7bda6b commit 1e40715
Showing 1 changed file with 5 additions and 3 deletions.
8 changes: 5 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,8 @@ If you wish to use this plugin with Lodash v3, this value should be `3`. (on by

Finally, enable all of the rules that you would like to use.
## Recommended configuration
This plugin exports a `recommended` configuration that enforces all the rules. You can configure the plugin as follows:
This plugin exports a `recommended` configuration that enforces all the rules.
You can configure the plugin as follows:

```json
{
Expand All @@ -42,7 +43,8 @@ This plugin exports a `recommended` configuration that enforces all the rules. Y
}
```
## Configuration for use with the full Lodash object
If you work with the full Lodash object with the same variable name every time, you can use the `canonical` for faster execution:
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:

```json
{
"plugins": ["lodash"],
Expand Down Expand Up @@ -130,4 +132,4 @@ ESLint-plugin-lodash is licensed under the [MIT License](http://www.opensource.o
[status-image]: http://img.shields.io/badge/status-maintained-brightgreen.svg?style=flat-square

[build-image]: https://travis-ci.org/wix/eslint-plugin-lodash.svg?branch=master
[build-url]: https://travis-ci.org/wix/eslint-plugin-lodash
[build-url]: https://travis-ci.org/wix/eslint-plugin-lodash

0 comments on commit 1e40715

Please sign in to comment.