安装

通过 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 的语法树通过使用内部化和其他方法，在代码检查过程中大幅减少内存使用。

合理的默认值。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许可证。

lib.rs:

这个crate提供了一个针对由EcmaScript指定的正则表达式语法的正则表达式解析器。