https://github.com/Quramy/eslint-plugin-tutorial

A tutorial/template repository to explain how to create your eslint plugins
https://github.com/Quramy/eslint-plugin-tutorial

eslint-plugin eslint-rules tutorial typescript

Last synced: about 2 months ago
JSON representation

A tutorial/template repository to explain how to create your eslint plugins

• Host: GitHub
• URL: https://github.com/Quramy/eslint-plugin-tutorial
• Owner: Quramy
• License: mit
• Created: 2019-03-04T06:00:53.000Z (over 5 years ago)
• Default Branch: main
• Last Pushed: 2024-07-31T19:50:40.000Z (about 2 months ago)
• Last Synced: 2024-07-31T23:52:34.517Z (about 2 months ago)
• Topics: eslint-plugin, eslint-rules, tutorial, typescript
• Language: TypeScript
• Homepage:
• Size: 1.22 MB
• Stars: 193
• Watchers: 3
• Forks: 37
• Open Issues: 12
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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!

## Tutorial

[See guides](./guide/README.md).

## 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

- GitHub actions configuration

## LICENSE

MIT