1.0.0 • Published 2 years ago
@agds/eslint-config-jsdoc v1.0.0
@agds/eslint-config-jsdoc
版本 :1.0.0
agds的jsdoc eslint配置,推荐lib项目使用此规则
快速开始
安装
npm i -D @agds/eslint-config-jsdoc
引入
// .eslintrc.js
module.exports = {
extends: [
'@agds/jsdoc',
],
};
添加lint脚本
在package.json
的scripts
下添加lint命令;
{
"scripts": {
"lint": "eslint --ext .js,.json,.md src",
"lint:fix": "eslint --ext .js,.json,.md src --fix"
}
}
基于lint-staged
提供增量lint脚本
- 安装
lint-staged
包npm i -D lint-staged
- 在
package.json
中添加pkg['lint-staged']
脚本{ "lint-staged": { "src/**/*.{js,json,md}": [ "eslint --fix" ] } }
使用yorkie
在git声明周期内检测代码格式
- 安装
yorkie
包npm i -D yorkie
- 在
package.json
中添加pkg.gitHooks
脚本{ "gitHooks": { "pre-commit": "lint-staged" } }
配置源码
module.exports = {
extends: [
'plugin:jsdoc/recommended',
],
plugins: [
'jsdoc',
],
settings: {
jsdoc: {
mode: 'typescript',
},
},
rules: {
// jsdoc
'valid-jsdoc': 'off',
'jsdoc/require-property': 0,
'jsdoc/require-returns-description': 0,
'jsdoc/no-undefined-types': 0,
},
};
许可证
MIT License Copyright (c) 2021 锦阳
请维护者喝杯咖啡
加入钉钉群讨论或加入开发
1.0.0
2 years ago