什么是 eslint-config-closure-es5
eslint-config-closure-es5
是一个基于 Google Closure Style Guide 编写的 JavaScript 代码风格检查配置文件,可以用于 ESLint 工具中。由于 Google Closure Style Guide 是一个较为严格的标准,使用 eslint-config-closure-es5
能够帮助我们更好地规范和优化编写的 JavaScript 代码。
如何使用 eslint-config-closure-es5
安装
在使用之前,需要保证已经安装了 ESLint, 如果没有安装,可以通过以下命令进行安装:
--- ------- ------ ---------- - ---- ---- -- ---- --- ------ --
安装完成后,再通过以下命令安装 eslint-config-closure-es5
:
--- ------- ------------------------- ---------- - ---- ---- -- ---- --- ------------------------- --
配置
在项目根目录下,新建一个 .eslintrc.json
文件,添加以下内容:
- ---------- ------------- -
此时,已经成功引入了 eslint-config-closure-es5
配置文件,可以开始使用了。
使用
-- ----- --- - - ------ ------- -- ----- --- - - ------ -------
如果你采用了以上写法,eslint 工具将会给出以下警告:
--- ------- ------- ---- --- ------------ ------
即字符串必须使用单引号的警告,这样可以更好地遵循 Google Closure Style Guide 规范。
-- ----- -- -- -- -- -- -- ----- -- -- --- -- --
同样,当你使用 ==
比较符时,eslint 也会警告你应该使用 ===
比较符来进行严格的类型检测。
配置参数
除默认配置外,还可以在 .eslintrc.json
文件中配置个性化参数,以下是常用的一些参数:
closure-es5/require-jsdoc
"off"
: 不强制要求添加 JSDoc 注释。"warn"
: 默认值,只给出警告,不会造成程序停止运行。"error"
: 强制要求添加 JSDoc 注释。
closure-es5/require-returns
"off"
: 不强制要求对函数添加@return
JSDoc 注释。"warn"
: 默认值,只给出警告,不会造成程序停止运行。"error"
: 强制要求对函数添加@return
JSDoc 注释。
closure-es5/require-param
"off"
: 不强制要求对参数添加@param
JSDoc 注释。"warn"
: 默认值,只给出警告,不会造成程序停止运行。"error"
: 强制要求对参数添加@param
JSDoc 注释。
closure-es5/require-visibility-modifiers
"off"
: 不强制要求定义类、类成员的可见性。"warn"
: 默认值,只给出警告,不会造成程序停止运行。"error"
: 强制要求定义类、类成员的可见性。
closure-es5/no-unused-args
"off"
: 匹配黄色警告级别,对未使用的参数或变量给出警告,但不会导致程序停止运行。"warn"
: 匹配黄色警告级别,对未使用的参数或变量给出警告,但不会导致程序停止运行。"error"
: 匹配红色错误级别,对未使用的参数或变量将会报错,导致程序停止运行。
总结
eslint-config-closure-es5
是基于 Google Closure Style Guide 标准的一个 JavaScript 代码风格检查配置文件,可以帮助我们更好地规范和优化代码。使用 eslint-config-closure-es5
不仅意义深远,而且在实际开发过程中,也能够大大提高代码的质量和可读性。
来源:JavaScript中文网 ,转载请联系管理员! 本文地址:https://www.javascriptcn.com/post/60065f80238a385564ab6b31