Skip to content

Usage examples in README reference commands not present in published @crafter/sunat-cli@0.1.6 #31

@moshe-exe

Description

@moshe-exe

Hi! Thanks again for the project — and especially for the recent README rework in #24, the coverage bars and roadmap table made the surface much easier to reason about.

I wanted to flag one small follow-up that I noticed while trying the Usage examples against @crafter/sunat-cli@0.1.6 from npm. Possible I'm holding it wrong, so happy to be corrected.

What I tried: bun add -g @crafter/sunat-cli (latest = 0.1.6), then walked through the Usage section.

What I observed: the published build's --help only exposes login | whoami | schema | rhe | f616 | api token. The CPE / SIRE / GRE / api padron lookup / tipo-cambio / cpe doctor examples in the Usage section don't resolve in 0.1.6 — I confirmed by unpacking the tarball that those command modules aren't bundled in this release.

I think the coverage matrix already communicates this at a high level (the % bars clearly aren't "shipped on npm"), but the Usage section reads like a runnable quickstart, so a reader following along can hit "command not found" before realizing those blocks correspond to the in-progress columns of the matrix.

Possible directions (whichever fits your style):

  • A one-line note at the top of Usage like "Examples below reflect the main surface; the published npm release currently ships RHE / F616 / login / schema / api token — see Coverage above for what's wired up."
  • Or per-section badges ([shipped] / [main only]) on the Usage subheaders.
  • Or split Usage into "Available in latest npm" vs "Available from source."

Happy to open a PR with whichever framing you prefer — you'd know best which examples currently run from main vs. which are still gated, so I'd want your steer on the labelling before touching anything.

Either way, no rush, and thanks for the work.

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