EsLint自定义规则

103 阅读1分钟

npm初始化与包安装

npm init -y
npm install eslint -D

编写Eslint规则文件

// index.js

module.exports = {
    rules: {
        '规则名字': {
            meta: {                
            },
            create(context) {
                return {
                    // 具体的规则
                };
            }
        }
    }
}

编写单元测试

// xxx.spec.js

const { RuleTester } = require('eslint');
const { rules } = require('../index');

console.log(RuleTester);

const ruleTester = new RuleTester();

ruleTester.run("get", rules.get, {
    valid: [
        // 符合规则的案例
    ],
    invalid: [
        // 不符合规则的案例
    ]
})

配置package.json

{
	"name": "eslint-plugin-插件名字",
	"version": "1.0.0",
	"description": "",
	"main": "index.js",
	"scripts": {
		"test": "node tests/xxx.spec.js",
	},
	"author": "DJ",
	"license": "ISC",
	"devDependencies": {
		"eslint": "^8.56.0",
	}
}

终端运行

npm run test