feat(lint): Enforce public API docs#633
Closed
dcramer wants to merge 2 commits into
Closed
Conversation
Add a consolidated custom checks runner to the root lint path and use it to enforce JSDoc on new public API declarations. Baseline existing public API docs debt so lint prevents regressions without requiring a large comment-only migration first. Refs GH-622 Co-Authored-By: GPT-5 Codex <codex@openai.com>
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
![cursor[bot]](https://avatars.githubusercontent.com/in/1210556?s=60&v=4){kind=small}
There was a problem hiding this comment.
Cursor Bugbot has reviewed your changes and found 1 potential issue.
❌ Bugbot Autofix is OFF. To automatically fix reported issues with cloud agents, enable autofix in the Cursor dashboard.
Reviewed by Cursor Bugbot for commit e1cdcc5. Configure here.
Cover root declaration-file entrypoints when resolving package exports for public API documentation checks. Keep existing undocumented declaration aliases in the baseline so the check gates new debt. Refs GH-622 Co-Authored-By: GPT-5 Codex <codex@openai.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Add a consolidated custom checks runner to the root lint path and use it to enforce the public API JSDoc policy for new exported interfaces, types, functions, classes, and enums.
Existing undocumented public API declarations are baselined so this starts as a regression gate instead of a large comment-only migration. Future custom checks can plug into the same runner instead of adding more top-level one-off scripts.
Refs GH-622