安装

通过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 的二进制文件中包含规则文档，允许它通过解释子命令在终端中显示文档，例如 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:

配置文件支持。