Report destination guard: the 'report' surface's anti-vacuity half is satisfiable by a child summary in the subcommand table

Open
#2,202 0 comments 0 reactions 0 assignees View on GitHub

Maintainers usually reply within 1 day

Nobody has claimed this yet.

Assessment

Difficulty
3/5
Estimated time
1-2 days
Newbie friendliness
52/100
Issue type
Bug
Clarity
Mostly clear
Activity status
Active
Tech stack
javascript
Domain
testing

Research direction

Start with test/core/cli-consistency-gate.test.js:693-699 and the cited probes B12 and A5 from PR #2195. Read how the guard checks report-group help and how the subcommand table is rendered. Done when the group’s own summary and help prose are checked separately: B12 fails, A5 still fails, and the shipped tree passes.

Written by the indexing model from the issue text.

Description

Source: #2195 at ffc56a5d71f5cc51dd32fb9da5b3fa85f8787665
Location: test/core/cli-consistency-gate.test.js:693-699
Severity: low

Evidence

Probe B12 from PR #2195 round 1, re-confirmed in round 2: strip the destination word from the report group's own help prose and the guard stays green, because 'report render' has summary '(no remote involved)' and group help renders the subcommand table, so the child summary supplies the 'remote' family to the 'report' surface.

Why deferral is safe

The vacuity assertion is the guard's own hardening beyond #2189's contradiction requirement; the defect class the issue names (a second vocabulary) is caught regardless, and the 'report publish' half of the same assertion does bite on its own prose (probe A5 red). Tightening means classifying the group's own paragraph separately from its rendered table, which is more machinery than the shipped risk justifies. Finding 9 records the same class at 'report publish'.

Acceptance condition

The vacuity check evaluates the group's own summary and help prose separately from the rendered subcommand table, so probe B12 goes red while A5 stays red and the shipped tree stays green.

Review preference; backlog only. A human may explicitly delegate it with neutral:fix.

Dominant language
JavaScript
Stars
11
Forks
0
Avg merge
2h 55m
Merged PRs (30d)
294

Getting set up

This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from hyparam/hypaware

All issues in hyparam/hypaware

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.