Skip to content
A tutorial/template repository to explain how to create your eslint plugins
Branch: master
Clone or download
Quramy Merge pull request #11 from meganemura/remove-dev-deps-for-tutorial
uninstall @typescript-eslint/parser in start-tutorial script
Latest commit 836b0c1 Jan 11, 2020
Type Name Latest commit message Commit time
Failed to load latest commit information.
.circleci Revert "update misc" Jul 28, 2019
guide Merge pull request #9 from yinm/master Jan 10, 2020
src fix typo Dec 30, 2019
.gitignore Add 2nd chapter (#2) Mar 6, 2019
LICENSE initial commit Mar 4, 2019 chore Mar 21, 2019
package.json uninstall @typescript-eslint/parser in start-tutorial script Dec 30, 2019
tsconfig.json initial commit Mar 4, 2019
yarn.lock Revert "update misc" Jul 28, 2019

ESLint plugin tutorial

What's this?

This is an example repository to explain how to create your ESLint rules.

Why should we learn how to create custom ESLint rules?

Lint rules help to keep our codes' quality constant. Automatic code checking brings time for more productive activities, and also eliminates indivisual effects from code review.

Creating ESLint rules is a good subject to learn AST(Abstract Syntax Tree) analysis. Today, analysis of AST is the foundation of the JavaScript build ecosystem. There are many libraries using AST, such as Babel plugins, custom TypeScript transformers, prettier, webpack and so on. Your team's JavaScript gets improved significantly if you can control AST freely!


See guides.

Getting started

This repository is also designed to work as a project template for custom ESLint rules.

If you want to start quickly, follow the procedure below:

  • Clone this repository
  • Remove .git and guide dirs
  • Change pkg name via edit package.json
  • Change and test rule codes under src/rules dir

This repository includes:

  • TypeScript setting
  • Jest
  • CircleCI configuration



You can’t perform that action at this time.