Conversation
Agent-Logs-Url: https://github.com/ormidales/microgl/sessions/9b4eaae0-8756-4d92-9a65-e09db5fa3688 Co-authored-by: ormidales <46538211+ormidales@users.noreply.github.com>
Agent-Logs-Url: https://github.com/ormidales/microgl/sessions/9b4eaae0-8756-4d92-9a65-e09db5fa3688 Co-authored-by: ormidales <46538211+ormidales@users.noreply.github.com>
…ns-docs docs(GltfLoader): move strict baseline URI protections into @remarks block
Agent-Logs-Url: https://github.com/ormidales/microgl/sessions/86032919-01c7-4924-b193-18549c233326 Co-authored-by: ormidales <46538211+ormidales@users.noreply.github.com>
…length docs(ShaderCache): add rationale JSDoc to MAX_KEY_LENGTH and enforce with tests
Agent-Logs-Url: https://github.com/ormidales/microgl/sessions/21c2cd3b-ffb7-4636-9add-6f9aae19b492 Co-authored-by: ormidales <46538211+ormidales@users.noreply.github.com>
…e-mesh-buffer-threshold docs(RenderSystem): clarify CONSECUTIVE_MESH_BUFFER_FAILURE_WARNING_THRESHOLD JSDoc
Agent-Logs-Url: https://github.com/ormidales/microgl/sessions/ef332060-8db5-4dcc-ab6d-1794b6939f37 Co-authored-by: ormidales <46538211+ormidales@users.noreply.github.com>
Export `wrapGltfError` with JSDoc from `GltfLoader.ts`
…s to getProgramKey - Move @remarks block to appear immediately after the summary line, before the code example, so the ordering constraint is the first thing readers see - Add @see getProgram, @see retainProgram, @see releaseProgram tags - Use {@link getProgram} inline link in @remarks text - Update 3 existing JSDoc tests to anchor on the method signature (getProgramKey(vertexSource) → lastIndexOf backward) instead of the brittle forward-scan from the first 'getProgramKey' text occurrence - Add 2 new tests: @see getProgram present, @remarks before @param Agent-Logs-Url: https://github.com/ormidales/microgl/sessions/d954493b-35c1-49f2-afa5-40b439a6e25d Co-authored-by: ormidales <46538211+ormidales@users.noreply.github.com>
Agent-Logs-Url: https://github.com/ormidales/microgl/sessions/00df8131-254e-434c-a1e4-a8ea74f5e0c5 Co-authored-by: ormidales <46538211+ormidales@users.noreply.github.com>
…ent-source Move DEFAULT_VERTEX_SOURCE / DEFAULT_FRAGMENT_SOURCE JSDoc from re-export to declaration site
… add matching tests Agent-Logs-Url: https://github.com/ormidales/microgl/sessions/13b57889-c7bf-4004-a3e8-ffc596e587ec Co-authored-by: ormidales <46538211+ormidales@users.noreply.github.com>
…to-jsdoc docs(RenderSystem): add @param em and @returns to flushStaleMeshBuffers JSDoc
…opagation, @param and @returns tags Agent-Logs-Url: https://github.com/ormidales/microgl/sessions/f9487d93-c163-439a-b9f4-0e3dcc65f76f Co-authored-by: ormidales <46538211+ormidales@users.noreply.github.com>
…c-for-resolveuri docs(GltfLoader): document Promise requirement, rejection propagation, and add @param/@returns to resolveUri
Contributor
There was a problem hiding this comment.
Pull request overview
This release PR (v1.1.17) focuses on tightening and validating public-facing JSDoc contracts across core modules, plus a small API surface tweak (wrapGltfError export) and a version bump.
Changes:
- Expanded/clarified JSDoc for
GltfLoaderOptions.resolveUri,ShaderCache.getProgramKey, andRenderSystem.flushStaleMeshBuffers/ mesh-buffer failure threshold constant. - Exported
wrapGltfErrorfromsrc/core/GltfLoader.tsand added tests validating both export and JSDoc. - Updated the core barrel export style for
Material+ default shader sources; bumped package version to 1.1.17.
Reviewed changes
Copilot reviewed 9 out of 10 changed files in this pull request and generated 3 comments.
Show a summary per file
| File | Description |
|---|---|
| tests/shader.test.ts | Updates/adds assertions for ShaderCache JSDoc structure (@remarks, @see, MAX_KEY_LENGTH docs). |
| tests/gltf.test.ts | Adds export + behavior tests for wrapGltfError and additional JSDoc contract checks for resolveUri / strict. |
| tests/ecs.test.ts | Adds JSDoc contract checks for flushStaleMeshBuffers and the mesh-buffer failure threshold constant. |
| tests/core-index.test.ts | Adjusts tests to match consolidated barrel re-export of Material + default shader sources without duplicated JSDoc. |
| src/core/ShaderCache.ts | Enhances JSDoc for MAX_KEY_LENGTH and restructures/expands getProgramKey documentation (@remarks, @see). |
| src/core/index.ts | Consolidates Material + default shader source exports into a single re-export line. |
| src/core/GltfLoader.ts | Clarifies resolveUri JSDoc, adds @remarks for baseline protections, and exports wrapGltfError with param docs. |
| src/core/ecs/systems/RenderSystem.ts | Expands JSDoc for the failure threshold constant and adds @param/@returns to flushStaleMeshBuffers. |
| package.json | Version bump to 1.1.17. |
| package-lock.json | Lockfile updated for version bump (and related metadata changes). |
💡 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.
This pull request primarily improves and clarifies JSDoc documentation throughout the codebase, especially for public APIs and critical internal functions. It also makes minor export and test adjustments to ensure documentation and exports are consistent and well-validated. The most notable changes are grouped below:
JSDoc and API Documentation Improvements
GltfLoaderOptions.resolveUri, explicitly stating the callback must return aPromise, documenting error propagation, and adding@paramand@returnstags. Also, baseline URI protections are now documented in a@remarksblock. [1] [2] [3] [4]ShaderCache.getProgramKeyto include a detailed@remarksblock about key stability and usage, and clarified documentation forShaderCache.MAX_KEY_LENGTH. [1] [2] [3] [4]RenderSystem.flushStaleMeshBuffersand theCONSECUTIVE_MESH_BUFFER_FAILURE_WARNING_THRESHOLDconstant, adding@param,@returns, and rationale for the threshold/reset behavior. [1] [2] [3] [4]Export and API Surface Adjustments
wrapGltfErrorutility to be exported fromGltfLoader.tsand validated its export and JSDoc via new tests. [1] [2] [3] [4]core/index.tsbarrel export to re-exportMaterial,DEFAULT_VERTEX_SOURCE, andDEFAULT_FRAGMENT_SOURCEtogether, removing duplicated JSDoc and security notes from the barrel file. Corresponding tests were updated for this new export style. [1] [2]Version Bump
1.1.16to1.1.17inpackage.json.