Extend ESLint

This guide is intended for those who wish to extend the functionality of ESLint.

In order to extend ESLint, it’s recommended that:

  • You know JavaScript, since ESLint is written in JavaScript.
  • You have some familiarity with Node.js, since ESLint runs on it.
  • You’re comfortable with command-line programs.

If that sounds like you, then continue reading to get started.

Create Plugins

You’ve developed custom rules for ESLint and you want to share them with the community. You can publish an ESLint plugin on npm.

Custom Rules

This section explains how to create and modify rules to use with ESLint.

Custom Formatters

This section explains how you can create a custom formatter to control what ESLint outputs.

Custom Parsers

If you don’t want to use the default parser of ESLint, this section explains how to create custom parsers.

Custom Processors

This section explains how you can use a custom processor to have ESLint process files other than JavaScript.

Share Configurations

This section explains how you can bundle and share ESLint configuration in a JavaScript package.

Node.js API Reference

If you’re interested in writing a tool that uses ESLint, then you can use the Node.js API to get programmatic access to functionality.