npm 包 brakko 使用教程

介绍

brakko 是一个基于 Node.js 的命令行工具，用于检查项目中 JS 代码的语法错误和潜在问题。其使用简便，速度快速，同时支持定制化的配置。

安装

可以通过 npm 安装，使用下面的命令：

npm install -g brakko

使用

在项目的根目录下执行下面的命令，brakko 会检查项目中的所有 JS 代码文件：

brakko

如果只需要检查部分文件，可以传入相应的路径，如：

brakko src/index.js

配置

brakko 的默认配置适用于大多数项目，但是对于一些特定的需求，可能需要进行一些自定义的配置。

.brakkorc.json 文件

在项目根目录下新建一个名为 .brakkorc.json 的文件，用于存放自定义配置。其中，可以配置以下选项：

• rules：设置不需要检查的规则。例如，可以使用 "no-implicit-globals": false 来禁用隐式全局变量的检查。
• globals: 设置全局变量。如有需要，可以加入额外的全局变量，以避免出现「未定义」错误。例如，可以使用 "globals": {"gGlobalVar": false} 来设置全局变量 gGlobalVar 不存在。

例如，下面是一个完整的 .brakkorc.json 文件示例：

{
  "rules": {
    "no-implicit-globals": false
  },
  "globals": {
    "gGlobalVar": false
  }
}

命令行选项

在执行命令时，也可以通过传入选项来进行定制化的配置。例如：

brakko --no-switch-case-fall-through

这个选项表示关闭 switch 语句 case 分支中没有 break 或 return 的提示。

配置文件优先级

在执行命令时， brakko 会首先尝试读取 .brakkorc.json 文件中的配置，如果没有找到，则会读取默认配置。

如果在命令行中传入了某个选项，则该选项会覆盖 .brakkorc.json 中的相应项。

示例代码

下面是一个示例 brakko 配置文件，使用该配置文件可以忽略掉所有关于全局变量的检查：

{
  "globals": {
    "gGlobalVar": false
  }
}

总结

使用 brakko 可以在开发过程中更快速、更准确地发现潜在的代码问题，提高项目代码的可靠性和品质。同时，根据实际需求，可以对 brakko 进行定制化的配置，以满足不同项目的需求。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/60055a0d81e8991b448d7b2d