[ { "path": ".cargo/config.toml", "content": "[resolver]\nincompatible-rust-versions = \"fallback\"\n" }, { "path": ".clippy.toml", "content": "allow-print-in-tests = true\nallow-expect-in-tests = true\nallow-unwrap-in-tests = true\nallow-dbg-in-tests = true\ndisallowed-methods = [\n { path = \"std::option::Option::map_or\", reason = \"prefer `map(..).unwrap_or(..)` for legibility\" },\n { path = \"std::option::Option::map_or_else\", reason = \"prefer `map(..).unwrap_or_else(..)` for legibility\" },\n { path = \"std::result::Result::map_or\", reason = \"prefer `map(..).unwrap_or(..)` for legibility\" },\n { path = \"std::result::Result::map_or_else\", reason = \"prefer `map(..).unwrap_or_else(..)` for legibility\" },\n { path = \"std::iter::Iterator::for_each\", reason = \"prefer `for` for side-effects\" },\n { path = \"std::iter::Iterator::try_for_each\", reason = \"prefer `for` for side-effects\" },\n]\ndoc-valid-idents = [\"PowerShell\", \"..\"]\n" }, { "path": ".github/FUNDING.yml", "content": "github: clap-rs\nopen_collective: clap\n" }, { "path": ".github/ISSUE_TEMPLATE/bug_report.yml", "content": "name: Bug report\ndescription: An issue with clap, clap_complete, clap_derive, or clap_mangen\nlabels: [\"C-bug\", \"S-triage\"]\nbody:\n - type: checkboxes\n attributes:\n label: Please complete the following tasks\n options:\n - label: I have searched the [discussions](https://github.com/clap-rs/clap/discussions)\n required: true\n - label: I have searched the [open](https://github.com/clap-rs/clap/issues) and [rejected](https://github.com/clap-rs/clap/issues?q=is%3Aissue+label%3AS-wont-fix+is%3Aclosed) issues\n required: true\n - type: input\n attributes:\n label: Rust Version\n description: Output of `rustc -V`\n validations:\n required: true\n - type: input\n attributes:\n label: Clap Version\n description: Can be found in Cargo.lock or Cargo.toml of your project (i.e. `grep -C1 clap Cargo.lock`). PLEASE DO NOT PUT \"latest\" HERE, use precise version. Put `master` (or other branch) if you're using the repo directly.\n validations:\n required: true\n - type: textarea\n attributes:\n label: Minimal reproducible code\n description: Please write a minimal complete program which has this bug. Do not point to an existing repository.\n value: |\n ```rust\n fn main() {}\n ```\n validations:\n required: true\n - type: textarea\n attributes:\n label: Steps to reproduce the bug with the above code\n description: A command like `cargo run -- options...` or multiple commands.\n validations:\n required: true\n - type: textarea\n attributes:\n label: Actual Behaviour\n description: When I do like *this*, *that* is happening and I think it shouldn't.\n validations:\n required: true\n - type: textarea\n attributes:\n label: Expected Behaviour\n description: I think *this* should happen instead.\n validations:\n required: true\n - type: textarea\n attributes:\n label: Additional Context\n description: Add any other context about the problem here.\n - type: textarea\n attributes:\n label: Debug Output\n description: |\n Compile clap with `debug` feature:\n\n ```toml\n [dependencies]\n clap = { version = \"*\", features = [\"debug\"] }\n ```\n" }, { "path": ".github/ISSUE_TEMPLATE/config.yml", "content": "blank_issues_enabled: true\ncontact_links:\n - name: Ask a question\n about: For support or brainstorming\n url: https://github.com/clap-rs/clap/discussions/new\n" }, { "path": ".github/ISSUE_TEMPLATE/feature_request.yml", "content": "name: Feature request\ndescription: Suggest an idea for this project\nlabels: [\"C-enhancement\", \"S-triage\"]\nbody:\n - type: checkboxes\n attributes:\n label: Please complete the following tasks\n options:\n - label: I have searched the [discussions](https://github.com/clap-rs/clap/discussions)\n required: true\n - label: I have searched the [open](https://github.com/clap-rs/clap/issues) and [rejected](https://github.com/clap-rs/clap/issues?q=is%3Aissue+label%3AS-wont-fix+is%3Aclosed) issues\n required: true\n - type: input\n attributes:\n label: Clap Version\n description: Can be found in Cargo.lock or Cargo.toml of your project (i.e. `grep clap Cargo.lock`). PLEASE DO NOT PUT \"latest\" HERE, use precise version. Put `master` (or other branch) if you're using the repo directly.\n validations:\n required: true\n - type: textarea\n attributes:\n label: Describe your use case\n description: Describe the problem you're trying to solve. This is not mandatory and we *do* consider features without a specific use case, but real problems have priority.\n validations:\n required: true\n - type: textarea\n attributes:\n label: Describe the solution you'd like\n description: Please explain what the wanted solution should look like. You are **strongly encouraged** to attach a snippet of (pseudo)code.\n validations:\n required: true\n - type: textarea\n attributes:\n label: Alternatives, if applicable\n description: A clear and concise description of any alternative solutions or features you've managed to come up with.\n - type: textarea\n attributes:\n label: Additional Context\n description: Add any other context about the feature request here.\n" }, { "path": ".github/PULL_REQUEST_TEMPLATE.md", "content": "\n" }, { "path": ".github/renovate.json5", "content": "{\n schedule: [\n 'before 5am on the first day of the month',\n ],\n semanticCommits: 'enabled',\n commitMessageLowerCase: 'never',\n configMigration: true,\n dependencyDashboard: true,\n \"pre-commit\": {\n enabled: true\n },\n customManagers: [\n {\n customType: 'regex',\n managerFilePatterns: [\n '/^rust-toolchain\\\\.toml$/',\n '/Cargo.toml$/',\n '/clippy.toml$/',\n '/^Makefile$/',\n '/^tests/derive_ui.rs$/',\n '/\\\\.clippy.toml$/',\n '/^\\\\.github/workflows/ci.yml$/',\n '/^\\\\.github/workflows/rust-next.yml$/',\n ],\n matchStrings: [\n 'STABLE.*?(?\\\\d+\\\\.\\\\d+(\\\\.\\\\d+)?)',\n '(?\\\\d+\\\\.\\\\d+(\\\\.\\\\d+)?).*?STABLE',\n ],\n depNameTemplate: 'STABLE',\n packageNameTemplate: 'rust-lang/rust',\n datasourceTemplate: 'github-releases',\n },\n {\n customType: 'regex',\n managerFilePatterns: [\n '/^\\\\.github/workflows/pre-commit.yml$/',\n ],\n matchStrings: [\n 'prek-version.*?(?\\\\d+\\\\.\\\\d+(\\\\.\\\\d+)?)',\n ],\n depNameTemplate: 'prek',\n packageNameTemplate: 'j178/prek',\n datasourceTemplate: 'github-releases',\n },\n ],\n packageRules: [\n {\n commitMessageTopic: 'Rust Stable',\n matchManagers: [\n 'custom.regex',\n ],\n matchDepNames: [\n 'STABLE',\n ],\n extractVersion: '^(?\\\\d+\\\\.\\\\d+)', // Drop the patch version\n schedule: [\n '* * * * *',\n ],\n automerge: true,\n },\n {\n commitMessageTopic: 'Prek',\n matchManagers: [\n 'custom.regex',\n ],\n matchDepNames: [\n 'prek',\n ],\n extractVersion: '^(?\\\\d+\\\\.\\\\d+\\\\.\\\\d+)',\n schedule: [\n '* * * * *',\n ],\n automerge: true,\n },\n // Goals:\n // - Keep version reqs low, ignoring compatible normal/build dependencies\n // - Take advantage of latest dev-dependencies\n // - Rollup safe upgrades to reduce CI runner load\n // - Help keep number of versions down by always using latest breaking change\n // - Have lockfile and manifest in-sync\n {\n matchManagers: [\n 'cargo',\n ],\n matchDepTypes: [\n 'build-dependencies',\n 'dependencies',\n ],\n matchCurrentVersion: '>=0.1.0',\n matchUpdateTypes: [\n 'patch',\n ],\n enabled: false,\n },\n {\n matchManagers: [\n 'cargo',\n ],\n matchDepTypes: [\n 'build-dependencies',\n 'dependencies',\n ],\n matchCurrentVersion: '>=1.0.0',\n matchUpdateTypes: [\n 'minor',\n 'patch',\n ],\n enabled: false,\n },\n {\n matchManagers: [\n 'cargo',\n ],\n matchDepTypes: [\n 'dev-dependencies',\n ],\n matchCurrentVersion: '>=0.1.0',\n matchUpdateTypes: [\n 'patch',\n ],\n automerge: true,\n groupName: 'compatible (dev)',\n },\n {\n matchManagers: [\n 'cargo',\n ],\n matchDepTypes: [\n 'dev-dependencies',\n ],\n matchCurrentVersion: '>=1.0.0',\n matchUpdateTypes: [\n 'minor',\n 'patch',\n ],\n automerge: true,\n groupName: 'compatible (dev)',\n },\n ],\n}\n" }, { "path": ".github/settings.yml", "content": "# These settings are synced to GitHub by https://probot.github.io/apps/settings/\n\nrepository:\n description: \"A full featured, fast Command Line Argument Parser for Rust\"\n homepage: \"docs.rs/clap\"\n topics: \"rust cli command-line argparse clap\"\n has_issues: true\n has_projects: false\n has_wiki: false\n has_downloads: true\n default_branch: master\n\n # Preference: people do clean commits\n allow_merge_commit: true\n # Backup in case we need to clean up commits\n allow_squash_merge: true\n # Not really needed\n allow_rebase_merge: false\n\n allow_auto_merge: true\n delete_branch_on_merge: true\n\n squash_merge_commit_title: \"PR_TITLE\"\n squash_merge_commit_message: \"PR_BODY\"\n merge_commit_message: \"PR_BODY\"\n\n#labels:\n# - name: \"A-builder\"\n# description: \"Area: Builder API\"\n# color: '#f7e101'\n# - name: \"A-derive\"\n# description: \"Area: #[derive]` macro API\"\n# color: '#f7e101'\n# - name: \"A-docs\"\n# description: \"Area: documentation, including docs.rs, readme, examples, etc...\"\n# color: '#f7e101'\n# - name: \"A-completion\"\n# description: \"Area: completion generator\"\n# color: '#f7e101'\n# - name: \"A-help\"\n# description: \"Area: Help or usage messages\"\n# color: '#f7e101'\n# - name: \"A-meta\"\n# description: \"Area: administrative question or tracking issue\"\n# color: '#f7e101'\n# - name: \"A-parsing\"\n# description: \"Area: Parser's logic and needs it changed somehow.\"\n# color: '#f7e101'\n# - name: \"A-validators\"\n# description: \"Area: ArgMatches validation logic\n# color: '#f7e101'\n# - name: \"C-bug\"\n# description: \"Category: Things not working as expected\"\n# color: '#f5f1fd'\n# - name: \"C-enhancement\"\n# description: \"Category: Raise on the bar on expectations\"\n# color: '#f5f1fd'\n# - name: \"C-tracking-issue\"\n# description: \"Category: A tracking issue for an unstable feature\"\n# color: '#f5f1fd'\n# - name: \"C-dependencies\"\n# description: \"Category: Updating dependencies\"\n# color: '#f5f1fd'\n# - name: \"E-easy\"\n# description: \"Call for participation: Experience needed to fix: Easy / not much\"\n# color: '#02E10C'\n# - name: \"E-medium\"\n# description: \"Call for participation: Experience needed to fix: Medium / intermediate\"\n# color: '#02E10C'\n# - name: \"E-hard\"\n# description: \"Call for participation: Experience needed to fix: Hard / a lot\"\n# color: '#02E10C'\n# - name: \"E-help-wanted\"\n# description: \"Call for participation: Help is requested to fix this issue.\"\n# color: '#02E10C'\n# - name: \"S-triage\"\n# description: \"Status: New; needs maintainer attention.\"\n# color: '#D3DDDD'\n# - name: \"S-blocked\"\n# description: \"Status: Blocked on something else such as an RFC or other implementation work.\"\n# color: '#D3DDDD'\n# - name: \"S-experimental\"\n# description: \"Status: Ongoing experiment that does not require reviewing and won't be merged in its current state.\"\n# color: '#D3DDDD'\n# - name: \"S-waiting-on-design\"\n# description: \"Status: Waiting on user-facing design to be resolved before implementing\"\n# color: '#D3DDDD'\n# - name: \"S-waiting-on-decision\"\n# description: \"Status: Waiting on a go/no-go before implementing\"\n# color: '#D3DDDD'\n# - name: \"S-waiting-on-mentor\"\n# description: \"Status: Needs elaboration on the details before doing a 'Call for participation'\"\n# color: '#D3DDDD'\n# - name: \"S-waiting-on-author\"\n# description: \"Status: This is awaiting some action (such as code changes or more information) from the author.\"\n# color: '#D3DDDD'\n# - name: \"M-breaking-change\"\n# description: \"Meta: Implementing or merging this will introduce a breaking change.\"\n# color: '#E10C02'\n# - name: \"M-unreviewed\"\n# description: \"Meta: Request for post-merge review.\"\n# color: '#E10C02'\n\n# This serves more as documentation.\n# Branch protection API was replaced by rulesets but settings isn't updated.\n# See https://github.com/repository-settings/app/issues/825\n#\n# branches:\n# - name: master\n# protection:\n# required_pull_request_reviews: null\n# required_conversation_resolution: true\n# required_status_checks:\n# # Required. Require branches to be up to date before merging.\n# strict: false\n# contexts: [\"CI\", \"Spell Check with Typos\"]\n# enforce_admins: false\n# restrictions: null\n" }, { "path": ".github/workflows/audit.yml", "content": "name: Security audit\n\npermissions:\n contents: read\n\non:\n pull_request:\n paths:\n - '**/Cargo.toml'\n - '**/Cargo.lock'\n push:\n branches:\n - master\n\nenv:\n RUST_BACKTRACE: 1\n CARGO_TERM_COLOR: always\n CLICOLOR: 1\n\nconcurrency:\n group: \"${{ github.workflow }}-${{ github.ref }}\"\n cancel-in-progress: true\n\njobs:\n security_audit:\n permissions:\n issues: write # to create issues (actions-rs/audit-check)\n checks: write # to create check (actions-rs/audit-check)\n runs-on: ubuntu-latest\n # Prevent sudden announcement of a new advisory from failing ci:\n continue-on-error: true\n steps:\n - name: Checkout repository\n uses: actions/checkout@v6\n - uses: actions-rs/audit-check@v1\n with:\n token: ${{ secrets.GITHUB_TOKEN }}\n\n cargo_deny:\n permissions:\n issues: write # to create issues (actions-rs/audit-check)\n checks: write # to create check (actions-rs/audit-check)\n runs-on: ubuntu-latest\n strategy:\n matrix:\n checks:\n - bans licenses sources\n steps:\n - uses: actions/checkout@v6\n - uses: EmbarkStudios/cargo-deny-action@v2\n with:\n command: check ${{ matrix.checks }}\n rust-version: stable\n" }, { "path": ".github/workflows/bench-baseline.yml", "content": "name: Benchmark Baseline\n\npermissions:\n contents: read\n\non:\n push:\n branches: master\n\njobs:\n bench:\n name: Binary Size\n permissions:\n checks: write\n strategy:\n matrix:\n build: [linux]\n include:\n - build: linux\n os: ubuntu-latest\n runs-on: \"${{ matrix.os }}\"\n steps:\n - name: Checkout repository\n uses: actions/checkout@v6\n - name: Install Rust\n uses: dtolnay/rust-toolchain@stable\n with:\n toolchain: stable\n - uses: Swatinem/rust-cache@v2\n - name: Install Bencher\n uses: bencherdev/bencher@main\n - name: Build\n run: \"cargo build --package clap --example git-derive -F derive --release\"\n env:\n CARGO_PROFILE_RELEASE_STRIP: true\n - name: Report\n run: |\n bencher run \\\n --project $(echo \"${{ github.repository }}\" | sed 's/\\//-/g') \\\n --branch \"${{ github.ref_name }}\" \\\n --testbed \"${{ matrix.os }}\" \\\n --token '${{ secrets.BENCHER_API_TOKEN }}' \\\n --github-actions '${{ secrets.GITHUB_TOKEN }}' \\\n --adapter json \\\n --file-size target/release/examples/git-derive\n" }, { "path": ".github/workflows/ci.yml", "content": "name: CI\n\npermissions:\n contents: read\n\non:\n pull_request:\n push:\n branches:\n - \"*master\"\n\nenv:\n RUST_BACKTRACE: 1\n CARGO_TERM_COLOR: always\n CLICOLOR: 1\n\nconcurrency:\n group: \"${{ github.workflow }}-${{ github.ref }}\"\n cancel-in-progress: true\n\njobs:\n ci:\n permissions:\n contents: none\n name: CI\n needs: [test, shell-integration, shell-integration-nu, check, ui, minimal-versions, lockfile, docs, rustfmt, clippy, cffconvert]\n runs-on: ubuntu-latest\n if: \"always()\"\n steps:\n - name: Failed\n run: exit 1\n if: \"contains(needs.*.result, 'failure') || contains(needs.*.result, 'cancelled') || contains(needs.*.result, 'skipped')\"\n test:\n name: Test\n strategy:\n matrix:\n build: [linux, windows, mac, minimal, default, next]\n include:\n - build: linux\n os: ubuntu-latest\n rust: \"stable\"\n features: \"full\"\n - build: windows\n os: windows-latest\n rust: \"stable\"\n features: \"full\"\n - build: mac\n os: macos-latest\n rust: \"stable\"\n features: \"full\"\n - build: minimal\n os: ubuntu-latest\n rust: \"stable\"\n features: \"minimal\"\n - build: default\n os: ubuntu-latest\n rust: \"stable\"\n features: \"default\"\n - build: next\n os: ubuntu-latest\n rust: \"stable\"\n features: \"next\"\n continue-on-error: ${{ matrix.rust != 'stable' }}\n runs-on: ${{ matrix.os }}\n env:\n # Reduce amount of data cached\n CARGO_PROFILE_DEV_DEBUG: line-tables-only\n steps:\n - name: Checkout repository\n uses: actions/checkout@v6\n - name: Install Rust\n uses: dtolnay/rust-toolchain@stable\n with:\n toolchain: ${{ matrix.rust }}\n - uses: Swatinem/rust-cache@v2\n - name: Build\n run: make build-${{matrix.features}}\n - name: Test\n run: make test-${{matrix.features}}\n - name: Test (benches)\n run: make test-${{matrix.features}} ARGS='--workspace --benches'\n - name: Test (ultra-minimal)\n if: matrix.build == 'minimal'\n run: make test-minimal ARGS='--manifest-path Cargo.toml'\n - name: Test dynamic completions\n run: cargo test -p clap_complete -F unstable-dynamic\n shell-integration:\n name: Shell Integration\n runs-on: ubuntu-latest\n steps:\n - name: Checkout repository\n uses: actions/checkout@v6\n - name: Install Rust\n uses: dtolnay/rust-toolchain@stable\n with:\n toolchain: stable\n - uses: Swatinem/rust-cache@v2\n - name: Install shells\n if: runner.os == 'Linux'\n run: sudo apt-get install -y elvish fish zsh\n - name: clap_complete\n run: cargo test -p clap_complete -F unstable-dynamic -F unstable-shell-tests\n shell-integration-nu:\n name: Nushell Integration\n runs-on: ubuntu-latest\n steps:\n - name: Checkout repository\n uses: actions/checkout@v6\n - name: Install Rust\n uses: dtolnay/rust-toolchain@stable\n with:\n toolchain: stable\n - uses: Swatinem/rust-cache@v2\n - name: clap_complete_nu\n run: cargo test -p clap_complete_nushell -F unstable-shell-tests\n check:\n name: Check\n runs-on: ubuntu-latest\n strategy:\n fail-fast: false\n matrix:\n build: [msrv, wasm, wasm-wasi, debug, release]\n include:\n - build: msrv\n rust: \"1.85\" # MSRV\n target: x86_64-unknown-linux-gnu\n features: full\n - build: wasm\n rust: stable\n target: wasm32-unknown-unknown\n features: wasm\n - build: wasm-wasi\n rust: stable\n target: wasm32-wasip2\n features: wasm\n - build: debug\n rust: stable\n target: x86_64-unknown-linux-gnu\n features: debug\n - build: release\n rust: stable\n target: x86_64-unknown-linux-gnu\n features: release\n steps:\n - name: Checkout repository\n uses: actions/checkout@v6\n - name: Install rust\n uses: dtolnay/rust-toolchain@stable\n with:\n toolchain: ${{ matrix.rust }}\n targets: ${{ matrix.target }}\n - uses: Swatinem/rust-cache@v2\n - name: Check\n run: make check-${{ matrix.features }}\n env:\n TOOLCHAIN_TARGET: ${{ matrix.target }}\n ui:\n name: UI Tests\n runs-on: ubuntu-latest\n strategy:\n fail-fast: false\n matrix:\n features: [default, next]\n steps:\n - name: Checkout repository\n uses: actions/checkout@v6\n - name: Install Rust\n uses: dtolnay/rust-toolchain@stable\n with:\n toolchain: \"1.94\" # STABLE\n - uses: Swatinem/rust-cache@v2\n - name: UI Tests\n run: make test-ui-${{ matrix.features }}\n minimal-versions:\n name: Minimal versions\n strategy:\n matrix:\n os: [\"ubuntu-latest\"]\n runs-on: ${{ matrix.os }}\n steps:\n - name: Checkout repository\n uses: actions/checkout@v6\n - name: Install stable Rust\n uses: dtolnay/rust-toolchain@stable\n with:\n toolchain: stable\n - name: Install nightly Rust\n uses: dtolnay/rust-toolchain@stable\n with:\n toolchain: nightly\n - name: Downgrade dependencies to minimal versions\n run: cargo +nightly generate-lockfile -Z minimal-versions\n - name: Compile with minimal versions\n run: cargo +stable check --workspace --all-features --locked --exclude clap_complete_nushell --exclude clap_bench\n lockfile:\n runs-on: ubuntu-latest\n steps:\n - name: Checkout repository\n uses: actions/checkout@v6\n - name: Install Rust\n uses: dtolnay/rust-toolchain@stable\n with:\n toolchain: stable\n - uses: Swatinem/rust-cache@v2\n - name: \"Is lockfile updated?\"\n run: cargo update --workspace --locked\n docs:\n name: Docs\n runs-on: ubuntu-latest\n steps:\n - name: Checkout repository\n uses: actions/checkout@v6\n - name: Install Rust\n uses: dtolnay/rust-toolchain@stable\n with:\n toolchain: \"1.94\" # STABLE\n - uses: Swatinem/rust-cache@v2\n - name: Check documentation\n env:\n RUSTDOCFLAGS: -D warnings\n run: make doc\n rustfmt:\n name: rustfmt\n runs-on: ubuntu-latest\n steps:\n - name: Checkout repository\n uses: actions/checkout@v6\n - name: Install Rust\n uses: dtolnay/rust-toolchain@stable\n with:\n toolchain: \"1.94\" # STABLE\n components: rustfmt\n - uses: Swatinem/rust-cache@v2\n - name: Check formatting\n run: cargo fmt --check\n clippy:\n name: clippy\n runs-on: ubuntu-latest\n steps:\n - name: Checkout repository\n uses: actions/checkout@v6\n - name: Install Rust\n uses: dtolnay/rust-toolchain@stable\n with:\n toolchain: \"1.94\" # STABLE\n components: clippy\n - uses: Swatinem/rust-cache@v2\n - name: Lint (ultra-minimal)\n run: make clippy-minimal ARGS='--manifest-path Cargo.toml'\n - name: Lint (minimal)\n run: make clippy-minimal\n - name: Lint (all)\n run: make clippy-full\n - name: Lint (release)\n run: make clippy-release\n cffconvert:\n name: cffconvert\n runs-on: ubuntu-latest\n steps:\n - name: Checkout repository\n uses: actions/checkout@v6\n with:\n persist-credentials: false\n - name: CFF validation\n uses: citation-file-format/cffconvert-github-action@2.0.0\n with:\n args: --validate\n" }, { "path": ".github/workflows/committed.yml", "content": "# Not run as part of pre-commit checks because they don't handle sending the correct commit\n# range to `committed`\nname: Lint Commits\non: [pull_request]\n\npermissions:\n contents: read\n\nenv:\n RUST_BACKTRACE: 1\n CARGO_TERM_COLOR: always\n CLICOLOR: 1\n\nconcurrency:\n group: \"${{ github.workflow }}-${{ github.ref }}\"\n cancel-in-progress: true\n\njobs:\n committed:\n name: Lint Commits\n runs-on: ubuntu-latest\n steps:\n - name: Checkout Actions Repository\n uses: actions/checkout@v6\n with:\n fetch-depth: 0\n - name: Lint Commits\n uses: crate-ci/committed@master\n" }, { "path": ".github/workflows/post-release.yml", "content": "name: post-release\non:\n push:\n tags:\n - \"v*\"\npermissions:\n contents: read\n\njobs:\n create-release:\n permissions:\n contents: write # for actions/create-release to create a release\n name: create-release\n runs-on: ubuntu-latest\n outputs:\n upload_url: ${{ steps.release.outputs.upload_url }}\n release_version: ${{ env.RELEASE_VERSION }}\n steps:\n - name: Get the release version from the tag\n shell: bash\n if: env.RELEASE_VERSION == ''\n run: |\n # See: https://github.community/t5/GitHub-Actions/How-to-get-just-the-tag-name/m-p/32167/highlight/true#M1027\n echo \"RELEASE_VERSION=${GITHUB_REF#refs/tags/}\" >> $GITHUB_ENV\n echo \"version is: ${{ env.RELEASE_VERSION }}\"\n - name: Checkout repository\n uses: actions/checkout@v6\n with:\n fetch-depth: 1\n - name: Generate Release Notes\n run: |\n ./.github/workflows/release-notes.py --tag ${{ env.RELEASE_VERSION }} --output notes-${{ env.RELEASE_VERSION }}.md\n cat notes-${{ env.RELEASE_VERSION }}.md\n - name: Create GitHub release\n id: release\n uses: actions/create-release@v1\n env:\n GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}\n with:\n tag_name: ${{ env.RELEASE_VERSION }}\n release_name: ${{ env.RELEASE_VERSION }}\n body_path: notes-${{ env.RELEASE_VERSION }}.md\n" }, { "path": ".github/workflows/pre-commit.yml", "content": "name: pre-commit\n\npermissions: {} # none\n\non:\n pull_request:\n push:\n branches: [master]\n\nenv:\n RUST_BACKTRACE: 1\n CARGO_TERM_COLOR: always\n CLICOLOR: 1\n\nconcurrency:\n group: \"${{ github.workflow }}-${{ github.ref }}\"\n cancel-in-progress: true\n\njobs:\n pre-commit:\n permissions:\n contents: read\n runs-on: ubuntu-latest\n steps:\n - uses: actions/checkout@v6\n - uses: j178/prek-action@v1\n with:\n prek-version: '0.2.27'\n" }, { "path": ".github/workflows/release-notes.py", "content": "#!/usr/bin/env python3\n\nimport argparse\nimport re\nimport pathlib\nimport sys\n\n\n_STDIO = pathlib.Path(\"-\")\n\n\ndef main():\n parser = argparse.ArgumentParser()\n parser.add_argument(\"-i\", \"--input\", type=pathlib.Path, default=\"CHANGELOG.md\")\n parser.add_argument(\"--tag\", required=True)\n parser.add_argument(\"-o\", \"--output\", type=pathlib.Path, required=True)\n args = parser.parse_args()\n\n if args.input == _STDIO:\n lines = sys.stdin.readlines()\n else:\n with args.input.open() as fh:\n lines = fh.readlines()\n version = args.tag.lstrip(\"v\")\n\n note_lines = []\n for line in lines:\n if line.startswith(\"## \") and version in line:\n note_lines.append(line)\n elif note_lines and line.startswith(\"## \"):\n break\n elif note_lines:\n note_lines.append(line)\n\n notes = \"\".join(note_lines).strip()\n if args.output == _STDIO:\n print(notes)\n else:\n args.output.write_text(notes)\n\n\nif __name__ == \"__main__\":\n main()\n" }, { "path": ".github/workflows/rust-next.yml", "content": "name: rust-next\n\npermissions:\n contents: read\n\non:\n schedule:\n - cron: '3 3 3 * *'\n\nenv:\n RUST_BACKTRACE: 1\n CARGO_TERM_COLOR: always\n CLICOLOR: 1\n\nconcurrency:\n group: \"${{ github.workflow }}-${{ github.ref }}\"\n cancel-in-progress: true\n\njobs:\n test:\n name: Test\n strategy:\n matrix:\n build: [stable, linux, windows, mac, nightly, minimal, default, next]\n include:\n - build: stable\n os: ubuntu-latest\n rust: \"stable\"\n features: \"full\"\n - build: linux\n os: ubuntu-latest\n rust: \"beta\"\n features: \"full\"\n - build: windows\n os: windows-latest\n rust: \"beta\"\n features: \"full\"\n - build: mac\n os: macos-latest\n rust: \"beta\"\n features: \"full\"\n - build: nightly\n os: ubuntu-latest\n rust: \"nightly\"\n features: \"full\"\n - build: minimal\n os: ubuntu-latest\n rust: \"stable\"\n features: \"minimal\"\n - build: default\n os: ubuntu-latest\n rust: \"stable\"\n features: \"default\"\n - build: next\n os: ubuntu-latest\n rust: \"stable\"\n features: \"next\"\n continue-on-error: ${{ matrix.rust != 'stable' }}\n runs-on: ${{ matrix.os }}\n env:\n # Reduce amount of data cached\n CARGO_PROFILE_DEV_DEBUG: line-tables-only\n steps:\n - name: Checkout repository\n uses: actions/checkout@v6\n - name: Install Rust\n uses: dtolnay/rust-toolchain@stable\n with:\n toolchain: ${{ matrix.rust }}\n - uses: Swatinem/rust-cache@v2\n - name: Install shells\n if: runner.os == 'Linux'\n run: sudo apt-get install -y elvish fish zsh\n - name: Build\n run: make build-${{matrix.features}}\n - name: Test\n run: make test-${{matrix.features}}\n - name: Test (benches)\n run: make test-${{matrix.features}} ARGS='--workspace --benches'\n - name: Test (ultra-minimal)\n if: matrix.build == 'minimal'\n run: make test-minimal ARGS='--manifest-path Cargo.toml'\n - name: Test dynamic completions\n run: cargo test -p clap_complete -F unstable-dynamic\n latest:\n name: \"Check latest dependencies\"\n strategy:\n matrix:\n build: [stable]\n include:\n - build: stable\n os: ubuntu-latest\n rust: \"stable\"\n features: \"full\"\n runs-on: ${{ matrix.os }}\n env:\n CARGO_RESOLVER_INCOMPATIBLE_RUST_VERSIONS: allow\n steps:\n - name: Checkout repository\n uses: actions/checkout@v6\n - name: Install Rust\n uses: dtolnay/rust-toolchain@stable\n with:\n toolchain: stable\n - uses: Swatinem/rust-cache@v2\n - uses: taiki-e/install-action@cargo-hack\n - name: Install shells\n if: runner.os == 'Linux'\n run: sudo apt-get install -y elvish fish zsh\n - name: Update dependencies\n run: cargo update\n - name: Build\n run: make build-${{matrix.features}}\n - name: Test\n run: make test-${{matrix.features}}\n - name: Test (benches)\n run: make test-${{matrix.features}} ARGS='--workspace --benches'\n - name: Test (ultra-minimal)\n if: matrix.build == 'minimal'\n run: make test-minimal ARGS='--manifest-path Cargo.toml'\n - name: Test dynamic completions\n run: cargo test -p clap_complete -F unstable-dynamic\n" }, { "path": ".github/workflows/spelling.yml", "content": "name: Spelling\n\npermissions:\n contents: read\n\non: [pull_request]\n\nenv:\n RUST_BACKTRACE: 1\n CARGO_TERM_COLOR: always\n CLICOLOR: 1\n\nconcurrency:\n group: \"${{ github.workflow }}-${{ github.ref }}\"\n cancel-in-progress: true\n\njobs:\n spelling:\n name: Spell Check with Typos\n runs-on: ubuntu-latest\n steps:\n - name: Checkout Actions Repository\n uses: actions/checkout@v6\n - name: Spell Check Repo\n uses: crate-ci/typos@master\n" }, { "path": ".github/workflows/template.yml", "content": "name: Template Update\n\npermissions:\n contents: read\n\non:\n schedule:\n - cron: '1 1 1 * *'\n workflow_dispatch:\n\nenv:\n RUST_BACKTRACE: 1\n CARGO_TERM_COLOR: always\n CLICOLOR: 1\n TEMPLATE_URL: \"https://github.com/epage/_rust.git\"\n TEMPLATE_BRANCH: \"main\"\n\nconcurrency:\n group: \"${{ github.workflow }}-${{ github.ref }}\"\n cancel-in-progress: true\n\njobs:\n update:\n permissions:\n security-events: write # to create PR\n pull-requests: write\n contents: write # to push the branch\n runs-on: ubuntu-latest\n steps:\n - name: Checkout repository\n uses: actions/checkout@v6\n with:\n fetch-depth: 0\n - name: Configure git\n run: |\n git config --global user.name '${{ github.actor }}'\n git config --global user.email '<>'\n - name: Fetch template\n run: \"git remote add template ${{ env.TEMPLATE_URL }} && git fetch template ${{ env.TEMPLATE_BRANCH }}\"\n - name: Merge template\n run: \"git checkout -b template-update && git merge template/${{ env.TEMPLATE_BRANCH }} -m 'chore: Update from template'\"\n - name: Clear any existing branch\n run: \"git push origin --delete template-update\"\n continue-on-error: true\n env:\n GH_TOKEN: ${{ github.token }}\n - name: Push branch\n run: \"git push --set-upstream origin template-update\"\n env:\n GH_TOKEN: ${{ github.token }}\n - name: Create PR\n run: \"gh pr create --head template-update --title 'chore: Update from template' --body ''\"\n env:\n GH_TOKEN: ${{ github.token }}\n - name: Merge PR\n run: \"gh pr merge --auto --delete-branch\"\n env:\n GH_TOKEN: ${{ github.token }}\n" }, { "path": ".gitignore", "content": "target\n" }, { "path": ".pre-commit-config.yaml", "content": "exclude: |\n (?x)^(\n tests/.*|\n CHANGELOG.md\n )$\ndefault_install_hook_types: [\"pre-commit\", \"commit-msg\"]\nrepos:\n - repo: https://github.com/pre-commit/pre-commit-hooks\n rev: v6.0.0\n hooks:\n - id: check-yaml\n - id: check-json\n - id: check-toml\n - id: check-merge-conflict\n - id: check-case-conflict\n - id: detect-private-key\n - repo: https://github.com/crate-ci/typos\n rev: v1.44.0\n hooks:\n - id: typos\n - repo: https://github.com/crate-ci/committed\n rev: v1.1.11\n hooks:\n - id: committed\n" }, { "path": "CHANGELOG.md", "content": "# Change Log\nAll notable changes to this project will be documented in this file.\n\nThe format is based on [Keep a Changelog](https://keepachangelog.com/)\nand this project adheres to [Semantic Versioning](https://semver.org/).\n\n## 5.0.0 - TBD\n\n*available through `unstable-v5` feature flag*\n\n### Breaking Changes\n\n- Made `ArgPredicate` `non_exhaustive`\n- *(help)* Change default `Command::term_width` to \"source format\"\n- *(help)* Change default `Command::max_term_width` to 100\n- *(derive)* `Vec>` types are now assuming to capture occurrences\n- *(derive)* `ValueEnum` variants now use the full doc comment, not summary, for `PossibleValue::help`\n\n### Features\n\n- *(derive)* Group values by their occurrence with `Vec>`\n\n\n## [Unreleased] - ReleaseDate\n\n## [4.6.0] - 2026-03-12\n\n### Compatibility\n\n- Update MSRV to 1.85\n\n## [4.5.61] - 2026-03-12\n\n### Internal\n\n- Update dependencies\n\n## [4.5.60] - 2026-02-19\n\n### Fixes\n\n- *(help)* Quote empty default values, possible values\n\n## [4.5.59] - 2026-02-16\n\n### Fixes\n\n- `Command::ignore_errors` no longer masks help/version on subcommands\n\n## [4.5.58] - 2026-02-11\n\n## [4.5.57] - 2026-02-03\n\n### Fixes\n\n- Regression from 4.5.55 where having an argument with `.value_terminator(\"--\")` caused problems with an argument with `.last(true)`\n\n## [4.5.56] - 2026-01-29\n\n### Fixes\n\n- On conflict error, don't show conflicting arguments in the usage\n\n## [4.5.55] - 2026-01-27\n\n### Fixes\n\n- Fix inconsistency in precedence between positionals with a `value_terminator(\"--\")` and escapes (`--`) where `./foo -- bar` means the first arg is empty, rather than escaping future args\n\n## [4.5.54] - 2026-01-02\n\n### Fixes\n\n- *(help)* Move `[default]` to its own paragraph when `PossibleValue::help` is present in `--help`\n\n## [4.5.53] - 2025-11-19\n\n### Features\n\n- Add `default_values_if`, `default_values_ifs`\n\n## [4.5.52] - 2025-11-17\n\n### Fixes\n\n- Don't panic when `args_conflicts_with_subcommands` conflicts with an `ArgGroup`\n\n## [4.5.51] - 2025-10-29\n\n### Fixes\n\n- *(help)* Correctly calculate padding for short flags that take a value\n- *(help)* Don't panic on short flags using `ArgAction::Count`\n\n## [4.5.50] - 2025-10-20\n\n### Features\n\n- Accept `Cow` where `String` and `&str` are accepted\n\n## [4.5.49] - 2025-10-13\n\n### Fixes\n\n- *(help)* Correctly wrap when ANSI escape codes are present\n\n## [4.5.48] - 2025-09-19\n\n### Documentation\n\n- Add a new CLI Concepts document as another way of framing clap\n- Expand the `typed_derive` cookbook entry\n\n## [4.5.47] - 2025-09-02\n\n### Features\n\n- Added `impl FromArgMatches for ()`\n- Added `impl Args for ()`\n- Added `impl Subcommand for ()`\n- Added `impl FromArgMatches for Infallible`\n- Added `impl Subcommand for Infallible`\n\n### Fixes\n\n- *(derive)* Update runtime error text to match `clap`\n\n## [4.5.46] - 2025-08-26\n\n### Features\n\n- Expose `StyledStr::push_str`\n\n## [4.5.45] - 2025-08-12\n\n### Fixes\n\n- *(unstable-v5)* `ValueEnum` variants now use the full doc comment, not summary, for `PossibleValue::help`\n\n## [4.5.44] - 2025-08-11\n\n### Features\n\n- Add `Command::mut_subcommands`\n\n## [4.5.43] - 2025-08-06\n\n### Fixes\n\n- *(help)* In long help, list Possible Values before defaults, rather than after, for a more consistent look\n\n## [4.5.42] - 2025-07-30\n\n### Fixes\n\n- Include subcommand visible long aliases in `--help`\n\n## [4.5.41] - 2025-07-09\n\n### Features\n\n- Add `Styles::context` and `Styles::context_value` to customize the styling of `[default: value]` like notes in the `--help`\n\n## [4.5.40] - 2025-06-09\n\n### Features\n\n- Support quoted ids in `arg!()` macro (e.g. `arg!(\"check-config\": ...)`)\n\n## [4.5.39] - 2025-05-27\n\n### Fixes\n\n- *(help)* Show short flag aliases before long\n- *(help)* Merge the short and long flag alias lists\n\n## [4.5.38] - 2025-05-11\n\n### Fixes\n\n- *(help)* When showing aliases, include leading `--` or `-`\n\n## [4.5.37] - 2025-04-18\n\n### Features\n\n- Added `ArgMatches::try_clear_id()`\n\n## [4.5.36] - 2025-04-11\n\n### Fixes\n\n- *(help)* Revert 4.5.35's \"Don't leave space for shorts if there are none\" for now\n\n## [4.5.35] - 2025-04-01\n\n### Fixes\n\n- *(help)* Align positionals and flags when put in the same `help_heading`\n- *(help)* Don't leave space for shorts if there are none\n\n## [4.5.34] - 2025-03-27\n\n### Fixes\n\n- *(help)* Don't add extra blank lines with `flatten_help(true)` and subcommands without arguments\n\n## [4.5.33] - 2025-03-26\n\n### Fixes\n\n- *(error)* When showing the usage of a suggestion for an unknown argument, don't show the group\n\n## [4.5.32] - 2025-03-10\n\n### Features\n\n- Add `Error::remove`\n\n### Documentation\n\n- *(cookbook)* Switch from `humantime` to `jiff`\n- *(tutorial)* Better cover required vs optional\n\n### Internal\n\n- Update `pulldown-cmark`\n\n## [4.5.31] - 2025-02-24\n\n### Features\n\n- Add `ValueParserFactory` for `Saturating`\n\n## [4.5.30] - 2025-02-17\n\n### Fixes\n\n- *(assert)* Allow `num_args(0..=1)` to be used with `SetTrue`\n- *(assert)* Clean up rendering of `takes_values` assertions\n\n## [4.5.29] - 2025-02-11\n\n### Fixes\n\n- Change `ArgMatches::args_present` so not-present flags are considered not-present (matching the documentation)\n\n## [4.5.28] - 2025-02-03\n\n### Features\n\n- *(derive)* Unstable support for full markdown syntax for doc comments, enabled with `unstable-markdown`\n\n## [4.5.27] - 2025-01-20\n\n### Documentation\n\n- Iterate on tutorials and reference based on feedback\n\n## [4.5.26] - 2025-01-09\n\n### Fixes\n\n- *(error)* Reduce binary size with the `suggestions` feature\n\n## [4.5.25] - 2025-01-09\n\n### Fixes\n\n- *(help)* Reduce binary size\n\n## [4.5.24] - 2025-01-07\n\n### Fixes\n\n- *(parser)* Correctly handle defaults with `ignore_errors(true)` and when a suggestion is provided for an unknown argument\n\n## [4.5.23] - 2024-12-05\n\n### Fixes\n\n- *(parser)* When check `allow_negative_numbers`, allow `E` again\n\n## [4.5.22] - 2024-12-03\n\n### Fixes\n\n- *(assert)* Catch bugs with arguments requiring themself\n\n## [4.5.21] - 2024-11-13\n\n### Fixes\n\n- *(parser)* Ensure defaults are filled in on error with `ignore_errors(true)`\n\n## [4.5.20] - 2024-10-08\n\n### Features\n\n- *(unstable)* Add `CommandExt`\n\n## [4.5.19] - 2024-10-01\n\n### Internal\n\n- Update dependencies\n\n## [4.5.18] - 2024-09-20\n\n### Features\n\n- *(builder)* Expose `Arg::get_display_order` and `Command::get_display_order`\n\n## [4.5.17] - 2024-09-04\n\n### Fixes\n\n- *(help)* Style required argument groups\n- *(derive)* Improve error messages when unsupported fields are used\n\n## [4.5.16] - 2024-08-15\n\n### Fixes\n\n- *(derive)* Improve error messages when `derive` feature is missing\n\n## [4.5.15] - 2024-08-10\n\n### Compatiblity\n\n- *(unstable-ext)* `Arg::remove` changed return types\n\n### Fixes\n\n- *(unstable-ext)* Make `Arg::remove` return the removed item\n\n## [4.5.14] - 2024-08-08\n\n### Features\n\n- *(unstable-ext)* Added `Arg::add` for attaching arbitrary state, like completion hints, to `Arg` without `Arg` knowing about it\n\n## [4.5.13] - 2024-07-31\n\n### Fixes\n\n- *(derive)* Improve error message when `#[flatten]`ing an optional `#[group(skip)]`\n- *(help)* Properly wrap long subcommand descriptions in help\n\n## [4.5.12] - 2024-07-31\n\n## [4.5.11] - 2024-07-25\n\n## [4.5.10] - 2024-07-23\n\n## [4.5.9] - 2024-07-09\n\n### Fixes\n\n- *(error)* When defining a custom help flag, be sure to suggest it like we do the built-in one\n\n## [4.5.8] - 2024-06-28\n\n### Fixes\n\n- Reduce extra flushes\n\n## [4.5.7] - 2024-06-10\n\n### Fixes\n\n- Clean up error message when too few arguments for `num_args`\n\n## [4.5.6] - 2024-06-06\n\n## [4.5.5] - 2024-06-06\n\n### Fixes\n\n- Allow `exclusive` to override `required_unless_present`, `required_unless_present_any`, `required_unless_present_all`\n\n## [4.5.4] - 2024-03-25\n\n### Fixes\n\n- *(derive)* Allow non-literal `#[arg(id)]` attributes again\n\n## [4.5.3] - 2024-03-15\n\n### Internal\n\n- *(derive)* Update `heck`\n\n## [4.5.2] - 2024-03-06\n\n### Fixes\n\n- *(macros)* Silence a warning\n\n## [4.5.1] - 2024-02-16\n\n### Fixes\n\n- *(error)* Include suggestion to add `--` even if there is a \"did you mean\" so long as `last` or `trailing_var_arg` is used\n\n## [4.5.0] - 2024-02-08\n\n### Compatibility\n\n- Update MSRV to 1.74\n\n## [4.4.18] - 2024-01-16\n\n### Fixes\n\n- *(error)* When lacking `usage` feature, ensure the list of required arguments is unique\n\n## [4.4.17] - 2024-01-15\n\n### Fixes\n\n- Fix `panic!` when mixing `args_conflicts_with_subcommands` with `ArgGroup` (which is implicit with `derive`) introduced in 4.4.15\n\n## [4.4.16] - 2024-01-12\n\n### Fixes\n\n- Ensure invalid escape sequences in user-defined strings are correctly stripped when terminal doesn't support color\n\n## [4.4.15] - 2024-01-11\n\n### Fixes\n\n- Improve error for `args_conflicts_with_subcommands`\n- Ensure we error for `args_conflicts_with_subcommands` when using subcommand short and long flags\n\n## [4.4.14] - 2024-01-08\n\n### Documentation\n\n- Fix `find` cookbook entry to allow repeats of flags/options\n\n### Features\n\n- Allow `num_args(0)` on options which allows making them emulate being a flag for position-tracking flags\n\n## [4.4.13] - 2024-01-04\n\n### Documentation\n\n- Fix link to structopt migration guide\n\n## [4.4.12] - 2023-12-28\n\n### Performance\n\n- Only ask `TypedValueParser` for possible values if needed\n\n## [4.4.11] - 2023-12-04\n\n### Features\n\n- Add `Command::mut_group`\n\n## [4.4.10] - 2023-11-28\n\n### Documentation\n\n- Link out to changelog\n- Cross link derive's attribute reference to derive tutorial\n\n## [4.4.9] - 2023-11-27\n\n### Fixes\n\n- *(help)* Show correct `Command::about` under flattened headings\n- *(help)* Respect `hide` when flattening subcommands\n\n## [4.4.8] - 2023-11-10\n\n### Features\n\n- Add `Command::flatten_help` to allow `git stash -h` like help for subcommands\n\n## [4.4.7] - 2023-10-24\n\n### Performance\n\n- Reduced code size\n\n## [4.4.6] - 2023-09-28\n\n### Internal\n\n- Upgrade `anstream`\n\n## [4.4.5] - 2023-09-25\n\n### Fixes\n\n- *(parser)* When inferring subcommand `name` or `long_flag`, allow ambiguous-looking matches that unambiguously map back to the same command\n- *(parser)* When inferring subcommand `long_flag`, don't panic\n- *(assert)* Clarify what action is causing a positional that doesn't set values which is especially useful for derive users\n\n## [4.4.4] - 2023-09-18\n\n### Internal\n\n- Update `terminal_size` to 0.3\n\n## [4.4.3] - 2023-09-12\n\n### Documentation\n\n- *(derive)* Clarify use of attributes within the tutorial\n- Split sections in the builder and derive tutorials into separate modules\n\n## [4.4.2] - 2023-08-31\n\n### Performance\n\n- Improve build times by removing `once_cell` dependency\n\n## [4.4.1] - 2023-08-28\n\n### Features\n\n- Stabilize `Command::styles`\n\n## [4.4.0] - 2023-08-24\n\n### compatibility\n\n- update msrv to 1.70.0\n\n## [4.3.24] - 2023-08-23\n\n### Fixes\n\n- Ensure column padding is preserved in `--help` with custom templates\n\n## [4.3.23] - 2023-08-18\n\n### Fixes\n\n- Fixed `UnknownArgumentValueParser` to not error on flag's absence\n\n## [4.3.22] - 2023-08-17\n\n### Features\n\n- Add `UnknownArgumentValueParser` for injecting errors for improving the experience with errors\n\n## [4.3.21] - 2023-08-08\n\n### Features\n\n- Expose `TryMapValueParser` so the type can be named\n\n## [4.3.20] - 2023-08-08\n\n### Features\n\n- `Command::mut_args` for modifying all arguments en masse\n\n## [4.3.19] - 2023-07-21\n\n### Fixes\n\n- *(parse)* Respect `value_terminator` even in the presence of later multiple-value positional arguments\n\n## [4.3.18] - 2023-07-21\n\n### Fixes\n\n- *(parse)* Suggest `--` in fewer places where it won't work\n\n## [4.3.17] - 2023-07-19\n\n### Fixes\n\n- *(help)* Address a regression in wrapping `PossibleValue` descriptions in `--help`\n\n## [4.3.16] - 2023-07-18\n\n### Fixes\n\n- Don't assert when stateful value parsers fail on defaults (e.g. checking if a path exists)\n\n## [4.3.15] - 2023-07-18\n\n### Features\n\n- *(unstable-styles)* Re-export `anstyle`\n\n### Documentation\n\n- *(unstable-styles)* Provide more examples\n\n## [4.3.14] - 2023-07-17\n\n### Features\n\n- `ArgAction::HelpShort` and `ArgAction::HelpLong` for explicitly specifying which style of help to display\n\n### Fixes\n\n- Skip `[OPTIONS]` in usage if a help or version `ArgAction` is used\n\n## [4.3.13] - 2023-07-17\n\n## [4.3.12] - 2023-07-14\n\n### Fixes\n\n- *(derive)* Don't error on enum variant field attributes\n\n## [4.3.11] - 2023-07-05\n\n### Features\n\n- *(derive)* Support fields wrapped in `num::Wrapping`, `Box`, or `Arc`\n- *(derive)* Support `Box`, `Box`, and `Box`\n\n## [4.3.10] - 2023-06-30\n\n### Performance\n\n- Drop a dependency, reducing binary size by 1.3 KiB\n\n## [4.3.9] - 2023-06-28\n\n### Fixes\n\n- `Command::ignore_errors` no longer masks help/version\n\n## [4.3.8] - 2023-06-23\n\n### Fixes\n\n- Error on ambiguity with `infer_long_arg`, rather than arbitrarily picking one, matching the documentation and subcommand's behavior\n\n## [4.3.7] - 2023-06-23\n\n### Documentation\n\n- Further clarify magic behavior in derive tutorial\n- Further clarify derive API's relationship to builder within the tutorial\n\n## [4.3.6] - 2023-06-23\n\n### Documentation\n\n- Suggest `clio`\n\n## [4.3.5] - 2023-06-20\n\n- `ColorChoice::possible_values` is added to simplify things for builder users\n\n### Fixes\n\n- `ColorChoice::to_possible_value` no longer includes descriptions, encouraging shorter help where possible\n\n## [4.3.4] - 2023-06-14\n\n### Features\n\n- Add `Error::exit_code`\n\n## [4.3.3] - 2023-06-09\n\n### Features\n\n- `Command::defer` for delayed initialization of subcommands to reduce startup times of large applications like deno\n\n## [4.3.2] - 2023-06-05\n\n### Fixes\n\n- *(derive)* Don't produce `unused_equalifications` warnings when someone brings a clap type into scope\n\n## [4.3.1] - 2023-06-02\n\n### Performance\n\n- *(derive)* Reduce the amount of generated code\n\n## [4.3.0] - 2023-05-19\n\n### Fixes\n\n- *(assert)* Allow multiple, value-terminated, positional arguments\n- *(assert)* Clear up language on `last` assertion\n- *(parser)* Correctly assign values to arguments when using multiple, value-termianted, positional arguments\n- *(parser)* Ensure `value_terminator` has higher precedence than `allow_hyphen_values`\n- *(help)* Only use next-line-help on subcommand list when explicitly specified, not just with `--help`\n- *(help)* Correctly align possible values list\n- *(help)* Don't waste code, vertical space in moving possible value descriptions to next line\n\n## [4.2.7] - 2023-05-02\n\n### Fixes\n\n- Correctly track remaining length for iterators provided by `ArgMatches`\n\n## [4.2.6] - 2023-05-02\n\n### Features\n\n- `impl Eq for clap_builder::util::AnyValueId`\n\n## [4.2.5] - 2023-04-27\n\n### Fixes\n\n- Improve panic when a group requires a non-existent ID\n\n## [4.2.4] - 2023-04-19\n\n### Documentation\n\n- Corrected docs for `Command::style`\n\n## [4.2.3] - 2023-04-18\n\n### Features\n\n- `Command::styles` for theming help/errors (behind `unstable-styles`)\n\n## [4.2.2] - 2023-04-13\n\n### Internal\n\n- Update dependencies\n\n## [4.2.1] - 2023-03-28\n\n### Fixes\n\n- Don't highlight uninteresting parts of the error message\n\n## [4.2.0] - 2023-03-28\n\n### Compatibility\n\n- Removed the languishing `unstable-replace` feature (open to discussion at [#2836](https://github.com/clap-rs/clap/issues/2836))\n- Removed the stablized `unstable-grouped` feature\n\n### Features\n\n- Allow any `StyledStr` to accept text styled with ANSI escape codes\n- Respect `CLICOLOR`, `CLICOLOR_FORCE`\n\n### Fixes\n\n- Lighten the tone for \"unexpected argument\" errors (open to discussion at [#4638](https://github.com/clap-rs/clap/issues/4638))\n\n## [4.1.14] - 2023-03-28\n\n### Features\n\n- *(derive)* `#[group]` raw attribute support\n\n### Performance\n\n- *(derive)* `clap_builder` was pulled out of `clap` so it could build in parallel to `clap_derive`\n- `os_str_bytes` dependency was removed for faster builds and smaller binaries\n\n## [4.1.13] - 2023-03-18\n\n### Performance\n\n- Reduce repeated alloc calls when building a `Command`\n- Reduce duplicate dependencies for faster builds\n\n## [4.1.12] - 2023-03-18\n\n### Internal\n\n- *(derive)* Update to `syn` v2\n\n### Performance\n\n- *(derive)* Faster build times by dropping `proc-macro-error` dependency\n\n## [4.1.11] - 2023-03-17\n\n### Internal\n\n- Update `bitflags`\n\n## [4.1.10] - 2023-03-17\n\n### Fixes\n\n- *(help)* On Windows, avoid underlined text artifacts\n\n## [4.1.9] - 2023-03-16\n\n### Fixes\n\n- *(assert)* Improve the assert when using the wrong action with `get_count` / `get_flag`\n\n## [4.1.8] - 2023-02-27\n\n### Fixes\n\n- *(derive)* Don't `deny` lints on the users behalf\n\n## [4.1.7] - 2023-02-27\n\n### Fixes\n\n- *(derive)* Hide some nightly clippy warnings\n\n## [4.1.6] - 2023-02-15\n\n### Fixes\n\n- *(help)* Don't show long help for `--help` just because hidden possible values include a description\n\n## [4.1.5] - 2023-02-15\n\n### Fixes\n\n- *(help)* Don't show long help for `--help` just because a hidden arg has a possible value with a description\n\n## [4.1.4] - 2023-01-24\n\n### Fixes\n\n- *(help)* Respect `disable_colored_help` when using `arg_required_else_help`\n\n### Performance\n\n- Speed up compiling `arg!` macro\n\n## [4.1.3] - 2023-01-23\n\n### Fixes\n\n- *(error)* Improve suggested flag/value/subcommand when two share a long preifx\n- *(error)* When suggesting one of several subcommands, use the plural `subcommands`, rather than `subcommand`\n\n## [4.1.2] - 2023-01-23\n\n### Fixes\n\n- In documentation, refer to `get_flag`, rather than `get_one::`\n\n## [4.1.1] - 2023-01-14\n\n### Fixes\n\n- *(error)* Small softening attempt for \"unexpected argument\" error\n\n## [4.1.0] - 2023-01-13\n\n### Compatibility\n\nMSRV changed to 1.64.0\n\nFor apps with custom `--help` and `--version` flags:\n- Descriptions for `--help` and `--version` changed\n\nWhen apps have errors imitating clap's error style:\n- Error message style was changed, including\n - Moving away from \"did you mean\" to tips\n - Leading letter is lower case\n - \"For more\" added some punctuation\n\n### Features\n\n- `ArgMatches::get_occurrences` support for argument values to be grouped by their occurrence\n\n### Fixes\n\n- *(derive)* Allow `upgrade_from` when arguments / subcommands are explicitly marked as required\n- *(help)* Try be more clearer and succinct with `--help` and `--version` (also helps with overflow)\n- *(error)* Try to be more clearer and succinct with error messages\n- *(error)* Officially adopt [an error style guide](https://rustc-dev-guide.rust-lang.org/diagnostics.html#suggestion-style-guide)\n\n## [4.0.32] - 2022-12-22\n\n### Fixes\n\n- *(parser)* When overriding `required(true)`, consider args that conflict with its group\n\n## [4.0.31] - 2022-12-22\n\n### Performance\n\n- Speed up parsing when a lot of different flags are present (100 unique flags)\n\n## [4.0.30] - 2022-12-21\n\n### Fixes\n\n- *(error)* Improve error for `args_conflicts_with_subcommand`\n\n## [4.0.29] - 2022-11-29\n\n## [4.0.28] - 2022-11-29\n\n### Fixes\n\n- Fix wasm support which was broken in 4.0.27\n\n## [4.0.27] - 2022-11-24\n\n### Features\n\n- Have `Arg::value_parser` accept `Vec>`\n- Implement `Display` and `FromStr` for `ColorChoice`\n\n### Fixes\n\n- Remove soundness issue by switching from `atty` to `is-terminal`\n\n## [4.0.26] - 2022-11-16\n\n### Fixes\n\n- *(error)* Fix typos in `ContextKind::as_str`\n\n## [4.0.25] - 2022-11-15\n\n### Features\n\n- *(error)* Report available subcommands when required subcommand is missing\n\n## [4.0.24] - 2022-11-14\n\n### Fixes\n\n- Avoid panic when printing an argument that isn't built\n\n## [4.0.23] - 2022-11-11\n\n### Fixes\n\n- Don't panic on reporting invalid-long errors when followed by invalid UTF8\n- *(help)* Clarified argument to `help` subcommand\n\n## [4.0.22] - 2022-11-07\n\n### Fixes\n\n- *(help)* Don't overflow into next-line-help early due to stale (pre-v4) padding calculations\n\n## [4.0.21] - 2022-11-07\n\n### Features\n\n- *(derive)* `long_about` and `long_help` attributes, without a value, force using doc comment (before it wouldn't be set if there wasn't anything different than the short help)\n\n## [4.0.20] - 2022-11-07\n\n### Fixes\n\n- *(derive)* Allow defaulted value parser for '()' fields\n\n## [4.0.19] - 2022-11-04\n\n### Features\n\n- `ColorChoice` now implements `ValueEnum`\n\n## [4.0.18] - 2022-10-20\n\n### Fixes\n\n- *(derive)* Allow `#[command(skip)]` to also work with enum variants with a value\n\n## [4.0.17] - 2022-10-18\n\n### Fixes\n\n- Allow using `Arg::last(true)` with `Arg::value_hint(ValueHint::CommandWithArguments)`\n\n## [4.0.16] - 2022-10-18\n\n### Fixes\n\n- `Arg::exclusive(true)` should not be exclusive with the argument's own `ArgGroup`\n\n## [4.0.15] - 2022-10-13\n\n### Fixes\n\n- *(error)* Don't suggest `--` when it doesn't help\n- *(error)* Be more consistent in quoting, punctuation, and indentation in errors\n\n## [4.0.14] - 2022-10-12\n\n### Fixes\n\n- Only put `ArgGroup` in `ArgMatches` when explicitly specified, fixing derives handling of option-flattened fields (#4375)\n\n## [4.0.13] - 2022-10-11\n\n### Features\n\n- *(derive)* Allow `()` for fields to mean \"don't read\" (#4371)\n\n## [4.0.12] - 2022-10-10\n\n### Features\n\n- Added `TypedValueParser::try_map` for when adapting an existing `TypedValueParser` can fail\n- *(error)* Create errors like clap with `Error::new`, `Error::with_cmd`, and `Error::insert`\n\n## [4.0.11] - 2022-10-09\n\n### Fixes\n\n- *(help)* Fix wrapping calculations with ANSI escape codes\n\n## [4.0.10] - 2022-10-05\n\n### Features\n\n- *(derive)* Support `#[arg(flatten)]` on `Option` types (#4211, #4350)\n\n## [4.0.9] - 2022-10-03\n\n### Fixes\n\n- *(derive)* Process doc comments for `#[command(subcommand)]` like in clap v3\n\n## [4.0.8] - 2022-10-01\n\n### Fixes\n\n- *(derive)* Remove a low-value assert preventing defaulting `Help` and `Version` actions\n\n## [4.0.7] - 2022-09-30\n\n### Features\n\n- *(derive)* Populate implicit ArgGroup (#3165)\n\n### Fixes\n\n- *(derive)* Support `#[group(skip)]` on `Parser` derive\n- *(derive)* Tell users about implicit arg groups when running into group name conflicts\n- *(error)* Don't report unrelated groups in conflict or requires errors\n\n## [4.0.6] - 2022-09-30\n\n### Features\n\n- *(derive)* Support `#[group(skip)]` (#4279, #4301)\n\n## [4.0.5] - 2022-09-30\n\n## [4.0.4] - 2022-09-29\n\n### Fixes\n\n- *(error)* Specialize the self-conflict error to look like clap v3\n\n## [4.0.3] - 2022-09-29\n\n### Fixes\n\n- *(error)* Quote literals consistently\n- *(error)* Stylize escape (`--`) suggestions\n- *(error)* Format help flag as a literal\n\n## [4.0.2] - 2022-09-28\n\n### Fixes\n\n- *(parser)* `SetFalse` should conflict with itself like `SetTrue` and `Set`\n- *(parser)* Allow one-off overrides\n\n## [4.0.1] - 2022-09-28\n\n### Fixes\n\n- *(derive)* Ensure `#[clap(...)]` attribute still works\n\n## [4.0.0] - 2022-09-28\n\n### Highlights\n\n**`Arg::num_args(range)`**\n\nClap has had several ways for controlling how many values will be captured without always being clear on how they interacted, including\n- `Arg::multiple_values(true)`\n- `Arg::number_of_values(4)`\n- `Arg::min_values(2)`\n- `Arg::max_values(20)`\n- `Arg::takes_value(true)`\n\nThese have now all been collapsed into `Arg::num_args` which accepts both\nsingle values and ranges of values. `num_args` controls how many raw arguments\non the command line will be captured as values per occurrence and independent\nof value delimiters.\n\nSee [Issue 2688](https://github.com/clap-rs/clap/issues/2688) for more background.\n\n**Polishing Help**\n\nClap strives to give a polished CLI experience out of the box with little\nceremony. With some feedback that has accumulated over time, we took this\nrelease as an opportunity to re-evaluate our `--help` output to make sure it is\nmeeting that goal.\n\nIn doing this evaluation, we wanted to keep in mind:\n- Whether other CLIs had ideas that make sense to apply\n- Providing an experience that fits within the rest of applications and works across all shells\n\nBefore:\n```\ngit\nA fictional versioning CLI\n\nUSAGE:\n git \n\nOPTIONS:\n -h, --help Print help information\n\nSUBCOMMANDS:\n add adds things\n clone Clones repos\n help Print this message or the help of the given subcommand(s)\n push pushes things\n stash\n```\n\nAfter:\n```\nA fictional versioning CLI\n\nUsage: git \n\nCommands:\n clone Clones repos\n push pushes things\n add adds things\n stash\n help Print this message or the help of the given subcommand(s)\n\nOptions:\n -h, --help Print help information\n```\n- name/version header was removed because we couldn't justify the space it occupied when\n - Usage already includes the name\n - `--version` is available for showing the same thing (if the program has a version set)\n- Usage was dropped to one line to save space\n- Focus is put on the subcommands\n- Headings are now Title case\n- The more general term \"command\" is used rather than being explicit about being \"subcommands\"\n- The output is more dense with the expectation that it won't affect legibility but will allow more content\n- We've moved to a more neutral palette for highlighting elements (not highlighted above)\n\nIn talking to users, we found some that liked clap's `man`-like experience.\nWhen deviating from this, we are making the assumption that those are more\npower users and that the majority of users wouldn't look as favorably on being\nconsistent with `man`.\n\nSee [Issue 4132](https://github.com/clap-rs/clap/issues/4132) for more background.\n\n**More Dynamicism**\n\nClap's API has focused on `&str` for performance but this can make\ndealing with owned data difficult, like `#[arg(default_value_t)]` generating a\nString from the default value.\n\nAdditionally, to avoid `ArgMatches` from borrowing (and for some features we\ndecided to forgo), clap took the `&str` argument IDs and hashed them. This\nprevented us from providing a usable API for iterating over existing arguments.\n\nNow clap has switched to a string newtype that gives us the flexibility to\ndecide whether to use `&'static str`, `Cow<'static, str>` for fast dynamic behavior, or\n`Box` for dynamic behavior with small binary size.\n\nAs an extension of that work, you can now call `ArgMatches::ids` to iterate\nover the arguments and groups that were found when parsing. The newtype `Id`\nwas used to prevent some classes of bugs and to make it easier to understand\nwhen opaque Ids are used vs user-visible strings.\n\n**Clearing Out Deprecations**\n\nInstead of doing all development on clap 4.0.0, we implemented a lot of new features during clap 3's development, deprecating the old API while introducing the new API, including:\n- Replacing the implicit behavior for args when parsing them with `ArgAction`\n- Replacing various one-off forms of value validation with the `ValueParser` API\n - Allowing derives to automatically do the right thing for `PathBuf` (allowing invalid UTF-8)\n- Replacing `AppSettings` and `ArgSettings` enums with getters/setters\n- Clarifying terms and making them more consistent\n\n### Migrating\n\nSteps:\n\n0. [Upgrade to v3](https://github.com/clap-rs/clap/blob/v3-master/CHANGELOG.md#migrating) if you haven't already\n1. Add CLI tests (including example below), `-h` and `--help` output at a minimum (recommendation: [trycmd](https://docs.rs/trycmd/) for snapshot testing)\n2. *If using Builder API*: Explicitly set the `arg.action(ArgAction::...)` on each argument (`StoreValue` for options and `IncOccurrences` for flags)\n3. Run `cargo check --features clap/deprecated` and resolve all deprecation warnings\n4. Upgrade to v4\n5. Update feature flags\n - *If `default-features = false`*, run `cargo add clap -F help,usage,error-context`\n - Run `cargo add clap -F wrap_help` unless you want to hard code line wraps\n6. Resolve compiler errors\n7. Resolve behavior changes (see \"subtle changes\" under BREAKING CHANGES)\n8. *At your leisure:* resolve new deprecation notices\n\nExample test (derive):\n```rust\n#[derive(clap::Parser)]\nstruct Cli {\n ...\n}\n\n#[test]\nfn verify_cli() {\n use clap::CommandFactory;\n Cli::command().debug_assert()\n}\n```\n\nExample test (builder):\n```rust\nfn cli() -> clap::Command {\n ...\n}\n\n#[test]\nfn verify_cli() {\n cli().debug_assert();\n}\n```\n\nNote: the idiomatic / recommended way of specifying different types of args in the Builder API has changed:\n\nBefore\n```rust\n.arg(Arg::new(\"flag\").long(\"flag\")) # --flag\n.arg(Arg::new(\"option\").long(\"option\").takes_value(true)) # --option