# eslint-plugin-prefer-arrow-functions > An ESLint Plugin to Lint and auto-fix plain Functions into Arrow Functions, in all cases where conversion would result in the same behaviour (Arrow Functions do not support `this`, `arguments`, or `new.target` for example). [![NPM version](http://img.shields.io/npm/v/eslint-plugin-prefer-arrow-functions.svg?style=flat-square)](https://www.npmjs.com/package/eslint-plugin-prefer-arrow-functions) [![NPM downloads](http://img.shields.io/npm/dm/eslint-plugin-prefer-arrow-functions.svg?style=flat-square)](https://www.npmjs.com/package/eslint-plugin-prefer-arrow-functions) [![Build Status](http://img.shields.io/travis/JamieMason/eslint-plugin-prefer-arrow-functions/master.svg?style=flat-square)](https://travis-ci.org/JamieMason/eslint-plugin-prefer-arrow-functions) [![Maintainability](https://api.codeclimate.com/v1/badges/795faa0b446ff7dddcdb/maintainability)](https://codeclimate.com/github/JamieMason/eslint-plugin-prefer-arrow-functions/maintainability) ## Table of Contents - [☁️ Installation](#️-installation) - [🏓 Playground](#-playground) - [⚖️ Configuration](#️-configuration) - [🤔 Options](#-options) - [👏🏻 Credits](#-credits) - [🙋🏽‍♀️ Getting Help](#♀️-getting-help) - [👀 Other Projects](#-other-projects) - [🤓 Author](#-author) ## ☁️ Installation npm install --save-dev eslint eslint-plugin-prefer-arrow-functions ## 🏓 Playground Try it yourself at [ASTExplorer.net](https://astexplorer.net/#/gist/7c36fe8c604945df27df210cf79dcc3c/12f01bed4dcf08f32a85f72db0851440b7e45cdd) by pasting code snippets in the top left panel, the results will appear in the bottom right panel. ## ⚖️ Configuration Add the plugin to the `plugins` section and the rule to the `rules` section in your .eslintrc. The default values for options are listed in this example. ```json { "plugins": ["prefer-arrow-functions"], "rules": { "prefer-arrow-functions/prefer-arrow-functions": [ "warn", { "allowNamedFunctions": false, "classPropertiesAllowed": false, "disallowPrototype": false, "returnStyle": "unchanged", "singleReturnOnly": false } ] } } ``` ## 🤔 Options ### `allowNamedFunctions` If set to true, the rule won't report named functions such as `function foo() {}`. Anonymous function such as `const foo = function() {}` will still be reported. ### `classPropertiesAllowed` When `true`, functions defined as [class instance fields](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes#Field_declarations) will be converted to arrow functions when doing so would not alter or break their behaviour. ### `disallowPrototype` When `true`, functions assigned to a `prototype` will be converted to arrow functions when doing so would not alter or break their behaviour. ### `returnStyle` - When `"implicit"`, arrow functions such as `x => { return x; }` will be converted to `x => x`. - When `"explicit"`, arrow functions such as `x => x` will be converted to `x => { return x; }`. - When `"unchanged"` or not set, arrow functions will be left as they were. ### `singleReturnOnly` When `true`, only `function` declarations which _only_ contain a return statement will be converted. Functions containing block statements will be ignored. > This option works well in conjunction with ESLint's built-in [arrow-body-style](http://eslint.org/docs/rules/arrow-body-style) set to `as-needed`. ## 👏🏻 Credits This project is a fork of by [Triston Jones](https://github.com/TristonJ). ## 🙋🏽‍♀️ Getting Help Get help with issues by creating a [Bug Report] or discuss ideas by opening a [Feature Request]. [bug report]: https://github.com/JamieMason/eslint-plugin-prefer-arrow-functions/issues/new?template=bug_report.md [feature request]: https://github.com/JamieMason/eslint-plugin-prefer-arrow-functions/issues/new?template=feature_request.md ## 👀 Other Projects If you find my Open Source projects useful, please share them ❤️ - [**eslint-formatter-git-log**](https://github.com/JamieMason/eslint-formatter-git-log)
ESLint Formatter featuring Git Author, Date, and Hash - [**eslint-plugin-move-files**](https://github.com/JamieMason/eslint-plugin-move-files)
Move and rename files while keeping imports up to date - [**ImageOptim-CLI**](https://github.com/JamieMason/ImageOptim-CLI)
Automates ImageOptim, ImageAlpha, and JPEGmini for Mac to make batch optimisation of images part of your automated build process. - [**Jasmine-Matchers**](https://github.com/JamieMason/Jasmine-Matchers)
Write Beautiful Specs with Custom Matchers - [**karma-benchmark**](https://github.com/JamieMason/karma-benchmark)
Run Benchmark.js over multiple Browsers, with CI compatible output - [**self-help**](https://github.com/JamieMason/self-help#readme)
Interactive Q&A Guides for Web and the Command Line - [**syncpack**](https://github.com/JamieMason/syncpack#readme)
Manage multiple package.json files, such as in Lerna Monorepos and Yarn Workspaces ## 🤓 Author

I'm [Jamie Mason] from [Leeds] in England, I began Web Design and Development in 1999 and have been Contracting and offering Consultancy as Fold Left Ltd since 2012. Who I've worked with includes [Sky Sports], [Sky Bet], [Sky Poker], The [Premier League], [William Hill], [Shell], [Betfair], and Football Clubs including [Leeds United], [Spurs], [West Ham], [Arsenal], and more.

[![Follow JamieMason on GitHub][github badge]][github] [![Follow fold_left on Twitter][twitter badge]][twitter]

[github badge]: https://img.shields.io/github/followers/JamieMason.svg?style=social&label=Follow [twitter badge]: https://img.shields.io/twitter/follow/fold_left.svg?style=social&label=Follow [arsenal]: https://www.arsenal.com [betfair]: https://www.betfair.com [github]: https://github.com/JamieMason [jamie mason]: https://www.linkedin.com/in/jamiemasonleeds [leeds united]: https://www.leedsunited.com/ [leeds]: https://www.instagram.com/visitleeds [premier league]: https://www.premierleague.com [shell]: https://www.shell.com [sky bet]: https://www.skybet.com [sky poker]: https://www.skypoker.com [sky sports]: https://www.skysports.com [spurs]: https://www.tottenhamhotspur.com [twitter]: https://twitter.com/fold_left [west ham]: https://www.whufc.com [william hill]: https://www.williamhill.com

eslint-plugin-prefer-arrow-functions

Downloads in past1 Month3 Months6 Months1 Year2 Years5 YearsAll time

Stats

Sick of boring JavaScript newsletters?

Downloads in past