创建 eslint 插件脚本
安装包
npm install xxx/eslint-plugin-self --save
.eslintrc.js
module.exports = {
extends: [
...
'plugin:xxx/eslint-plugin-self/recommended'
],
plugins: [
'xxx/self' // 省略 `eslint-plugin-` 前缀
],
// 或单独指定规则
// rules: {
// "xxx/self/no-relative-path": "error"
// }
};
.
├── docs
│ └── rules 添加新规则文档说明
│ └── add-your-rules.md
├── lib
│ ├── index.js 添加对外暴露
│ └── rules 添加新规则
│ └── add-your-rules.js
├── tests 测试自定义规则
│ └── lib
│ └── rules 添加新规则测试用例
│ └── add-your-rules.js
├── package.json
└── README.md 插件介绍文档
快速创建规则，根目录执行如下命令：
npm run createrule -- 【your-rule-name】
快速补充规则到 README.md:
npm run gen-readme-rules
-
规则逻辑
https://eslint.bootcss.com/docs/developer-guide/working-with-rules
-
规则测试
按照创建出的模板补充详细的用例说明，编写完成后使用如下命令测试：
npm run test:eslint-plugin-self -
规则文档
文档编写应简单明了，说明规则用途和相关示例
-
更新 README.md:
npm run gen-readme-rules