Skip to content

just --list shows setup as "covering none of that surface." #28

Description

@CameronBrooks11

Found while gating the same defect in prusaslicer-py (its #27). Verified here.

What is wrong

just --list publishes the last comment line before a recipe. setup's block is
five lines:

# Install dependencies and set up environment.
#
# --all-extras deliberately: without it the `mcp` extra is absent, pyright cannot
# resolve the MCP module, and its tests skip silently -- CI reported green while
# covering none of that surface.
setup:

so the description a reader sees is:

setup    # covering none of that surface.

A sentence fragment from the middle of a rationale, with no subject, presented as what
the recipe does. The intended line — "Install dependencies and set up environment."
is the first of the five and is never shown.

Every other recipe in the file is correct; setup is the only one with a multi-line
block.

Fix

A blank line between the rationale and the doc comment, so only the intended line is
adjacent:

# --all-extras deliberately: without it the `mcp` extra is absent, pyright cannot
# resolve the MCP module, and its tests skip silently -- CI reported green while
# covering none of that surface.

# Install dependencies and set up environment
setup:

Not [doc(...)]: it reads better, but unknown attributes are a parse error in every
just and [doc] exists only from 1.27.0, so one of them breaks the entire justfile for
anyone on an older just — Ubuntu 24.04 LTS ships 1.21.0. That is recorded as
prusaslicer-py's D2.1.

Worth gating rather than just fixing

Two of the five members had this simultaneously and independently, which makes it a
pattern rather than a typo. prusaslicer-py now carries a test that reads
just --dump --dump-format json for the authoritative recipe list and asserts each
non-private recipe has exactly one comment line directly above it, plus a non-empty
published doc. It is engine-free and about 40 lines; worth copying if this repo wants
the same guarantee.

The rationale itself is good and should survive the fix — it records why --all-extras
is load-bearing, which is a real finding about silently skipped MCP tests.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions