tools-lexicon-report

Renders docs/reference/lexicon.tsv (the Gate 1.3 naming lexicon) as a PDF table with an explanatory header. Input/output paths and PDF engine are CLI arguments, so the same binary works for any TSV in this table shape, not just the lexicon.

Tier	tools
Role	unclassified (baselined)
Path	`crates/tools/lexicon-report`
Edition	2021
Targets	tools-lexicon-report, tools_lexicon_report
Public items	3 across 0 modules
Tests	5

What it is for

Pure parsing/rendering for tools-lexicon-report (PROCESS §17: split logic from the subprocess call so it's testable without a PDF engine installed).

Reads any TSV in the lexicon shape (term\tprefer\tscope\tauto\tnote, #-prefixed comment/header lines and blank lines ignored) and renders it as a self-contained HTML page: a caller-supplied explanation paragraph, then the table. main.rs shells that HTML out to a PDF engine.

Capabilities

`LexiconRow`

Pure parsing/rendering for tools-lexicon-report (PROCESS §17: split logic from

Item
`pub struct LexiconRow`
`fn parse_lexicon_tsv(text : & str) -> Vec <LexiconRow>`
`fn render_html(title : & str, explanation : & str, rows : & LexiconRow) -> String`

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`

Item	What it is
`pub struct LexiconRow`	One data row of the lexicon TSV.
`fn parse_lexicon_tsv(text : & str) -> Vec <LexiconRow>`	Parse a lexicon-shaped TSV
`fn render_html(title : & str, explanation : & str, rows : & LexiconRow) -> String`	Render a self-contained HTML page: title, an explanatory paragraph, then the table

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

Tier (ontology)	`tools`
Architectural role (taxonomy)	`unclassified (baselined)`
Location	`crates/tools/lexicon-report`
Vocabulary in force (lexicon)	`current`

Dependencies

Runtime, from outside the workspace.

Crate	Requirement	Features	Optional	Only on
`anyhow`	`^1`	—	no	always
`clap`	`^4`	`derive`	no	always

Development, in this workspace.

Crate	Tier	Optional	Only on
`tools-cli-conformance`	tools	no	always

Development, from outside the workspace.

Crate	Requirement	Features	Optional	Only on
`tempfile`	`^3`	—	no	always

Build. None.

Depended on by. Nothing in this workspace.

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

flowchart LR
  SELF["tools-lexicon-report"]
  SELF -->|development| n_tools_cli_conformance["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

Kind	Name	Source
bin	`tools-lexicon-report`	`src/main.rs`
lib	`tools_lexicon_report`	`src/lib.rs`

Error model

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

Operational characteristics

Property	Evidence
async public surface	none detected
async runtime	none detected
database access	none detected
network I/O	none detected
unsafe code	none detected
environment variables	none detected

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.

No workspace crate depends on this one.

Verification

Kind	Count
Unit tests	5
Integration tests	0
Examples	0
Doctests	0

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

Module	Tests	Examples	Consumers
`crate root`	3	0	0

What the tests establish, by name:

html_output_escapes_special_characters_and_never_leaks_raw_backtick_markup — src/lib.rs
parses_data_rows_and_skips_comments_and_blanks — src/lib.rs
preserves_row_order — src/lib.rs
skips_malformed_lines_with_too_few_fields — src/lib.rs
cli_definition_conforms — src/main.rs

Documentation coverage

Measure	Documented	Total
Public items with rustdoc	3	3
Public modules with a `//!` block	0	0

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

Metrics

Metric	Value
Rust source files	2
Source lines	275
Code lines	210
Public API items	3
Public modules	0
Tests	5
Examples	0
Cargo features	0
Direct runtime dependencies	2
Workspace reverse dependencies	0

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

pie showData
    title Rust source composition
    "Code" : 210
    "Blank or comment" : 65

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.