Move DEFAULT_VERTEX_SOURCE / DEFAULT_FRAGMENT_SOURCE JSDoc from re-export to declaration site#406
Merged
Merged
Conversation
4 tasks
Agent-Logs-Url: https://github.com/ormidales/microgl/sessions/00df8131-254e-434c-a1e4-a8ea74f5e0c5 Co-authored-by: ormidales <46538211+ormidales@users.noreply.github.com>
Copilot
AI
changed the title
[WIP] Fix JSDoc for DEFAULT_VERTEX_SOURCE and DEFAULT_FRAGMENT_SOURCE
Move DEFAULT_VERTEX_SOURCE / DEFAULT_FRAGMENT_SOURCE JSDoc from re-export to declaration site
Apr 2, 2026
ormidales
approved these changes
Apr 2, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Moves JSDoc (including @security guidance) for DEFAULT_VERTEX_SOURCE / DEFAULT_FRAGMENT_SOURCE from the barrel re-export in src/core/index.ts to the actual declaration site so IDE “Go to Definition” lands on documented constants.
Changes:
- Collapses
Material+ default shader source exports into a single re-export line from./Material. - Updates barrel-export tests to reflect the new expectation: combined export with no duplicated
@securitydocs inindex.ts.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| src/core/index.ts | Replaces three separate ./Material exports (and duplicated JSDoc) with a single combined re-export. |
| tests/core-index.test.ts | Adjusts tests to check for combined re-export and absence of duplicated @security docs in the barrel. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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
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.
@securityannotations and usage docs forDEFAULT_VERTEX_SOURCEandDEFAULT_FRAGMENT_SOURCEwere attached only to the re-export lines inindex.ts, so "Go to Definition" in any IDE landed on an undocumented constant.Changes
src/core/index.ts— Dropped the duplicate JSDoc blocks from the two separate re-exports; collapsed all three./Materialexports into one line:tests/core-index.test.ts— Replaced the four tests asserting JSDoc on re-export lines with two tests matching the new contract: both constants appear in a combined export, and no@securitytext is duplicated in the barrel.The full JSDoc (including
@security) already existed at the declaration site inMaterial.tsand remains validated bymaterial.test.ts.