chore: upgrade jsdoc to latest to support node 23+#2009
Closed
chore: upgrade jsdoc to latest to support node 23+#2009
Conversation
|
balzss
reviewed
Jun 4, 2025
| ] | ||
| ], | ||
| "dependencies": { | ||
| "clipboardy": "^4.0.0" |
matyasf
requested changes
Jun 4, 2025
Collaborator
matyasf
left a comment
matyasf
left a comment
There was a problem hiding this comment.
Looks OK, but see my comment about adding a comment. I'm not 100% convinced that this is the right way to do it, but it gets the job done for now
Comment on lines
+62
to
+70
| onListening: async function () { | ||
| // devServer is watching source files by default and hot reloading the docs page if they are changed | ||
| // however markdown files (i.e. README.md) need to be recompiled hence the need for chokidar | ||
| const paths = globbySync(['packages/**/*.md', 'docs/**/*.md'], { cwd: '../../' }).map(p => '../../' + p) | ||
| chokidar | ||
| .watch(paths) | ||
| .on('change', (evt) => { | ||
| .on('change', async (evt) => { | ||
| const fullPath = resolvePath(import.meta.dirname, evt) | ||
| processSingleFile(fullPath) | ||
| await processSingleFile(fullPath) |
Collaborator
There was a problem hiding this comment.
Both the Webpack onListening https://webpack.js.org/configuration/dev-server/#devserveronlistening
and Chokidar's on https://github.com/paulmillr/chokidar are not async.
I think this should work fine for 99% of use cases (unless you somehow modify the same file in very quick succession?) but please put a comment to both functions, that these do not wait for the promise to return.
Contributor
Author
|
Dulicate |
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
3 participants
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.
TEST_PLAN: check if everything works in docs with latest(24.x) and older(20.x) node
INSTUI-4574