安装

通过Cargo

$ cargo install rslint_cli
$ rslint --help

预构建的二进制文件

我们为每个版本发布Windows、Linux和MacOS的预构建二进制文件，您可以在这里找到。

从源代码构建

$ git clone https://github.com/rslint/rslint.git
$ cd rslint
$ cargo run --release -- --help

使用方法

要使用代码检查器，只需将需要检查的文件传递给CLI

$ echo "let a = foo.hasOwnProperty('bar');" > foo.js
$ rslint ./foo.js
error[no-prototype-builtins]: do not access the object property `hasOwnProperty` directly from `foo`
  ┌─ ./foo.js:1:9
  │
1 │ let a = foo.hasOwnProperty('bar');
  │         ^^^^^^^^^^^^^^^^^^^^^^^^^
  │
help: get the function from the prototype of `Object` and call it
  │
1 │ let a = Object.prototype.hasOwnProperty.call(foo, 'bar');
  │         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  │
  ╧ note: the method may be shadowed and cause random bugs and denial of service vulnerabilities

Outcome: 1 fail, 0 warn, 0 success

help: for more information about the errors try the explain command: `rslint explain <rules>`

RSLint CLI无需配置文件即可使用，并将选择推荐的非风格规则来运行。

功能

速度。RSLint使用并行性利用多个线程来加速代码检查，同时在编译成本地代码的基础上。

低内存占用。RSLint的语法树利用interning和其他方法在代码检查过程中大幅减少内存使用。

合理的默认值。CLI在未指定配置文件时假定推荐的非风格规则，并忽略如node_modules之类的目录。

错误恢复。RSLint的自定义解析器可以从语法错误中恢复，即使在语句的某些部分缺失的情况下也能生成可用的语法树。允许在编写时进行准确的即时代码检查。

无混淆选项。解析器的ECMAScript版本无需配置，解析器假定最新的语法，并假定*.js为脚本，*.mjs为模块。

原生TypeScript支持。*.ts文件会自动进行代码检查，无需为不同的解析器或规则进行配置。

规则组。规则按作用域分组，以便于配置、理解和保持项目的文件结构整洁。

可理解错误。代码检查工具每发现一个错误，都会以易于理解且清晰的方式指出源代码中的区域，并包含标签、注释和建议，解释如何修复每个问题。还可以使用 -F 标志或配置文件中的 formatter 键来使用类似 ESLint 的格式化工具。

强类型规则配置。RSLint 提供了一个 JSON 模式，并将其链接到 rslintrc.json，以在 Visual Studio Code 中提供配置文件的自动补全。JSON 模式详细描述了规则配置选项，允许轻松配置。此外，RSLint 的语言服务器协议实现也提供了对 rslintrc.toml 文件的自动补全。

强大的指令。指令（通过注释中的命令）使用基于内部 JavaScript 词汇分析器的解析器，允许我们提供

• 在语言服务器协议中对指令（如 // rslint-ignore no-empty）进行自动补全。
• 悬停支持指令，以在悬停时提供关于命令的信息。
• 对错误指令的可理解错误。

独立。RSLint 编译为单个独立二进制文件，不需要 Node、v8 或任何其他运行时。RSLint 可以在任何可以由 LLVM 定位的目标平台上运行。

强大的自动修复。提供一些错误的自动修复，并且可以通过 --fix 标志或 IDE 中的操作应用。即使文件包含语法错误，也可以通过 --dirty 标志应用修复。

内置文档。RSLint 在其二进制文件中包含规则文档，允许它通过 explain 子命令在终端中显示文档，例如 rslint explain no-empty, for-direction。

内部功能

清晰的项目布局。RSLint 项目采用单仓库布局，每个crate都有一个明确的任务，每个crate都可以在其他 Rust 项目中使用，并且每个crate都有良好的文档和API。

易于声明规则。规则使用 declare_lint! 宏声明。该宏接受文档注释、结构体名称、组名称、规则代码和配置选项。该宏生成结构体定义和 Rule 实现以及将文档注释处理成结构体的文档以及每个规则上的 docs() 方法上的静态字符串。所有内容都是简洁的，并且放在一个地方。

完整的语法树。与 ESTree 不同，RSLint 的自定义语法树保留

• 所有空白
• 所有注释
• 所有标记

允许它在不依赖于 ESLint 的 SourceCode 等单独结构的情况下进行强大的分析。

未类型化的语法树。RSLint 的语法树由低级别的未类型化节点和未类型化标记组成，这允许通过树进行强大、高效的遍历，例如 if_stmt.cons()?.child_with_ast::<SwitchStmt>()。

易于使用的API。RSLint 使用易于使用的构建器为其复杂的错误提供构建器，以及自动修复的构建器。所有内容都布局得尽可能减少实现规则所需的努力。

性能

基准测试可以在 benchmarks 目录中找到。您可以在您的机器上使用以下命令运行它们：deno run -A --quiet benchmarks/bench.ts。它们也在 CI 上运行，如果您点击最新的 GitHub Actions 运行，您可以看到最新的结果。

（这些基准测试是在 AMD Ryzen 7 2700x，8 核心处理器，主频 3.9MHz 上运行的）

许可

此项目受 MIT 许可证 的许可。