Skip to content

quest: plan API Extractor checks and a generated JS API reference - #6553

Merged
kixelated merged 3 commits into
mainfrom
quest-plan/api-extractor
Oct 23, 2026
Merged

kixelated merged 3 commits into
mainfrom
quest-plan/api-extractor

Conversation

@kixelated

Copy link
Copy Markdown
Collaborator

Plans broader API Extractor use for the @moq/* packages, beyond the release-time diff in moq-dev/moq#6477.

New quests (m1)

  • quest/m1/api-extractor-checks.md [M]: API Extractor's messages become errors on every PR (forgotten exports, unresolved declarations, undocumented exports), and js/common/docs.ts and declarations.ts are deleted. Requires the API-diff check.
  • quest/m1/js-api-reference.md [L]: the doc site renders an API reference for every @moq/* package from API Extractor's doc model, including the four packages JSR can't host. Requires the checks.

No public API or wire impact; quest files only.

Decisions (maintainer interview, 2026-10-23)

Goal

  • Checks + reports
  • ✅ Checks + reports + reference
  • Reference only

Confirm goal (reports per entrypoint checked per PR, checks replacing docs.ts/declarations.ts, generated reference for every package; non-goals: Rust, dtsRollup)

  • ✅ Yes
  • Also roll up d.ts

Hosting

  • ✅ Doc site, generated at build time under /lib/js/<pkg>/api
  • JSR + fill the gap
  • JSR only, link it

With #6477

Milestone

  • Checks m1, reference m2
  • ✅ All m1

Version the reference describes

  • ✅ Same checkout as the guides
  • Published npm

Renderer

  • api-documenter
  • ✅ Own renderer from the doc model

Rules without an API Extractor equivalent

  • ✅ Drop them; delete docs.ts and declarations.ts entirely
  • Keep a small docs.ts

Order

Pages

  • ✅ One page per entrypoint, anchor per symbol
  • Page per symbol

Release baseline for the committed reports (conflicts with the api-diff quest's npm-tarball baseline)

  • ✅ Seed release once with a backport of its reports, then diff .api.md files and delete the tarball path
  • Keep the tarball for the gate

The #6477 decisions are recorded on that PR for its next iteration; its quest file is not edited here because #6477 deletes it.

🤖 Generated with Claude Code

(Written by Claude Opus 5.5)

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@coderabbitai

coderabbitai Bot commented Oct 23, 2026 •

Copy link
Copy Markdown
Contributor

Warning

Review limit reached

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Next included review available in 3 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used all 4 included reviews currently available.

Learn how review limits work.

Review configuration:

⚙️ Run configuration
  • Source mode: Auto
  • Repository: Unavailable
  • Branch: Unavailable
  • File: No configuration file from this repository applied
  • Commit: Unavailable
  • Layers: Organization UI
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 69ea96c8-9893-4178-b939-afbc5eed5fb8
📥 Commits

Reviewing files that changed from the base of the PR and between 2cb8329 and 6518352.

📒 Files selected for processing: 3
  • quest/m1/README.md
  • quest/m1/api-extractor-checks.md
  • quest/m1/js-api-reference.md
  • Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Oct 23, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-10-23T16:09:30.093341Z 6518352 New commits
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: dd02c7c3b0

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread quest/m1/api-extractor-checks.md Outdated
Comment thread quest/m1/js-api-reference.md Outdated
@kixelated

Copy link
Copy Markdown
Collaborator Author

Merge summary:

  • Codex findings fixed in e9625b6: api-extractor-checks.md now adds @packageDocumentation beside the kept @module tag (or an equivalent transform) so entrypoint summaries reach the doc model; js-api-reference.md names the package @moq/boy.
  • Merged origin/main; quest check --base origin/main passes. Recorded maintainer decisions unchanged.
  • Codex thumbs-up on head 6518352; required CI green.

(Written by Claude Opus 5.5)

@kixelated
kixelated added this pull request to the merge queue Oct 23, 2026
Merged via the queue into main with commit 3ff39fa Oct 23, 2026
9 checks passed
@kixelated
kixelated deleted the quest-plan/api-extractor branch October 23, 2026 17:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant