选择操作路径

当你运行precious时，你必须告诉它要操作哪些路径。这里有几个标志用于此目的。

运行单个命令

通过传递 --command 标志，您可以使用单个命令进行整理或检查。

$> precious lint --command some-command --all

传递给 --command 的名称必须与您的配置文件中命令的名称匹配。因此，在上面的示例中，这将寻找配置文件中定义的命令 [commands.some-command]。

使用标签选择命令

每个命令可以分配一个或多个标签。这使您可以创建任意组的命令。然后，在整理或检查时，您可以通过传递一个 --label 标志来选择一个标签。

$> precious lint --label some-label --all

标签的工作方式如下

• 没有在它的配置文件中包含 labels 键的命令有一个标签，即 default。
• 在不传递 --label 标志的情况下运行 tidy 或 lint 使用的是 default 标签。
• 如果您给一个命令分配了 labels 并且您希望该命令包含在 default 标签中，您必须明确包含它

  [command.some-command]
  # ...
  labels = [ "default", "some-label" ]
  

默认排除项

当选择路径时，precious 总是尊重您的忽略文件。目前，它只知道这与 git 的工作方式，并且它将尊重以下所有忽略文件

• 目录级别的 .ignore 和 .gitignore 文件。
• .git/info/exclude 文件。
• 全局 gitignore globs，通常位于 $XDG_CONFIG_HOME/git/ignore。

这是使用 rust ignore crate 实现的，因此建议在其他 VCS 系统中添加支持。

此外，您可以通过设置全局 exclude 键来指定所有命令的排除项。

最后，您可以通过指定每个命令的 include 和 exclude 键来指定。

包含和排除如何应用

当 precious 运行时，它会执行以下操作来确定哪些命令适用于哪些路径。

• 操作的基本文件是根据指定的命令行标志选择的。这是一些选项之一
  • --all - 项目根目录（包含 precious 配置文件的目录）下的所有文件。
  • --git - git 仓库中已修改的所有文件，包括已暂存的文件。
  • --staged - git 仓库中已暂存的所有文件。
  • --git-diff-from <REF> - 当前 HEAD 中所有与 <REF> 不同的文件。
  • CLI 上传递的路径 - 如果路径是一个文件，则按原样添加到列表中。如果路径是目录，则递归查找该目录下的所有文件。
• 将 VCS 忽略规则应用于从列表中删除文件。
• 应用全局排除规则以从列表中删除文件。
• 根据命令的 invoke 键，生成要检查的文件列表，并应用命令的包含/排除规则。要包含，文件必须至少匹配一个包含规则 并且 不匹配任何排除规则才能被接受。
  • 如果 invoke 是 per-file，则逐个文件应用规则。
  • 如果 invoke 是 per-dir，则如果目录中的任何文件匹配规则，则在该目录上运行命令。
  • 如果 invoke 是 once，则一次性将规则应用于所有文件。如果有任何文件匹配包含规则，则运行命令。

config 子命令

除了 init 子命令外，该命令还有一个 list 子命令。该命令会打印一个 Unicode 表，描述配置文件中的命令。

Found config file at: /home/autarch/projects/precious/precious.toml

┌─────────────────────┬──────┬────────────────────────────────────────────────────────┐
│ Name                ┆ Type ┆ Runs                                                   │
╞═════════════════════╪══════╪════════════════════════════════════════════════════════╡
│ rustfmt             ┆ both ┆ rustfmt --edition 2021                                 │
├╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┤
│ clippy              ┆ lint ┆ cargo clippy --locked --all-targets --all-features     │
│                     ┆      ┆ --workspace -- -D clippy::all                          │
├╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┤
│ prettier            ┆ both ┆ ./node_modules/.bin/prettier --no-config --print-width │
│                     ┆      ┆ 100 --prose-wrap always                                │
├╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┼╌╌╌╌╌╌┼╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌╌┤
│ omegasort-gitignore ┆ both ┆ omegasort --sort path --unique                         │
└─────────────────────┴──────┴────────────────────────────────────────────────────────┘

配置建议

以下是关于如何获得 precious 最佳体验的一些建议。

选择如何 invoke 命令

某些命令可能在使用 invoke 设置为 per-dir 或 once 时效果相同。正确的运行模式取决于您如何使用 precious。

一般来说，如果您拥有非常少的目录集，或者您一次运行 precious 在大多数或所有目录上，则 once 会更快。

但是，如果您拥有大量的目录，并且您通常只需要一次检查这些目录中的一个小子集，那么 per-dir 模式会更快。

您还可以使用实验性的 invoke.per-dir-or-once = n 选项，根据 precious 将要操作的目录数量以两种方式之一调用命令。

命令的静默标志

许多命令将接受某种形式的“静默”标志。一般来说，您可能不希望以静默模式运行 precious 的命令。

在 tidy 或 lint 命令成功执行的情况下，precious 已经隐藏了它运行的命令的所有 stdout。如果命令以某种方式失败，precious 将打印出命令的 stdout 和 stderr 输出。

默认情况下，precious 将 任何 标准错误输出视为命令中的错误（与 linting 失败相反）。您可以使用 ignore-stderr 来指定一个或多个允许的 stderr 输出的正则表达式。

此外，您可以通过以 --debug 模式运行 precious 来查看命令的所有 stdout 和 stderr 输出。

所有这些意味着，总的来说，在静默模式下运行命令对 precious 没有太多价值。这只会使在 lint 检查失败或其他问题发生时调试该命令的问题变得更困难。

退出代码

在 --tidy 模式下运行时，如果 tidy 没有错误，precious 总是使用 0 退出，无论是否整理了任何文件。

在以--lint模式运行时，如果所有文件都通过了lint检查，precious会退出并返回0。如果有任何lint命令失败，它将退出并返回1。

在两种模式下，如果任何命令失败，无论是通过返回未列出的退出码，还是意外地打印到stderr，那么退出码将不会是0或1。

常见场景

有一些配置场景可能需要您处理。以下是一些示例：

命令在整个源树中只运行一次

一些命令，例如rust-clippy，期望在整个源树中只运行一次，而不是每个文件或目录运行一次。

为了实现这一点，您应使用以下配置：

include = "**/*.rs"
invoke = "once"
path-args = "dot" # or "none"

这将导致precious在项目根目录中只运行一次命令。

命令在其lint的文件相同的目录中运行，并且不接受路径参数

如果您想运行命令而不将操作的路径传递给命令，请设置invoke = "per-dir"，working-dir = "dir"，以及path-args = "none"

include     = "**/*.rs"
invoke      = "per-dir"
working-dir = "dir"
path-args   = "none"

[commands.rustfmt]
type    = "both"
include = "**/*.rs"
exclude = [
    "path/to/dir",
    "!path/to/dir/included.rs",
]
cmd     = ["rustfmt"]
lint-flags = "--check"
ok-exit-codes = [0]
lint-failure-exit-codes = [1]