This guide is intended for those who wish to:
In order to work with ESLint as a developer, it's recommended that:
If that sounds like you, then continue reading to get started.
Before you can get started, you'll need to get a copy of the ESLint source code. This section explains how to do that and a little about the source code structure.
Developing for ESLint is a bit different than running it on the command line. This section shows you how to set up a development environment and get you ready to write code.
There are a lot of unit tests included with ESLint to make sure that we're keeping on top of code quality. This section explains how to run the unit tests.
You're finally ready to start working with rules. You may want to fix an existing rule or create a new one. This section explains how to do all of that.
You've developed library-specific rules for ESLint and you want to share it with the community. You can publish an ESLint plugin on npm.
If you aren't going to use the default parser of ESLint, this section explains about using custom parsers.
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.
Once you've made changes that you want to share with the community, the next step is to submit those changes back via a pull request.
© JS Foundation and other contributors
Licensed under the MIT License.