dustinspecker / awesome-eslint

A list of awesome ESLint plugins, configs, etc.

Awesome ESLint

A list of awesome ESLint configs, plugins, etc.

If you want to contribute, please read the contribution guidelines.

Contents

• Configs
  • Configs by Well-Known Companies/Organizations
  • Other Prominent Configs (100 stars or so)
  • Other Configs
• Preconfigured Configs with ESLint Set up
• Plugins
  • Code Quality
  • Compatibility
  • CSS in JS
  • Deprecation
  • Embedded
  • Frameworks
  • Languages and Environments
  • Libraries
  • Misc
  • Practices and Specific ES Features
  • Performance
  • Security
  • Style
  • Testing Tools
• Parsers
• Formatters
• Globals
• Tools
• Developing for ESLint
• Tutorials
• Installation and Setup

Configs

Configs by Well-Known Companies/Organizations

• Airbnb - Shareable config for Airbnb's style guide.
• Airbnb-babel - Airbnb's ESLint config with Babel Support.
• Airbnb-typescript - Airbnb's ESLint config with TypeScript support.
• Alloy - Progressive ESLint config for your React/Vue/TypeScript projects.
• ESLint - Contains the ESLint configuration used for projects maintained by the ESLint team.
• Facebook - Sharable config for Facebook's style guide.
• Feedzai - Feedzai's shareable config for JavaScript/React projects.
• React App - Sharable config for React projects.
• Shopify - Shareable config for Shopify's style guide.
• Vercel - Vercel Engineering's composable eslint configuration used in all their codebases.
• Wikimedia - Shareable config for Wikimedia's style guide, used by MediaWiki.

Other Prominent Configs (100 stars or so)

• Auto - Automatically configure ESLint based on your project's dependencies.
• Canonical - Shareable config for Canonical style guide.

• Standard - Shareable config for JavaScript Standard Style.
• XO - Shareable config for XO.

Other Configs

• Adjunct - A reasonable collection of plugins to use alongside your main ESLint configuration.
• Ash-Nazg - One config to rule them all!
• Cecilia - ESLint configuration for awesome projects.
• clean-typescript - Enforce classic JavaScript featuress in TypeScript codebase by banning excessive keywords.
• ES - Shareable config for very strict code.
• Hardcore - The most strict (but practical) ESLint config out there.
• Problems - Shareable config that only catches actual problems, and doesn't enforce stylistic preferences.
• Supermind - Shareable config for Supermind style.
• Sheriff - Comprehensive and highly opinionated Eslint configuration. Typescript oriented.

Preconfigured Configs with ESLint Set up

• Node.js Standard Style - Node.js core config.
• eslint-config-prettier - Prettier config for ESlint maintained by Prettier team
• Standard - JavaScript Standard Style.
• Superlint - JavaScript Supermind Style.
• XO - JavaScript happiness style linter ❤️.
• Healthier - Code style agnostic version of Standard, perfect companion to Prettier.

Plugins

Code Quality

• GitHub - Misc. rules from GitHub.
• SonarJS - Rules detecting bugs and suspicious patterns.
• Unicorn - Various awesome ESLint rules.
• @mysticatea/eslint-plugin - Misc. rules.
• @brettz9/eslint-plugin - Misc. rules. of @mysticatea without the personal config.

Compatibility

• Compat - Lint browser compatibility of APIs used (caniuse as an ESLint plugin).
• ecmascript-compat - Disable ECMAScript language features not supported by your browserslist targets.
• es - Disable specific ECMAScript language versions or individual features.
• es5 - ESLint plugin for ES5 users (forbid ES2015+ usage).
• ie11 - Detect unsupported ES6 features in IE11.

CSS in JS

• CSS-modules - Lint undefined or unused rules for css modules.
• Emotion - ESLint rules for emotion.
• Styled Components
  • Better Styled Components - Auto fixable ESlint's rules for styled components.
  • styled-components-a11y - A11y for Styled Components.

Deprecation

• deprecate - Mark functions or modules as deprecated and get lint messages when they are used.
• deprecation - Identifies use of jsdoc @deprecated functions.
• disable - Disable specified plugins using file path patterns and inline comments.

Embedded

• HTML - Linting for JavaScript inside of HTML <script> tags.
• Markdown - Linting for JavaScript inside of Markdown.

Frameworks

• Angular - Linting rules for Angular (v2+).
• AngularJS - Linting rules to adhere to the John Papa's AngularJS Styleguide.
• Astro - Plugin for Astro components.
• Backbone - Linting rules for Backbone.
• Custom Elements - Rules by GitHub for Custom Elements.
• Ember - Linting rules for Ember.
• Hapi - Linting rules for hapi.
• Meteor - Meteor specific linting rules for ESLint.
• React
  • JSX a11y - Accessibility rules on JSX elements.
  • React - Linting rules for React and JSX.
  • React Hooks - Linting rules for React Hooks.
  • React Native - React Native specific linting rules.
  • React-Redux - React-Redux specific linting rules.
• Solid - Linting rules for Solid and JSX.
• Svelte - Linting rules for Svelte v3 Components.
• Vue
  • VueJS - Plugin for VueJS.
  • VueJS Scoped CSS - Plugin for Scoped CSS in VueJS.

Languages and Environments

• AssemblyScript - Rules for enforcing restrictions on TypeScript toward AssemblyScript compliance.
• Babel - Adds replacements for built-in rules to include Babel features.
• Coffee - Enables linting CoffeeScript files with, with optional linting rules from the Coffeelint library.
• eslint-plugin-eslint-plugin - An ESLint plugin for linting ESLint plugins.
• Flow
  • Flow - Flow type linting rules.
  • Flow Errors - Run Flow as an ESLint plugin.
• HTML - ESLint plugin for HTML.
• JSON
  • JSON - Lint your JSON files.
  • JSON, package.json - Lint, format, and auto-fix your JSON files. Sort your package.json.
  • JSON with Comments - ESLint plugin for JSON, JSONC and JSON5.
  • JSON Schema - Validates data defined in JavaScript, JSON, YAML and TOML using JSON Schema Validator.
• MDX - ESLint Parser/Plugin for MDX.
• Node - Additional ESLint's rules for Node.js.
• SQL - SQL linting rules for ESLint.
• TOML - ESLint plugin for TOML.
• TypeScript - Linting rules for TypeScript.
• YAML - ESLint plugin for YAML.

Libraries

• GraphQL
  • dotansimha/graphql-eslint - Validates, prettifies and checks your GraphQL operations and GraphQL schema for best-practices.
  • apollostack/eslint-plugin-graphql - Check your GraphQL query strings against a schema.
• TypeGraphQL - Linting rules for TypeGraphQL, targeted at finding common mistakes.
• jQuery - Linting rules for jQuery, including versioned configs for deprecated features.
• JSDoc - Linting rules for JSDoc comments (including the JavaScript within @example).
• Lodash
  • Lodash - Lodash specific linting rules.
  • Lodash/fp - Lodash/fp specific linting rules.
  • Lodash template - Plugin for Lodash template/Underscore template.
  • Microtemplates (Used in Lodash and Underscore.js)
• Mongodb - Mongodb native Node.js driver linting rules.
• Ramda - Ramda specific linting rules.
• RequireJS - Linting rules for RequireJS.
• Tailwind CSS - Linting rules for Tailwind CSS classnames.

Misc

• Diff - Run ESLint on your changed lines only. Also supports CI!
• Misc - Miscellaneous rules including rules for creating custom checks and wrapping (modifying) third-party rules.
• Notice - An eslint rule that checks the top of files and fixes them too!
• Only-Error - Convert all rules to errors.
• Only-Warn - Convert all rules to warnings.
• PutOut - an ESLint plugin integrates putout linter into ESLint.
• TypeLint - Introduces types, based on existing schemas (Swagger, Redux) and linting access to object properties, preventing undefined errors.
• Woke - Helps catch insensitive words, promoting an inclusive codebase.

Practices and Specific ES Features

• array-func - Avoid redundancy when using es2015 array methods and functions.
• arrow functions - ESLint rules to ensure proper arrow function definitions.
• boundaries - Ensures that your architecture boundaries are respected by the elements in your project checking file structure and dependencies.
• ESLint Comments - Best practices about ESLint directive comments (/*eslint-disable*/, etc.).
• eslint-plugin-hexagonal-architecture - A plugin that helps you to enforce hexagonal architecture best practices.
• eslint-plugin-write-good-comments - Enforce good writing style in comments.
• fp - ESLint rules for functional programming.
• functional - ESLint rules to disable mutation and promote fp in JavaScript and TypeScript.
• Immutable - Disable all mutation in JavaScript.
• import - Linting of ES2015+ import/export syntax, and prevent issues with misspelling of file paths and import names.
• new-with-error - Require errors to be thrown using new.

• no-argument-spread - Lints against expressions like Math.max(...args) that can lead to a stack overflow for large arrays.
• no-comments - Prevents leaking comments into production if bundler is not used and stops developers from commenting out old lines of code.
• no-constructor-bind - Encourages use of class properties by reporting use of this with bind or setting state in constructors.
• no-inferred-method-name - Custom rule for ESLint that checks for inferred method names within object literals.
• no-loops - It's 2019 and you still use loops?
• no-restricted-syntax - Show queried syntax's content in messages.
• no-use-extend-native - Prevent using extended native objects.
• Promise - Best practices when working with promises.
• pure - Enforce pure functions (without side effects).
• RegExp - ESLint plugin for finding regexp mistakes and style guide violations.
• sort-keys-fix - Adds fixer for ESLint sort-keys rule.
• this - Write pure functions, don't allow this.
• toplevel - An eslint plugin for disallow side effect at module toplevel.

Performance

• DOM
• Optimize Regex - Optimize regex literals.
• Perf-Standard plugin and Config

Security

• no-secrets - An eslint plugin that detects potential secrets/credentials.
• no-unsanitized - Checks for innerHTML, outerHTML, etc.
• pii - Checks and enforces PII Compliance of the code. i.e. no email address, birth date, IP address or phone number in comments or string literals.
• ScanJS config and plugin - Security-related rules.
• Security - ESLint rules for Node Security.
• xss - Tries to detect XSS issues in codebase before they end up in production.

Style

• const case - Enforce capitalization of constant primitive literals.
• editorconfig - Derive rules from .editorconfig.
• filenames - Ensure consistent filenames for your JavaScript files.
• Simple import sort - Easy autofixable import sorting.
• perfectionist sorting - Sort objects, imports, TypeScript types, enums, JSX props, etc.
• Switch case - Switch-case-specific linting rules for ESLint.
• padding - Allows/disallows padding between statements.
• paths - Use paths from tsconfig/jsconfig and auto fix relative paths to aliases.

Testing Tools

• AVA - Linting rules for AVA.
• Chai
  • expect practices
  • with unused expressions
  • permitted keywords
  • with chai-as-promised plugin
  • globals
• Cucumber - Linting rules for Cucumber.
• Cypress - Linting rules for Cypress.
• Jasmine - Linting rules for Jasmine.
• Jest
  • Enforcing practices - Linting rules for Jest.
  • Enforcing consistent formatting - Formatting rules for Jest.
  • Jest-async - Async linting rule for Jest.
  • Jest-DOM - Linting rules for Jest-DOM.
• Mocha
  • Enforcing practices - Linting rules for Mocha.
  • Enforcing manageability
• Playwright - Linting rules for Playwright.
• QUnit - Linting rules for QUnit.
• TestCafe-Community - TestCafe linting rules with env globals (fork from TestCafe globals).
• Testing Library - Linting rules for Testing Library.

Parsers

• babel-eslint-parser - @babel/eslint-parser allows you to lint ALL valid Babel code with the fantastic ESLint.
• TypeScript - A TypeScript parser that produces output compatible with ESLint.
• BrightScript - BrightScript plugin for Roku development. Includes Parser and Rules.
• GraphQL - Parser for the GraphQL AST. Includes parser, plugin, processor (for non-graphql files) and rules.

Formatters

• html - A enhanced ESLint formatter
• badger - Make SVG-based badges summarizing ESLint results (e.g., for use on a README).
• git-log - ESLint Formatter featuring Git Author, Date, and Hash.
• github - See ESLint errors and warnings directly in pull requests.
• gitlab - Output ESLint results in the GitLab code quality results.
• mo - Good-lookin' ESLint formatter and also for delightful reading experience.
• SARIF - Generate a results in a SARIF format so it can be imported into tools like GitHub Advanced Security.
• summary-chart - Format ESLint output into a bar chart.

Globals

• confusing-browser-globals - A curated list of browser globals that commonly cause confusion and are not recommended to use without an explicit window. qualifier.
• ES and browser globals (originally from ESLint)
• chai globals
• TestCafe globals - fixture & test globals for TestCafe.

Tools

• eslint-define-config - Provide a defineConfig function for .eslintrc.js files.
• es-file-traverse - Obtain a list of only those files which are in use based on imports and/or requires from an entry file or files; list passable to ESLint. Intended esp. for linting 3rd party dependencies.
• eslint-find-rules - Find built-in ESLint rules you don't have in your custom config.
• eslint-index - CLI for finding and managing rules in ESLint config files.
• eslint-interactive - The CLI tool to fix huge number of ESLint errors.
• eslint-multiplexer - Multiplex eslint results and merge results for common files.
• eslint-nibble - Ease into ESLint, by fixing one rule at a time.
• eslint-rule-documentation - Find the url for the documentation of an ESLint rule.
• eslint-watch - Run ESLint with watch mode.
• codacy-eslint - Docker used at Codacy to run ESLint.
• esprint - Run ESLint across multiple threads.
• generator-eslint - Generate ESLint plugin and rules with Yeoman.
• editor-info - Detect whether one is within an editor/IDE and which type, allowing one to tweak ESLint configuration accordingly.
• eslint-dashboard - Interactive ESLint workflow that lives in your terminal.
• eslint-remote-tester - CLI tool for testing given ESlint rules against multiple repositories at once.

Developing for ESLint

• eslint-doc-generator - Generate documentation for your ESLint plugin including a rules table for your readme and header for your rule docs.
• eslint-docgen - Automatically generate ESLint plugin documentation from rule metadata and test cases.

Tutorials

• Creating an ESLint Plugin - Article walking through the creation of an ESLint rule and plugin.
• Lint Like It's 2015 - Article walking through the benefits of using ESLint.
• Linting JavaScript with ESLint - Video showing ESLint setup and basics.
• Linting React JSX with ESLint (in ES6) - Video showing how to use React and JSX with ESLint.
• Plugin Module with Mixins - Article on how to write a plugin as a node module containing modular mixin configuration.
• Writing a rule to spot undeclared props hiding in plain sight - Article about creating rules that require scope analysis.

Installation and Setup

• Lintier - CLI to quickly scaffold an ESLint & Prettier setup in a TypeScript project.

awesome-eslint's Issues

RFC: eslint-docs

eslint-docs is a tool created by me that makes maintaining ESLint plugins easier. It ensures that the names and descriptions of a plugin’s rules are consistent in the rule source, the documentation, and the README. Is this worth including in this awesome list?

react is a library not a framework

read title

Restricted Globals

The current repository is deprecated.

eslint-plugin-tailwindcss

👋🏻
Would you consider adding eslint-plugin-tailwindcss ?
Self advertising it is 😅
https://github.com/francoismassart/eslint-plugin-tailwindcss

Let me know if you need me to create a pull request 🙏🏻

Meteor

The current repository is deprecated.

Add playwright eslint plugin

https://github.com/playwright-community/eslint-plugin-playwright

file names

I am not sure if you think the file name plugin is important. I like it.

https://github.com/selaux/eslint-plugin-filenames

how to know if a plugin is useful ?

Hi,

I often use recursion (nested JSON object coming the backend) and this plugin no-inferred-method-name caught a few errors that would have taken me some times to figure out.

This is quite useful to me but I wonder if it has its place and if it is where to put it?

Announcing one's tools

ESLint has a Discord server along with a specific room #lookwhatimade : https://discord.com/channels/688543509199716507/710284382321115186

Submitters here of their own projects might wish to announce their changes also on that channel.

@dustinspecker , just thought I could inform users with this issue, and if you like, pin this issue so new submitters might see it.

eslint-formatter-html

Glad to recommend a good item to you:

eslint-formatter-html

Add plugin eslint-nibble

Can you add eslint-nibble in the awesome list ?

Ease into ESLint, by fixing one rule at a time

/cc @IanVS

eslint-docs

The current repository is deprecated.

Additions order

Contribution guidelines says that link additions should be added to the bottom of the relevant category.

Should we change them to follow alphabetical order?

Replace prettier-standard by official prettier config

As recommended by Prettier docs, you should use the official prettier eslint config instead of using eslint plugins. I think prettier-standard falls in this category and should not be recommended in this list.

I can make a PR for this if you want.

How to use this package?

Looks good, It would be good if provided with usage details, looking forward for hearing back

PR for eslint-plugin-flowtype-errors

This plugin reports flow errors as ESLint errors.

https://github.com/amilajack/eslint-plugin-flowtype-errors

Would a PR for this be welcome?

Plugin for Angular (v2+)

You have the "eslint-plugin-angular" package in your list but it's only for AngularJS (= Angular v1, deprecated).

An awesome one (maintained and widely used) for Angular (not AngularJS) is https://github.com/angular-eslint/angular-eslint

Add eslint-plugin-no-argument-spread

https://github.com/causalhq/eslint-plugin-no-argument-spread

Backing context: it's been discussed on Twitter a bit how spreading arguments can lead to stack overflows. https://twitter.com/AndaristRake/status/1572486809631744005 <- replayio/devtools#7785.

@andrewfrankel & the folks at Causal built an ESLint rule for it!

Split Configs into 2 Sections

Going forward it would be great to have the existing Configs section split into 2 sections named Configs by Companies and Configs by Developers (or something along these lines).

This lets folks know what configs are supported by a company versus a single developer, while still enabling configs by single developers to be discovered via this list. It also makes it easy to accept config Pull Requests for an individual's personal config.

Babel

The current repository is deprecated.

RFC: Add `eslint-plugin-compat`

This eslint plugin lints against APIs that are only supported by target browsers 🎉 Would a PR for adding this plugin be welcome?

Here's a demo of it in action

Mark google config as archived/no longer maintained

I think the google config should either be removed, or marked as archived/no longer maintained.

clean-regex

The current repository is deprecated.

improve linting results step-by-step

Hi

Thanks a lot for this list.
I ran out of options. I need some tool to allow me to compare linting errors and warnings on current working branch with some code baseline, not to allow new (more) errors/warnings than it was before. I used to have such a tool configured for TravisCI long time ago, but I'm not able to reverse-engineer that solution. Do you have any ideas? Maybe I just didn't found good google search phrase?

Regards