canonical

ESLint-plugin-lodash3 =================== [![Maintenance Status][status-image]][status-url] [![NPM version][npm-image]][npm-url] [![Build Status][travis-image]][travis-url] [![Coverage Status][coverage-image]][coverage-url] Lodash3 specific linting rules for ESLint # Installation Install [ESLint](https://www.github.com/eslint/eslint) either locally or globally. npm install eslint If you installed `ESLint` globally, you have to install lodash3 plugin globally too. Otherwise, install it locally. $ npm install eslint-plugin-lodash3 # Configuration Add `plugins` section and specify ESLint-plugin-lodash3 as a plugin. ```json { "plugins": ["lodash3"] } ``` Finally, enable all of the rules that you would like to use. ```json { "rules": { "lodash3/prop-shorthand": 2, "lodash3/matches-shorthand": [2, "always", 3], "lodash3/matches-prop-shorthand": [2, "always"], "lodash3/prefer-chain": [2, 3], "lodash3/preferred-alias": 2, "lodash3/no-single-chain": 2, "lodash3/prefer-reject": [2, 3], "lodash3/prefer-filter": [2, 3], "lodash3/no-unnecessary-bind": 2, "lodash3/unwrap": 2, "lodash3/prefer-compact": 2, "lodash3/no-double-unwrap": 2, "lodash3/prefer-map": 2, "lodash3/prefer-wrapper-method": 2, "lodash3/prefer-invoke": 2, "lodash3/prefer-thru": 2, "lodash3/prefer-lodash-chain": 2, "lodash3/prefer-lodash-method": 2, "lodash3/prefer-lodash-typecheck": 2, "lodash3/no-commit": 2, "lodash3/prefer-get": [2, 3], "lodash3/collection-return": 2, "lodash3/prefer-matches": [2, 3], "lodash3/prefer-times": 2, "lodash3/prefer-startswith": 2, "lodash3/prefer-noop": 2, "lodash3/prefer-constant": 2, "lodash3/chain-style": [2, "as-needed"] } } ``` # List of supported rules * [prop-shorthand](docs/rules/prop-shorthand.md): Prefer property shorthand syntax * [matches-prop-shorthand](docs/rules/matches-prop-shorthand.md): Prefer matches property shorthand syntax * [matches-shorthand](docs/rules/matches-shorthand.md): Prefer matches shorthand syntax * [preferred-alias](docs/rules/preferred-alias.md): Preferred aliases * [prefer-chain](docs/rules/prefer-chain.md): Prefer chain over nested lodash calls * [no-single-chain](docs/rules/no-single-chain.md): Prevent chaining syntax for single method, e.g. `_(x).map().value()` * [prefer-reject](docs/rules/prefer-reject.md): Prefer `_.reject` over filter with `!(expression)` or `x.prop1 !== value` * [prefer-filter](docs/rules/prefer-filter.md): Prefer `_.filter` over `_.forEach` with an `if` statement inside. * [no-unnecessary-bind](docs/rules/no-unnecessary-bind.md): Prefer passing `thisArg` over binding. * [unwrap](docs/rules/unwrap.md): Prevent chaining without evaluation via `value()` or non-chainable methods like `max()`., * [prefer-compact](docs/rules/prefer-compact.md): Prefer `_.compact` over `_.filter` for only truthy values. * [no-double-unwrap](docs/rules/no-double-unwrap.md): Do not use `.value()` on chains that have already ended (e.g. with `max()` or `reduce()`) * [prefer-map](docs/rules/prefer-map.md): Prefer `_.map` over `_.forEach` with a `push` inside. * [prefer-wrapper-method](docs/rules/prefer-wrapper-method.md): Prefer using array and string methods in the chain and not the initial value, e.g. `_(str).split(' ')...` * [prefer-invoke](docs/rules/prefer-invoke.md): Prefer using `_.invoke` over `_.map` with a method call inside. * [prefer-thru](docs/rules/prefer-thru.md): Prefer using `_.prototype.thru` in the chain and not call functions in the initial value, e.g. `_(x).thru(f).map(g)...` * [prefer-lodash-chain](docs/rules/prefer-lodash-chain.md): Prefer using Lodash chains (e.g. `_.map`) over native and mixed chains. * [prefer-lodash-method](docs/rules/prefer-lodash-method.md): Prefer using Lodash collection methods (e.g. `_.map`) over native array methods. * [prefer-lodash-typecheck](docs/rules/prefer-lodash-typecheck.md): Prefer using `_.is*` methods over `typeof` and `instanceof` checks when applicable. * [no-commit](docs/rules/no-commit.md): Do not use `.commit()` on chains that should end with `.value()` * [prefer-get](docs/rules/prefer-get.md): Prefer using `_.get` or `_.has` over expression chains like `a && a.b && a.b.c`. * [collection-return](docs/rules/collection-return.md): Always return a value in iteratees of lodash collection methods that aren't `forEach`. * [prefer-matches](docs/rules/prefer-matches.md): Prefer `_.matches` over conditions like `a.foo === 1 && a.bar === 2 && a.baz === 3`. * [prefer-times](docs/rules/prefer-times.md): Prefer `_.times` over `_.map` without using the iteratee's arguments. * [prefer-startswth](docs/rules/prefer-startswith.md): Prefer `_.startsWith` over `a.indexOf(b) === 0`. * [prefer-noop](docs/rules/prefer-noop.md): Prefer `_.noop` over empty functions. * [prefer-constant](docs/rules/prefer-constant.md): Prefer `_.constant` over functions returning literals. * [chain-style](docs/rules/chain-style.md): Enforce a specific chain style: explicit, implicit, or explicit only when necessary. # License ESLint-plugin-lodash3 is licensed under the [MIT License](http://www.opensource.org/licenses/mit-license.php). [npm-url]: https://npmjs.org/package/eslint-plugin-lodash3 [npm-image]: http://img.shields.io/npm/v/eslint-plugin-lodash3.svg?style=flat-square [travis-url]: https://travis-ci.org/wix/eslint-plugin-lodash3 [travis-image]: http://img.shields.io/travis/wix/eslint-plugin-lodash3/master.svg?style=flat-square [deps-url]: https://david-dm.org/wix/eslint-plugin-lodash3 [deps-image]: https://img.shields.io/david/dev/wix/eslint-plugin-lodash3.svg?style=flat-square [coverage-url]: https://coveralls.io/r/wix/eslint-plugin-lodash3?branch=master [coverage-image]: http://img.shields.io/coveralls/wix/eslint-plugin-lodash3/master.svg?style=flat-square [climate-url]: https://codeclimate.com/github/wix/eslint-plugin-lodash3 [climate-image]: http://img.shields.io/codeclimate/github/wix/eslint-plugin-lodash3.svg?style=flat-square [status-url]: https://github.com/wix/eslint-plugin-lodash3/pulse [status-image]: http://img.shields.io/badge/status-maintained-brightgreen.svg?style=flat-square