选择操作的路径

当您运行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> - 与 <REF> 不同的当前 HEAD 中的所有文件。
  • 通过 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                         │
└─────────────────────┴──────┴────────────────────────────────────────────────────────┘

配置建议

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

选择如何调用命令invoke

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

通常，如果您有非常少的目录集，或者您一次运行珍贵于大多数或所有目录，那么once将更快。

但是，如果您有更多的目录集，并且通常只需要一次性检查这些目录的小部分，那么per-dir模式将更快。

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

命令的静默标志

许多命令将接受某种类型的“静默”标志。一般来说，您可能不希望用珍贵在静默模式下运行命令。

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

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

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

所有这些都意味着在一般情况下，在静默模式下运行命令没有价值。这只会使在lint检查失败或发生其他问题时调试该命令的问题更困难。

退出代码

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

在--lint模式下运行时，如果所有文件都通过了linting，珍贵将退出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"

您想排除整个目录（树）中的某个或多个文件

在exclude列表中使用以!开头的忽略模式

[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]

您想将Precious作为提交钩子运行

只需在您的钩子中运行precious lint -s。如果任何lint命令指示linting问题，它将以非零状态退出。

您想按特定顺序运行命令

从版本0.1.2开始，命令以它们在配置文件中出现的顺序运行。

构建状态

构建和测试

Cargo Audit Nightly

Cargo Audit On Push