.zepter.yaml

# Configuration for the Zepter CLI to ensure correct feature configuration in the Rust workspace.
# <https://crates.io/crates/zepter>
#
# `cargo install zepter -f --locked` to install the CLI.
#
# Then `zepter check` to check the workspace and `zepter` to fix the issues.

version:
  # File format for parsing it:
  format: 1
  # Minimum version of the binary that is expected to work. This is just for printing a nice error
  # message when someone tries to use an older version.
  binary: 0.13.2

# The explanatory comments in this file assume crate `A` to have a dependency on crate `B`.
workflows:
  # Check that everything is good without modifying anything:
  check:
    - [
        "lint",
        # Check that `A` activates the features of `B`.
        "propagate-feature",
        # These are the features to check:
        "--features=try-runtime,runtime-benchmarks,std",
        # Do not try to add a new section into `[features]` of `A` only because `B` expose that feature. There are edge-cases where this is still needed, but we can add them manually.
        "--left-side-feature-missing=ignore",
        # Ignore the case that `A` it outside of the workspace. Otherwise it will report errors in external dependencies that we have no influence on.
        "--left-side-outside-workspace=ignore",
        # Some features imply that they activate a specific dependency as non-optional. Otherwise the default behaviour with a `?` is used.
        "--feature-enables-dep=try-runtime:frame-try-runtime,runtime-benchmarks:frame-benchmarking",
        # Show the paths of failed crates to have them clickable in the terminal: 
        "--show-path",
        # Aux
        "--offline",
        "--locked",
        "--quiet",
      ]
      # Format the features into canonical format:
    - ["format", "features", "--offline", "--locked", "--quiet"]
  # Same as `check`, but actually fix the issues instead of just reporting them:
  default:
    - [$check.0, "--fix"]
    - [$check.1, "--fix"]

# Will be displayed when any workflow fails:
help:
  text: |
    It looks like one more more Zepter feature checks failed; please check the console output.
    You can try to automatically address them by running `zepter`.
  links:
    - "https://github.com/paritytech/polkadot-sdk/issues/1831"
    - "https://github.com/ggwpez/zepter"