Use --shallow in doc build to prevent documentation.js from processing GLSL imports#8500
Merged
davepagurek merged 1 commit intoprocessing:dev-2.0from Feb 7, 2026
Merged
Conversation
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.
Resolves #8499
Changes:
Add
--shallowtodocumentation buildindocsscript in package.jsonThis seems like a good general policy, going forward.
Testing
The change reduces error reports from documentation.js from 19 to 0 during
npm run docs. (It's no longer trying to parse .frag and .vert files imported by some of our .js files.)The produced
/docs/data.jsonfile is the same before and after the addition of --shallow, except that elements are in different order. Identical once sorted.(Why the order changed: I guess documentation.js was previously processing files in dependency-resolved order, after the first file. With shallow, it just processes files in order that the input files are given from the command-line glob.)
Here's a command-line to diff two JSON files after sorting them in-memory. Needs
jqjson tool installed.