tools-cli-conformance

One function, `assert_conforms(clap::Command)`, that a tool's own test suite calls against its CLI definition: every subcommand has `about` text, every argument has help text, bare invocation shows usage instead of an error, and no subcommand redeclares a global argument (the B-030 class — see crates/tools/browser-test/src/main.rs, mod cli_definition_tests, for the incident this generalizes). A tool's CLI must describe itself; this is the mechanical check that it does.

What it is for

One function: assert_conforms. A tool's own test suite calls it with its clap::Command and gets back either nothing (the definition conforms) or a panic naming the offending subcommand/argument.

The spec this enforces, in one sentence: a tool that refuses for want of an argument must show the form that would have worked, and every tool's CLI definition must be self-describing.

Capabilities

crate root

One function: assert_conforms. A tool's own test suite calls it with

How to use it

No examples/ target and no doctest in this crate's rustdoc. The tests listed under Verification are the closest executable usage.

Module structure

No public modules: the crate root is its whole surface.

Public surface

`crate root`

No pub use re-exports: every item above is declared in this crate.

Boundary

Depends on no other workspace tier.

Shares tier tools with 84 other crates: tools-advisory-reach, tools-archive-guard, tools-artifact-scaffold, tools-ask-ai-core, tools-ask-ais, tools-ask-gemini, tools-book, tools-book-report, … (84 total).

_What this crate deliberately does NOT own is a judgment. No committed registry records one for it, so none is stated here._

Where it sits

Dependencies

Runtime, from outside the workspace.

Development. None.

Build. None.

Depended on by. 39 workspace crates.

Signal flow — what reaches this crate, and what it reaches.

flowchart LR
  consumers["39 consumer crates"] -->|uses| SELF
  SELF["tools-cli-conformance"]
  classDef self fill:#1f883d,stroke:#1f883d,color:#fff;
  class SELF self;

Feature flags

No Cargo features are defined: every capability is unconditional, so no consumer can receive a half-wired crate.

Targets

Error model

No public error type was detected: no public item declares a type named *Error, and no public signature returns one.

Operational characteristics

No unsafe block, unsafe fn, unsafe impl or unsafe trait was found by the parser anywhere in this crate's source.

Configuration

No environment variable is read with a literal name anywhere in this crate. A variable whose key is computed at run time cannot be listed here, and is not claimed to be absent.

Related capabilities

39 workspace crates depend on this one: application-wiki, domain-prose-shard, domain-table-shard, domain-transcript-shard, foundation-text-deidentify, tools-artifact-scaffold, tools-book, tools-book-report, tools-browser-test, tools-consolidate-worktrees, tools-corpus, tools-crate-capability-audit, … (39 total).

Verification

Evidence by module. How often each public module is named by something executable.

What the tests establish, by name:

• a_conforming_command_passes — src/lib.rs
• rule1_fires_on_a_subcommand_missing_about_text — src/lib.rs
• rule2_fires_on_an_argument_missing_help_text — src/lib.rs
• rule3_does_not_fire_when_every_argument_has_a_default_and_there_are_no_subcommands — src/lib.rs
• rule3_fires_when_bare_invocation_would_error — src/lib.rs
• rule3_still_fires_when_a_top_level_argument_is_required_even_with_no_subcommands — src/lib.rs
• rule4_fires_on_a_subcommand_redeclaring_a_global_b_030_class — src/lib.rs
• rule5_debug_assert_is_wired_in_as_a_general_net — src/lib.rs

Documentation coverage

pie showData
    title Public items with rustdoc
    "Documented" : 1
    "No rustdoc detected" : 0

Metrics

pie showData
    title Public API by kind
    "function" : 1

pie showData
    title Rust source composition
    "Code" : 182
    "Blank or comment" : 73

Generation

Rendered by tools-corpus corpus readme from repository evidence alone, renderer schema 2, lexicon current. No model, network service or database was consulted. Regenerate with tools-corpus corpus readme --write; verify with --check.