Pipeline uses JSDOCS now to generate files for js files #58
Conversation
This file contains 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
|
hmm it'd be nice if we didn't have to move the JS files out of the source folder |
SheepTester
approved these changes
Jun 10, 2023
| @@ -8,6 +8,7 @@ | |||
| "ecmaVersion": "latest", | |||
| "sourceType": "module" | |||
| }, | |||
| "ignorePatterns": ["/JSDOCS/scripts"], | |||
There was a problem hiding this comment.
could probably ignore the entirety of JSDOCS but this is fine too
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.
I think I got JSDOCS to work with our pipeline. I renamed all the javascript files to match what website they are for and moved them to a common folder (assets/scripts). It generates documentation for the js files in assets/scripts and outputs them into the JSDOCS folder.
Also for JSDOCS to produce documentation, the js files need JSDOC comments so add them to your js files if you haven't already.
close #50