Lib.rs

› 开发工具 › Cargo 插件
#工具 #对齐 #底座 #项目 #排序 #路径 #cargo

app cargo-featalign

Cargo 特性对齐工具

由 Xavier Lau 编写

5 个版本

0.6.2 2023年11月22日
0.6.1 2023年9月13日
0.6.0 2023年8月3日
0.5.1 2023年7月27日
0.5.0 2023年7月27日

#124 在 Cargo 插件 中

每月 22 下载

GPL-3.0 许可证

42KB
750 代码行

Cargo Featalign

Cargo 特性对齐工具。

License Checks Release GitHub tag (latest by date) GitHub code lines GitHub last commit

简介

本项目的原始版本可在 subalfred check features 找到。经过进一步调查，我发现该工具不仅与 Substrate 项目兼容，还适用于一般的 Cargo 项目，提供了比之前更强大的功能。现在，cargo-featalign 以其增强的功能脱颖而出。

cargo-featalign 工具提供以下功能

  • 检查缺失的特性
  • 打印依赖路径
  • 在覆盖之前执行 dry run
  • 自动对齐/修复缺失的特性
  • 对齐时按字母排序

安装

用法

cargo featalign --help

Cargo features alignment tool.

Usage: cargo-featalign [OPTIONS] --features <[NAME]> [PATH]

Arguments:
  [PATH]
          Root `Cargo.toml`'s path.

          If `Cargo.toml` is not provided, it will be searched for under the specified path.

          [default: ./Cargo.toml]

Options:
      --features <[NAME]>
          Features to process

      --thread <NUM>
          Number of threads to use.

          The default value is based on the number of logical cores.

          [default: 32]

      --mode <MODE>
          Running mode.

          Check: Prints the analysis result.
          DryRun: Prints the resolved result without modifying the `Cargo.toml` file.
          DryRun2: creates a `*.cargo-featalign.swap` file.
          Overwrite: Overwrites the original `Cargo.toml` file.

          [default: overwrite]
          [possible values: check, dry-run, dry-run2, overwrite]

      --indent-symbol <INDENT_SYMBOL>
          Use the given symbol for indentation

          [default: tab]
          [possible values: tab, whitespace]

      --indent-size <SIZE>
          The number of spaces used for indentation

          [default: 4]

      --workspace-only
          Determines whether to process only workspace members

      --default-std
          Determines whether to check default features.

          This option is useful when working in a no-std environment. This feature checks if you have set `default-features = false` while also having a `std = ["x/std"]` part to control it separately.

      --depth <NUM>
          Depth of the dependency tree to process.

          Use `-1` to process the entire tree.

          !! Running with this flag under a large project, even with 128 threads configured, is incredibly challenging.

          [default: 0]

      --sort
          Wether to sort the required features while aligning

      --verbose
          Verbose output

  -h, --help
          Print help (see a summary with '-h')

  -V, --version
          Print version

示例

准备

cargo install cargo-featalign
git clone https://github.com/hack-ink/cargo-featalign.git
cd cargo-featalign

仅检查顶级工作区成员的特性

cargo featalign mock --features std,runtime-benchmarks,try-runtime --workspace-only --default-std --depth -1 --mode check | jq

{
  "mock-runtime 0.0.0 (path+file:///root/code/hack-ink/cargo-featalign/mock)": [
    {
      "id": "general-c 0.0.0 (path+file:///root/code/hack-ink/cargo-featalign/mock/general/c)",
      "alias": "",
      "dependency-path": "/mock-runtime",
      "problem": "default-features-enabled"
    },
    {
      "id": "pallet-a 0.0.0 (path+file:///root/code/hack-ink/cargo-featalign/mock/pallet/a)",
      "alias": "pallet-a",
      "dependency-path": "/mock-runtime",
      "problem": {
        "missing-features": [
          "std"
        ]
      }
    },
    {
      "id": "pallet-b 0.0.0 (path+file:///root/code/hack-ink/cargo-featalign/mock/pallet/b)",
      "alias": "pallet-b",
      "dependency-path": "/mock-runtime",
      "problem": {
        "missing-features": [
          "runtime-benchmarks"
        ]
      }
    },
    {
      "id": "pallet-c 0.0.0 (path+file:///root/code/hack-ink/cargo-featalign/mock/pallet/c)",
      "alias": "pallet-c",
      "dependency-path": "/mock-runtime",
      "problem": {
        "missing-features": [
          "try-runtime"
        ]
      }
    },
    {
      "id": "pallet-d 0.0.0 (path+file:///root/code/hack-ink/cargo-featalign/mock/pallet/d)",
      "alias": "pallet-d",
      "dependency-path": "/mock-runtime",
      "problem": {
        "missing-features": [
          "runtime-benchmarks",
          "std",
          "try-runtime"
        ]
      }
    }
  ]
}

递归检查工作区成员的特性

cargo featalign mock --features std,runtime-benchmarks,try-runtime --workspace-only --default-std --depth -1 --mode check | jq

{
  "nested-a 0.0.0 (path+file:///root/code/hack-ink/cargo-featalign/mock/nested/a)": [
    {
      "id": "nested-d 0.0.0 (path+file:///root/code/hack-ink/cargo-featalign/mock/nested/d)",
      "alias": "",
      "dependency-path": "/mock-runtime/primitive-a/nested-a",
      "problem": "default-features-enabled"
    },
    {
      "id": "nested-b 0.0.0 (path+file:///root/code/hack-ink/cargo-featalign/mock/nested/b)",
      "alias": "nested-b",
      "dependency-path": "/mock-runtime/primitive-a/nested-a",
      "problem": {
        "missing-features": [
          "std"
        ]
      }
    }
  ],
  "nested-b 0.0.0 (path+file:///root/code/hack-ink/cargo-featalign/mock/nested/b)": [
    {
      "id": "nested-c 0.0.0 (path+file:///root/code/hack-ink/cargo-featalign/mock/nested/c)",
      "alias": "nested-c",
      "dependency-path": "/mock-runtime/primitive-a/nested-a/nested-b",
      "problem": {
        "missing-features": [
          "std"
        ]
      }
    }
  ],
  "mock-runtime 0.0.0 (path+file:///root/code/hack-ink/cargo-featalign/mock)": [
    {
      "id": "general-c 0.0.0 (path+file:///root/code/hack-ink/cargo-featalign/mock/general/c)",
      "alias": "",
      "dependency-path": "/mock-runtime",
      "problem": "default-features-enabled"
    },
    {
      "id": "pallet-a 0.0.0 (path+file:///root/code/hack-ink/cargo-featalign/mock/pallet/a)",
      "alias": "pallet-a",
      "dependency-path": "/mock-runtime",
      "problem": {
        "missing-features": [
          "std"
        ]
      }
    },
    {
      "id": "pallet-b 0.0.0 (path+file:///root/code/hack-ink/cargo-featalign/mock/pallet/b)",
      "alias": "pallet-b",
      "dependency-path": "/mock-runtime",
      "problem": {
        "missing-features": [
          "runtime-benchmarks"
        ]
      }
    },
    {
      "id": "pallet-c 0.0.0 (path+file:///root/code/hack-ink/cargo-featalign/mock/pallet/c)",
      "alias": "pallet-c",
      "dependency-path": "/mock-runtime",
      "problem": {
        "missing-features": [
          "try-runtime"
        ]
      }
    },
    {
      "id": "pallet-d 0.0.0 (path+file:///root/code/hack-ink/cargo-featalign/mock/pallet/d)",
      "alias": "pallet-d",
      "dependency-path": "/mock-runtime",
      "problem": {
        "missing-features": [
          "runtime-benchmarks",
          "std",
          "try-runtime"
        ]
      }
    }
  ]
}

递归检查所有依赖的特性

!! 在大型项目中运行此命令，即使配置了 128 个线程，也是极具挑战性的。

cargo featalign . --features std --depth -1 --mode check | jq

{
  "semver 1.0.18 (registry+https://github.com/rust-lang/crates.io-index)": [
    {
      "id": "serde 1.0.176 (registry+https://github.com/rust-lang/crates.io-index)",
      "alias": "serde",
      "dependency-path": "/cargo-featalign/cargo_metadata/semver",
      "problem": {
        "missing-features": [
          "std"
        ]
      }
    }
  ],
  "tracing-core 0.1.31 (registry+https://github.com/rust-lang/crates.io-index)": [
    {
      "id": "valuable 0.1.0 (registry+https://github.com/rust-lang/crates.io-index)",
      "alias": "valuable",
      "dependency-path": "/cargo-featalign/color-eyre/color-spantrace/tracing-core",
      "problem": {
        "missing-features": [
          "std"
        ]
      }
    },
    {
      "id": "valuable 0.1.0 (registry+https://github.com/rust-lang/crates.io-index)",
      "alias": "valuable",
      "dependency-path": "/cargo-featalign/color-eyre/tracing-error/tracing/tracing-core",
      "problem": {
        "missing-features": [
          "std"
        ]
      }
    },
    {
      "id": "valuable 0.1.0 (registry+https://github.com/rust-lang/crates.io-index)",
      "alias": "valuable",
      "dependency-path": "/cargo-featalign/color-eyre/tracing-error/tracing-subscriber/tracing-core",
      "problem": {
        "missing-features": [
          "std"
        ]
      }
    },
    {
      "id": "valuable 0.1.0 (registry+https://github.com/rust-lang/crates.io-index)",
      "alias": "valuable",
      "dependency-path": "/cargo-featalign/color-eyre/color-spantrace/tracing-error/tracing/tracing-core",
      "problem": {
        "missing-features": [
          "std"
        ]
      }
    },
    {
      "id": "valuable 0.1.0 (registry+https://github.com/rust-lang/crates.io-index)",
      "alias": "valuable",
      "dependency-path": "/cargo-featalign/color-eyre/color-spantrace/tracing-error/tracing-subscriber/tracing-core",
      "problem": {
        "missing-features": [
          "std"
        ]
      }
    }
  ],
  "backtrace 0.3.68 (registry+https://github.com/rust-lang/crates.io-index)": [
    {
      "id": "libc 0.2.147 (registry+https://github.com/rust-lang/crates.io-index)",
      "alias": "libc",
      "dependency-path": "/cargo-featalign/color-eyre/backtrace",
      "problem": {
        "missing-features": [
          "std"
        ]
      }
    }
  ],
  "rustix 0.38.4 (registry+https://github.com/rust-lang/crates.io-index)": [
    {
      "id": "libc 0.2.147 (registry+https://github.com/rust-lang/crates.io-index)",
      "alias": "libc",
      "dependency-path": "/cargo-featalign/clap/clap_builder/anstream/is-terminal/rustix",
      "problem": {
        "missing-features": [
          "std"
        ]
      }
    }
  ],
  "errno 0.3.1 (registry+https://github.com/rust-lang/crates.io-index)": [
    {
      "id": "libc 0.2.147 (registry+https://github.com/rust-lang/crates.io-index)",
      "alias": "libc",
      "dependency-path": "/cargo-featalign/clap/clap_builder/anstream/is-terminal/rustix/errno",
      "problem": {
        "missing-features": [
          "std"
        ]
      }
    }
  ],
  "time 0.3.23 (registry+https://github.com/rust-lang/crates.io-index)": [
    {
      "id": "libc 0.2.147 (registry+https://github.com/rust-lang/crates.io-index)",
      "alias": "libc",
      "dependency-path": "/cargo-featalign/vergen/time",
      "problem": {
        "missing-features": [
          "std"
        ]
      }
    },
    {
      "id": "serde 1.0.176 (registry+https://github.com/rust-lang/crates.io-index)",
      "alias": "serde",
      "dependency-path": "/cargo-featalign/vergen/time",
      "problem": {
        "missing-features": [
          "std"
        ]
      }
    }
  ],
  "ahash 0.8.3 (registry+https://github.com/rust-lang/crates.io-index)": [
    {
      "id": "once_cell 1.18.0 (registry+https://github.com/rust-lang/crates.io-index)",
      "alias": "once_cell",
      "dependency-path": "/cargo-featalign/imara-diff/ahash",
      "problem": {
        "missing-features": [
          "std"
        ]
      }
    }
  ],
  "getrandom 0.2.10 (registry+https://github.com/rust-lang/crates.io-index)": [
    {
      "id": "libc 0.2.147 (registry+https://github.com/rust-lang/crates.io-index)",
      "alias": "libc",
      "dependency-path": "/cargo-featalign/imara-diff/ahash/getrandom",
      "problem": {
        "missing-features": [
          "std"
        ]
      }
    }
  ],
  "clap 4.3.19 (registry+https://github.com/rust-lang/crates.io-index)": [
    {
      "id": "once_cell 1.18.0 (registry+https://github.com/rust-lang/crates.io-index)",
      "alias": "once_cell",
      "dependency-path": "/cargo-featalign/clap",
      "problem": {
        "missing-features": [
          "std"
        ]
      }
    }
  ]
}

对齐工作区成员特性的 dry run

cargo featalign mock --features std,runtime-benchmarks,try-runtime --workspace-only --default-std --depth -1 --mode dry-run

nested-a 0.0.0 (path+file:///root/code/hack-ink/cargo-featalign/mock/nested/a)
@@ -17,4 +17,5 @@
 default = ["std"]
 std = [
    "nested-d/std",
+   "nested-b/std",
 ]

nested-b 0.0.0 (path+file:///root/code/hack-ink/cargo-featalign/mock/nested/b)
@@ -14,4 +14,6 @@

 [features]
 default = ["std"]
-std     = []
+std     = [
+   "nested-c/std",
+]

mock-runtime 0.0.0 (path+file:///root/code/hack-ink/cargo-featalign/mock)
@@ -45,18 +45,24 @@
    "pallet-c/std",
    # "pallet-d/std",
    "primitive-a/std",
+   "pallet-a/std",
+   "pallet-d/std",
 ]

 runtime-benchmarks = [
    "pallet-a/runtime-benchmarks",
    # "pallet-b/runtime-benchmarks",
    "pallet-c/runtime-benchmarks",
+   "pallet-b/runtime-benchmarks",
+   "pallet-d/runtime-benchmarks",
    # "pallet-d/runtime-benchmarks",
 ]

 try-runtime = [
    "pallet-a/try-runtime",
    "pallet-b/try-runtime",
+   "pallet-c/try-runtime",
+   "pallet-d/try-runtime",
    # "pallet-c/try-runtime",
    # "pallet-d/try-runtime",
 ]

对齐工作区成员特性的 dry run V2

cargo featalign mock --features std,runtime-benchmarks,try-runtime --workspace-only --default-std --depth -1 --mode dry-run2

diff mock/Cargo.toml mock/Cargo.toml.cargo-featalign.swap

排序

cargo featalign mock --features std,runtime-benchmarks,try-runtime --workspace-only --default-std --depth -1 --mode dry-run --sort

@@ -16,5 +16,6 @@
 [features]
 default = ["std"]
 std = [
+   "nested-b/std",
    "nested-d/std",
 ]

nested-b 0.0.0 (path+file:///root/code/hack-ink/cargo-featalign/mock/nested/b)
@@ -14,4 +14,6 @@

 [features]
 default = ["std"]
-std     = []
+std     = [
+   "nested-c/std",
+]

mock-runtime 0.0.0 (path+file:///root/code/hack-ink/cargo-featalign/mock)
@@ -48,24 +48,34 @@
    "pallet-b/std",
    "pallet-c/std",
    # "pallet-d/std",
+   "pallet-a/std",
+   "pallet-d/std",
    "primitive-a/std",
 ]

 runtime-benchmarks = [
    "pallet-a/runtime-benchmarks",
    # "pallet-b/runtime-benchmarks",
+   "pallet-b/runtime-benchmarks",
    "pallet-c/runtime-benchmarks",
+   "pallet-d/runtime-benchmarks",
    # "pallet-d/runtime-benchmarks",
 ]

 try-runtime = [
    "pallet-a/try-runtime",
    "pallet-b/try-runtime",
+   "pallet-c/try-runtime",
+   "pallet-d/try-runtime",
    # "pallet-c/try-runtime",
    # "pallet-d/try-runtime",
 ]

-empty = []
+empty = [
+   "primitive-b/empty",
+   "primitive-c/empty",
+   "primitive-d/empty",
+]

 [workspace]
 resolver = "2"

依赖项

~10–13MB
~228K SLoC