chore: fix JavaScript lint errors (issue #13273)#13278
Open
TrivCodez wants to merge 1 commit into
Open
Conversation
The `stdlib/jsdoc-doctest` ESLint rule executes @example code in a VM. The async rename example calls `rename('./beep/boop.txt', './beep/foo.txt', done)` with a callback that throws the error. Since fs.rename is async, the callback fires after the VM context is gone, causing an unhandled Node.js exception that kills the ESLint process. Fix: change the error handling in examples from `throw` to `console.error(message)`, matching the pattern used by @stdlib/fs/unlink. resolves stdlib-js#13273
stdlib-bot
added
Needs Review
Contributor
|
Hello! Thank you for your contribution to stdlib. We noticed that the contributing guidelines acknowledgment is missing from your pull request. Here's what you need to do:
This acknowledgment confirms that you've read the guidelines, which include:
We can't review or accept contributions without this acknowledgment. Thank you for your understanding and cooperation. We look forward to reviewing your contribution! |
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
2 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.
Description
This PR fixes an ESLint crash caused by the
stdlib/jsdoc-doctestrule when linting@stdlib/fs/rename/lib/index.js. Thejsdoc-doctestrule runs JSDoc@examplecode in a VM context. The asyncrename()example usedthrow errorin the callback, which, when the rename operation failed withENOENT(file doesn't exist), threw an unhandled exception that crashed the ESLint process.Changes
lib/node_modules/@stdlib/fs/rename/lib/index.js: Changed@examplecallbacks to useconsole.error(error.message)instead ofthrow error/throw err, matching the convention used by similar packages (e.g.,@stdlib/fs/unlink,@stdlib/fs/exists).This crash blocked ESLint from checking approximately 8 additional JavaScript files in the lint run.
resolves #13273