Skip to content

配置注释

配置注释概念

将配置直接通过注释的方式写在脚本文件中,然后再进行代码校验。

为什么会有配置注释?

因为我们在开发的过程中,难免会遇到几个要违反配置规则的情况,这种情况不能因为几个点推翻校验规则,就使用配置注释去解决。

具体使用

  1. 写一个有问题的代码
js
// ${name} error: standard标准是不让这样写的
const str1 = "${name} is a coder"

console.log(str1)
  1. 运行npx eslint .\01.js可以看到报错no-template-curly-in-string
  2. 在这行代码后面添加注释,忽略折行代码的检测
js
const str1 = "${name} is a coder" // eslint-disable-line

console.log(str1)

这样可以避免错误但是会导致其他问题无法显示,例如这里是不允许用双引号。 4. 优化,在注释后面添加要忽略的规则,就可以只忽略我们定的规则,这时候双引号的问题就会暴露出来。

js
const str1 = "${name} is a coder" // eslint-disable-line no-template-curly-in-string

console.log(str1)

功能

不仅仅能够禁用某个规则,还可以声明全局变量,修改某个规则的配置,临时开启某个环境等。

有需要去找文档进行具体的使用:

Configuring ESLint

MIT Licensed