Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

JSDocs unable to handle ChainExpression even existing in code #2109

Open
daniel-lewis-ab opened this issue May 8, 2024 · 1 comment
Open

JSDocs unable to handle ChainExpression even existing in code #2109

daniel-lewis-ab opened this issue May 8, 2024 · 1 comment

Comments

@daniel-lewis-ab
Copy link

Input code

https://github.com/daniel-lewis-ab/litegraph.js/tree/startingAgain

For this repo, I've been trying to use JSDocs to document src as per package.json

JSDoc debug output

npm run docs

> [email protected] docs
> jsdoc -c ./docs/.jsdoc.config -d ./docs -r --verbose --debug

DEBUG: JSDoc 4.0.3 (Thu, 02 May 2024 03:14:16 GMT)
DEBUG: Environment info: {"env":{"conf":{"plugins":[],"recurseDepth":10,"source":{"includePattern":".+\\.js(doc|x)?$","excludePattern":"(^|\\/|\\\\)_","include":["src"]},"sourceType":"module","tags":{"allowUnknownTags":true,"dictionaries":["jsdoc","closure"]},"templates":{"monospaceLinks":false,"cleverLinks":false}},"opts":{"_":[],"configure":"./docs/.jsdoc.config","destination":"./docs","recurse":true,"verbose":true,"debug":true,"encoding":"utf8"}}}
DEBUG: Parsing source files: ["/media/dl/Data/Projects/litegraph.js/src/contextmenu.js","/media/dl/Data/Projects/litegraph.js/src/curveeditor.js","/media/dl/Data/Projects/litegraph.js/src/dragandscale.js","/media/dl/Data/Projects/litegraph.js/src/lgraph.js","/media/dl/Data/Projects/litegraph.js/src/lgraphcanvas.js","/media/dl/Data/Projects/litegraph.js/src/lgraphgroup.js","/media/dl/Data/Projects/litegraph.js/src/lgraphnode.js","/media/dl/Data/Projects/litegraph.js/src/litegraph-editor.js","/media/dl/Data/Projects/litegraph.js/src/litegraph.js","/media/dl/Data/Projects/litegraph.js/src/llink.js","/media/dl/Data/Projects/litegraph.js/src/nodes/audio.js","/media/dl/Data/Projects/litegraph.js/src/nodes/base.js","/media/dl/Data/Projects/litegraph.js/src/nodes/events.js","/media/dl/Data/Projects/litegraph.js/src/nodes/geometry.js","/media/dl/Data/Projects/litegraph.js/src/nodes/glfx.js","/media/dl/Data/Projects/litegraph.js/src/nodes/glshaders.js","/media/dl/Data/Projects/litegraph.js/src/nodes/gltextures.js","/media/dl/Data/Projects/litegraph.js/src/nodes/graphics.js","/media/dl/Data/Projects/litegraph.js/src/nodes/input.js","/media/dl/Data/Projects/litegraph.js/src/nodes/interface.js","/media/dl/Data/Projects/litegraph.js/src/nodes/logic.js","/media/dl/Data/Projects/litegraph.js/src/nodes/math.js","/media/dl/Data/Projects/litegraph.js/src/nodes/math3d.js","/media/dl/Data/Projects/litegraph.js/src/nodes/midi.js","/media/dl/Data/Projects/litegraph.js/src/nodes/network.js","/media/dl/Data/Projects/litegraph.js/src/nodes/others.js","/media/dl/Data/Projects/litegraph.js/src/nodes/strings.js"]
Parsing /media/dl/Data/Projects/litegraph.js/src/contextmenu.js ...
DEBUG: Found a node with unrecognized type ChainExpression. Ignoring the node and its descendants.
DEBUG: Found a node with unrecognized type ChainExpression. Ignoring the node and its descendants.
DEBUG: Found a node with unrecognized type ChainExpression. Ignoring the node and its descendants.
DEBUG: Found a node with unrecognized type ChainExpression. Ignoring the node and its descendants.
DEBUG: Found a node with unrecognized type ChainExpression. Ignoring the node and its descendants.
DEBUG: Found a node with unrecognized type ChainExpression. Ignoring the node and its descendants.
DEBUG: Found a node with unrecognized type ChainExpression. Ignoring the node and its descendants.
DEBUG: Found a node with unrecognized type ChainExpression. Ignoring the node and its descendants.
Parsing /media/dl/Data/Projects/litegraph.js/src/curveeditor.js ...
Parsing /media/dl/Data/Projects/litegraph.js/src/dragandscale.js ...
DEBUG: Found a node with unrecognized type ChainExpression. Ignoring the node and its descendants.
DEBUG: Found a node with unrecognized type ChainExpression. Ignoring the node and its descendants.
DEBUG: Found a node with unrecognized type ChainExpression. Ignoring the node and its descendants.
Parsing /media/dl/Data/Projects/litegraph.js/src/lgraph.js ...
DEBUG: Found a node with unrecognized type ChainExpression. Ignoring the node and its descendants.
DEBUG: Found a node with unrecognized type ChainExpression. Ignoring the node and its descendants.
DEBUG: Found a node with unrecognized type ChainExpression. Ignoring the node and its descendants.
DEBUG: Found a node with unrecognized type ChainExpression. Ignoring the node and its descendants.
DEBUG: Found a node with unrecognized type ChainExpression. Ignoring the node and its descendants.
DEBUG: Found a node with unrecognized type ChainExpression. Ignoring the node and its descendants.
DEBUG: Found a node with unrecognized type ChainExpression. Ignoring the node and its descendants.
DEBUG: Found a node with unrecognized type ChainExpression. Ignoring the node and its descendants.
DEBUG: Found a node with unrecognized type ChainExpression. Ignoring the node and its descendants.
DEBUG: Found a node with unrecognized type ChainExpression. Ignoring the node and its descendants.
DEBUG: Found a node with unrecognized type ChainExpression. Ignoring the node and its descendants.
DEBUG: Found a node with unrecognized type ChainExpression. Ignoring the node and its descendants.
DEBUG: Found a node with unrecognized type ChainExpression. Ignoring the node and its descendants.
DEBUG: Found a node with unrecognized type ChainExpression. Ignoring the node and its descendants.
DEBUG: Found a node with unrecognized type ChainExpression. Ignoring the node and its descendants.
DEBUG: Found a node with unrecognized type ChainExpression. Ignoring the node and its descendants.
DEBUG: Found a node with unrecognized type ChainExpression. Ignoring the node and its descendants.
DEBUG: Found a node with unrecognized type ChainExpression. Ignoring the node and its descendants.
DEBUG: Found a node with unrecognized type ChainExpression. Ignoring the node and its descendants.
DEBUG: Found a node with unrecognized type ChainExpression. Ignoring the node and its descendants.
DEBUG: Found a node with unrecognized type ChainExpression. Ignoring the node and its descendants.
DEBUG: Found a node with unrecognized type ChainExpression. Ignoring the node and its descendants.
DEBUG: Found a node with unrecognized type ChainExpression. Ignoring the node and its descendants.
DEBUG: Found a node with unrecognized type ChainExpression. Ignoring the node and its descendants.
DEBUG: Found a node with unrecognized type ChainExpression. Ignoring the node and its descendants.
DEBUG: Found a node with unrecognized type ChainExpression. Ignoring the node and its descendants.
DEBUG: Found a node with unrecognized type ChainExpression. Ignoring the node and its descendants.
DEBUG: Found a node with unrecognized type ChainExpression. Ignoring the node and its descendants.
DEBUG: Found a node with unrecognized type ChainExpression. Ignoring the node and its descendants.
DEBUG: Found a node with unrecognized type ChainExpression. Ignoring the node and its descendants.
DEBUG: Found a node with unrecognized type ChainExpression. Ignoring the node and its descendants.
DEBUG: Found a node with unrecognized type ChainExpression. Ignoring the node and its descendants.
DEBUG: Found a node with unrecognized type ChainExpression. Ignoring the node and its descendants.
DEBUG: Found a node with unrecognized type ChainExpression. Ignoring the node and its descendants.
DEBUG: Found a node with unrecognized type ChainExpression. Ignoring the node and its descendants.
DEBUG: Found a node with unrecognized type ChainExpression. Ignoring the node and its descendants.
DEBUG: Found a node with unrecognized type ChainExpression. Ignoring the node and its descendants.
DEBUG: Found a node with unrecognized type ChainExpression. Ignoring the node and its descendants.
DEBUG: Found a node with unrecognized type ChainExpression. Ignoring the node and its descendants.
DEBUG: Found a node with unrecognized type ChainExpression. Ignoring the node and its descendants.
DEBUG: Found a node with unrecognized type ChainExpression. Ignoring the node and its descendants.
DEBUG: Found a node with unrecognized type ChainExpression. Ignoring the node and its descendants.
DEBUG: Found a node with unrecognized type ChainExpression. Ignoring the node and its descendants.
DEBUG: Found a node with unrecognized type ChainExpression. Ignoring the node and its descendants.
Parsing /media/dl/Data/Projects/litegraph.js/src/lgraphcanvas.js ...
DEBUG: Found a node with unrecognized type ChainExpression. Ignoring the node and its descendants.
DEBUG: Found a node with unrecognized type ChainExpression. Ignoring the node and its descendants.
DEBUG: Found a node with unrecognized type ChainExpression. Ignoring the node and its descendants.
DEBUG: Found a node with unrecognized type ChainExpression. Ignoring the node and its descendants.
DEBUG: Found a node with unrecognized type ChainExpression. Ignoring the node and its descendants.
DEBUG: Found a node with unrecognized type ChainExpression. Ignoring the node and its descendants.
DEBUG: Found a node with unrecognized type ChainExpression. Ignoring the node and its descendants.
DEBUG: Found a node with unrecognized type ChainExpression. Ignoring the node and its descendants.
DEBUG: Found a node with unrecognized type ChainExpression. Ignoring the node and its descendants.
DEBUG: Found a node with unrecognized type ChainExpression. Ignoring the node and its descendants.
DEBUG: Found a node with unrecognized type ChainExpression. Ignoring the node and its descendants.
DEBUG: Found a node with unrecognized type ChainExpression. Ignoring the node and its descendants.
Parsing /media/dl/Data/Projects/litegraph.js/src/lgraphgroup.js ...
DEBUG: Found a node with unrecognized type ChainExpression. Ignoring the node and its descendants.
Parsing /media/dl/Data/Projects/litegraph.js/src/lgraphnode.js ...
DEBUG: Found a node with unrecognized type ChainExpression. Ignoring the node and its descendants.
DEBUG: Found a node with unrecognized type ChainExpression. Ignoring the node and its descendants.
DEBUG: Found a node with unrecognized type ChainExpression. Ignoring the node and its descendants.
DEBUG: Found a node with unrecognized type ChainExpression. Ignoring the node and its descendants.
DEBUG: Found a node with unrecognized type ChainExpression. Ignoring the node and its descendants.
DEBUG: Found a node with unrecognized type ChainExpression. Ignoring the node and its descendants.
DEBUG: Found a node with unrecognized type ChainExpression. Ignoring the node and its descendants.
DEBUG: Found a node with unrecognized type ChainExpression. Ignoring the node and its descendants.
DEBUG: Found a node with unrecognized type ChainExpression. Ignoring the node and its descendants.
Parsing /media/dl/Data/Projects/litegraph.js/src/litegraph-editor.js ...
DEBUG: Found a node with unrecognized type ChainExpression. Ignoring the node and its descendants.
Parsing /media/dl/Data/Projects/litegraph.js/src/litegraph.js ...
Parsing /media/dl/Data/Projects/litegraph.js/src/llink.js ...
Parsing /media/dl/Data/Projects/litegraph.js/src/nodes/audio.js ...
Parsing /media/dl/Data/Projects/litegraph.js/src/nodes/base.js ...
Parsing /media/dl/Data/Projects/litegraph.js/src/nodes/events.js ...
Parsing /media/dl/Data/Projects/litegraph.js/src/nodes/geometry.js ...
Parsing /media/dl/Data/Projects/litegraph.js/src/nodes/glfx.js ...
Parsing /media/dl/Data/Projects/litegraph.js/src/nodes/glshaders.js ...
Parsing /media/dl/Data/Projects/litegraph.js/src/nodes/gltextures.js ...
Parsing /media/dl/Data/Projects/litegraph.js/src/nodes/graphics.js ...
Parsing /media/dl/Data/Projects/litegraph.js/src/nodes/input.js ...
Parsing /media/dl/Data/Projects/litegraph.js/src/nodes/interface.js ...
Parsing /media/dl/Data/Projects/litegraph.js/src/nodes/logic.js ...
Parsing /media/dl/Data/Projects/litegraph.js/src/nodes/math.js ...
Parsing /media/dl/Data/Projects/litegraph.js/src/nodes/math3d.js ...
Parsing /media/dl/Data/Projects/litegraph.js/src/nodes/midi.js ...
Parsing /media/dl/Data/Projects/litegraph.js/src/nodes/network.js ...
Parsing /media/dl/Data/Projects/litegraph.js/src/nodes/others.js ...
Parsing /media/dl/Data/Projects/litegraph.js/src/nodes/strings.js ...
DEBUG: Finished parsing source files.
DEBUG: Adding inherited symbols, mixins, and interface implementations...
DEBUG: Adding borrowed doclets...
DEBUG: Post-processing complete.
Generating output files...
Finished running in 1.50 seconds.

Expected behavior

Can it at least just ignore the ChainExpressions and continue documenting the rest of the code?

Current behavior

Currently just refuses to document any code that contains these expressions, which have been out for >2 years now.

Your environment

Linux Mint
Firefox
image
@daniel-lewis-ab
Copy link
Author

🤔 The screen cut off. The settings do include that it uses modules, rather than CommonJS.

daniel-lewis-ab pushed a commit to daniel-lewis-ab/litegraph.js that referenced this issue May 8, 2024
Last attempt to run JSDocs before running debug and figuring out why …
bb6bc74 
…they weren't working (ChainExpression as per jsdoc/jsdoc#2109
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@daniel-lewis-ab