安装

通过 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 项目采用 monorepo 布局，每个 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:

文本编辑的表示。

这是从 rust-analyzer 的 text_edit crate 中获取的。