Skip to main content
版本: 5.x

ko-lint-config

ko-lint-config 为您节省时间的三种方式：

  • 无需配置 - 让您更容易的在项目中强制使用代码检查。无需进行额外的配置就可以运行。
  • 自动格式化代码 - 只需运行 pnpm lint-fix，就可以告别混乱或不一致的代码。
  • 发现样式问题和程序错误 - 减少代码审查过程中的手动审核，并将简单的事情留给工具来节省时间。

别犹豫了，别再维护 .eslintrc。现在就试试吧！

详细规则​

  • 需要四个空格 – 缩进
  • 字符串需要单引号 – 除了需要转义的地方
  • 需要关键字后跟空格 - if (condition) {...}
  • 函数名后不需要空格 - function name (arg) {...} 除了匿名函数和异步 function (arg) {...} `` async () { ... }
  • 分号不是必需的
  • 不强制 = = = - 后端返回的字段类型无法保证
  • 不强制三元运算符换行
  • 允许但不要求尾随逗号 - 当最后一个元素或属性在不同行时，与结尾或属性不同行
  • 函数内容允许为空
  • 允许使用 this 别名 - 别名可选 self _this `that'，不能从中解构出来
  • 不允许debugger
  • 不允许使用控制台打印

安装​

pnpm add ko-lint-config -D

使用​

如何引入 Code Style Guide

1、Then, add this to your .eslintrc.js、.prettierrc.js、.stylelintrc.js file:

module.exports = {
  extends: [require.resolve('ko-lint-config')],
}
const prettier = require('ko-lint-config/.prettierrc')

module.exports = {
  ...prettier,
}
module.exports = {
  extends: [require.resolve('ko-lint-config/.stylelintrc')],
}

你不应该覆盖这些配置，因为统一代码规范是属于团队的

2、在package.json中添加如下脚本:

"scripts": {
  "lint": "npx eslint './src/**/*.ts' './src/**/*.tsx'",
  "lint-fix": "npx eslint './src/**/*.ts' './src/**/*.tsx' --fix",
  "lint-css": "npx stylelint './src/**/*.scss' './src/**/*.css'",
  "lint-css-fix": "npx stylelint './src/**/*.scss' './src/**/*.css' --fix"
},

你可以使用 pnpm lint-fix 来修复大多数代码风格问题。

如何禁用 eslint 规则？​

在极少数情况下，您需要打破规则并隐藏由 Code Style Guide 生成的错误。

ko-lint-config 底层使用 ESLint，您可以像直接使用 ESLint 一样正常隐藏错误。stylelint 与 eslint 相同。

在特定行上禁用 所有规则：

file = 'I know what I am doing' // eslint-disable-line

或者, 禁用 指定 规则 "no-use-before-define":

file = 'I know what I am doing' // eslint-disable-line no-use-before-define

或者, 对多行禁用 "no-use-before-define" 规则:

/* eslint-disable no-use-before-define */
console.log('offending code goes here...')
console.log('offending code goes here...')
console.log('offending code goes here...')
/* eslint-enable no-use-before-define */

想找比这更简单的东西吗？​

您可以添加到“pnpm lint”脚本中，并为vscode安装eslint插件。