eslint-plugin-better-codes

简体中文

简介

eslint-plugin-better-codes 是一组自定义的 ESLint 插件规则集合，其中包含用于检测并禁止被注释掉的代码的规则 eslint-no-commented-code。帮助团队保持代码库清洁，避免大量被注释的冗余代码。

安装

使用 npm:

npm install --save-dev eslint-plugin-better-codes

或使用 yarn:

yarn add -D eslint-plugin-better-codes

使用方式

在你的 ESLint 配置文件中启用插件并打开规则。例如 .eslintrc.js：

module.exports = {
  plugins: ["better-codes"],
  rules: {
    "better-codes/no-commented-code": "error",
  },
};

规则名：no-commented-code（导出于 index.js 中）。

主要功能

no-commented-code

禁止提交注释掉的代码：

• 对于单行注释：累计行数大于等于minLines时报错。对于第一个字符为中文、大写英文字母、数字，不进行校验。如果最后面包含ignore-eslint，不进行校验（最多可以忽略minLines - 1次）
• 对于多行注释：单块累计行数或者累计块数大于等于minLines时报错，空格行、只包含*的行、空行不计数。如果内容包含@param、@returns(函数注释)，@D(d)escription（文件头注释），@C(c)omment（块状功能注释）不进行校验，注释的内容如果以中文、数字、大写英文字母开头，不进行校验

function-with-try-catch

强制函数必须包含 try-catch 语句块

• 普通函数
• 箭头函数
• 方法函数

不校验的情况：

• React组件函数
• 函数体只有一行代码的函数。例如const exportData = async () => await service.exportData(selectList)
• 函数体只有一条执行语句的函数。例如

  const handleDelete = ({ id }) => {
    Modal.confirm({
      title: "确认删除该条数据？",
      onOk: async () => service.deleteData(id),
    });
  };

• 用于map/forEach中返回元素/组件用于渲染的箭头函数
• 嵌套函数内的子函数,，如果父函数已经包含try-catch，则子函数不进行校验

long-expression-with-optional-chain

强制使用可选链操作符（?.）来约束长表达式的点访问

针对赋值表达式 = 左半部分的表达式不会进行校验，将来进行针对性处理

针对new语句中的表达式不会进行校验，将来进行针对性处理

更新日志

功能新增

功能调整

1.4.14

取消long-expression-with-optional-chain规则中对于例如new echarts.graphic.LinearGradient()中.LinearGradient()的校验

Bug修复

1.4.12

修复long-expression-with-optional-chain规则中对于例如obj.user.getName().num中的getName().num不会进行校验的情况

许可证

MIT