配置子命令 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 运行命令。

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

默认情况下，precious 将 stderr 的任何输出都视为命令中的错误（而不是检查失败）。您可以使用 ignore-stderr 指定一个或多个正则表达式来指定允许的 stderr 输出。

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

所有这些都表明，在一般情况下，在静默模式下运行命令没有价值。这只会使在检查失败或出现其他问题时调试该命令的问题变得更加困难。

退出代码

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

在 --lint 模式下运行时，如果所有文件都通过检查，precious 将退出代码 0。如果任何检查命令失败，它将退出代码 1。

在这两种模式下，如果任何命令失败，无论是返回未列出的有效退出代码还是意外打印到 stderr，则退出代码不会是 0 或 1。

常见场景

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

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

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

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

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

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

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

如果您想在不对命令传递操作路径的情况下运行命令，请设置 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。如果任何检查命令指示存在检查问题，它将以非零状态退出。

您想按特定顺序运行命令

截至版本 0.1.2，命令的运行顺序与它们在配置文件中出现的顺序相同。

构建状态

构建和测试

Cargo Audit 夜间

Cargo Audit 推送