fix(index): skip version checks for false boolean options#546
Merged
Conversation
There was a problem hiding this comment.
Pull request overview
This PR fixes a bug where version checks were unnecessarily performed on boolean options set to false, even though these options are never passed to the underlying UnRTF binary. The fix provides both correctness (avoiding spurious version errors) and a minor performance improvement by skipping redundant validation.
Changes:
- Modified
parseOptionsfunction to skip version validation for boolean options set tofalse - Added test coverage for both minVersion and maxVersion scenarios with false boolean options
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| src/index.js | Updated parseOptions to use early continue for false boolean options, skipping both argument addition and version checks |
| test/index.test.js | Added two test cases verifying that false boolean options don't trigger version constraint errors on incompatible binary versions |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
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.
Boolean options set to
falseare never passed to the underlying binary, so it is redundant doing version checking on them and throwing errors.Probably a tiny performance boost in here as well.
Checklist
npm test