一、ESLint是什么?
ESLint 是一个JavaScript 代码检查工具,通过静态分析对代码进行检查。默认使用 Espree 解析器将代码解析为 AST 抽象语法树,然后再对代码进行检查。
ESLint 内置了一些规则,点击详细查看。但在实际项目开发时可能会有一些自定义的需求,你可以通过自定义ESlint插件来实现自定义规则的需求。
二、实现ESlint插件的步骤
1.安装工具
代码如下:
npm i -g yo
npm i -g generator-eslint
2.初始化ESlint插件项目
ESLint 插件命名规则:带前缀 eslint-plugin-
代码如下:
mkdir eslint-plugin-project
cd eslint-plugin-project
yo eslint:plugin
# 命令行交互流程,流程结束后生成 ESLint 插件项目基本框架
? What is your name? // 作者名字
? What is the plugin ID? // 插件 ID
? Type a short description of this plugin // 插件描述
? Does this plugin contain custom ESLint rules? // 插件是否包含自定义ESLint规则
? Does this plugin contain one or more processors? // 插件是否包含一个或多个处理器
创建好的项目目录结构:
├── README.md
├── docs // 规则文档
│ └── rules
│ └── xxx.md
├── lib
│ ├── index.js // 入口文件