npm 包 eslint-config-tunnckocore 使用教程

阅读时长 3 分钟读完

ESLint 是一个 Javascript 静态代码检查工具,可以帮助我们发现并修复代码中的错误和风格问题。而 eslint-config-tunnckocore 则是一个 ESLint 的配置包,提供了一套符合 TunnckoCore 团队代码规范的 ESLint 配置。

安装

可以使用 npm 安装:

配置

在项目根目录下创建 .eslintrc.js 文件,并将以下内容添加到文件中:

使用

在命令行中使用以下命令进行检查:

也可以在 package.json 中添加以下脚本:

然后使用以下命令进行检查:

示例

以下是一个示例代码:

运行 ESLint 检查后会发现有一个警告:

这是因为我们没有对 hello 函数添加 JSDoc 注释,所以 ESLint 给出了一个警告。根据 TunnckoCore 团队的代码规范,我们应该添加 JSDoc 注释来描述函数的作用和参数信息:

-- -------------------- ---- -------
---
 - -----
 -
 - ------ -------- ---- - --
 --
-------- ----------- -
  ------------------- -----------
-

---------------

再次运行 ESLint 检查,警告消失了。这说明我们已经成功地使用 eslint-config-tunnckocore 进行了代码检查,并且遵循了 TunnckoCore 团队的代码规范。

结论

通过本文,我们学习了如何安装、配置和使用 eslint-config-tunnckocore 进行代码检查,并对符合 TunnckoCore 团队代码规范的代码进行了指导。希望本文能够帮助读者更好地理解和使用此工具。

来源:JavaScript中文网 ,转载请注明来源 https://www.javascriptcn.com/post/52467

纠错
反馈