Skip to content

refactor(consumer-typecheck): consolidate 3 snapshot scripts into one CLI (SD-3213b)#3403

Open
caio-pizzol wants to merge 1 commit into
mainfrom
caio-pizzol/SD-3213b-consolidate-snapshots
Open

refactor(consumer-typecheck): consolidate 3 snapshot scripts into one CLI (SD-3213b)#3403
caio-pizzol wants to merge 1 commit into
mainfrom
caio-pizzol/SD-3213b-consolidate-snapshots

Conversation

@caio-pizzol
Copy link
Copy Markdown
Contributor

Three standalone snapshot scripts (snapshot-super-editor-package-exports.mjs, snapshot-superdoc-legacy-exports.mjs, snapshot-superdoc-root-exports.mjs) shared no code but had identical CLI boilerplate and three separate CI step blocks. Consolidate into a single CLI with a family-module pattern.

  • tests/consumer-typecheck/snapshot.mjs is the unified entry point. Dispatches on --all or --family <name>, with --check (default) or --write. Aggregates exit codes for --all.
  • Each family module under tests/consumer-typecheck/snapshot/ exports FAMILY, DESCRIPTION, and run({ mode }): { code }. No shared abstraction; each family keeps its own enumeration and snapshot shape.
  • ci-superdoc.yml, release-superdoc.yml, release-stable.yml collapse two step blocks into one snapshot.mjs --all --check call.
  • CONTRIBUTING.md, snapshots/README.md, deep-type-audit.README.md, packages/superdoc/AGENTS.md updated to reference the unified CLI.

Review: drop-in CLI surface change. Same gates, same artifacts, same drift behavior; only the entry path moved.

Verified: node tests/consumer-typecheck/snapshot.mjs --all --check against the committed snapshots from origin/main HEAD → all three families report no growth. Each family also passes individually via --family <name> --check.

… CLI (SD-3213b)

Three standalone snapshot scripts (super-editor-package, legacy
subpaths, root 4-source inventory) shared no code but had identical
CLI boilerplate and three separate CI step blocks. Consolidate into a
single CLI with a family-module pattern.

- tests/consumer-typecheck/snapshot.mjs is the unified entry point.
  Dispatches on --all or --family <name>, with --check (default) or
  --write. Aggregates exit codes for --all.
- Each family module under tests/consumer-typecheck/snapshot/ exports
  FAMILY, DESCRIPTION, and run({ mode }) -> { code }. No shared
  abstraction; each family keeps its own enumeration and snapshot
  shape.
- ci-superdoc.yml, release-superdoc.yml, release-stable.yml collapse
  two step blocks into one snapshot.mjs --all --check call.
- CONTRIBUTING.md, snapshots/README.md, deep-type-audit.README.md,
  packages/superdoc/AGENTS.md updated to reference the unified CLI.

Verified locally: all three families pass --check against committed
snapshots, both individually and via --all.
@caio-pizzol caio-pizzol requested a review from a team as a code owner May 19, 2026 22:59
@github-actions
Copy link
Copy Markdown
Contributor

Agent docs audit

Found deterministic findings on 1 changed agent-doc item(s).

packages/superdoc/AGENTS.md (283 lines)

  • over nested-warn (283 > 200)
  • 1 broken path ref(s)

Broken path refs:

  • superdoc/ui/react

Deterministic L1 only: no AI, no Bash, no secrets. Semantic L2/L3 audit runs weekly on main. Policy: agent-docs-policy.md.

@codecov-commenter
Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.

📢 Thoughts on this report? Let us know!

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants