Export InvalidOptionArgumentError in esm #1756
Merged
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
I upgraded a typescript project to native es modules and imported
`InvalidOptionArgumentError` was undefined at runtime, tho typescript
defined it as an alias to InvalidArgumentError.
```
import { InvalidOptionArgumentError } from 'commander'
// ^ No type error here, typescript thinks InvalidOptionArgumentError should exist
assert(InvalidOptionArgumentError != null); // But it doesn't, this will throw an error
```
A quick test showed that there was a difference between the commonjs and
ecmascript module. The issue wasn't limited to typescript.
```
const { InvalidOptionArgumentError } = require('commander')
assert(InvalidOptionArgumentError != null);
```
```
import { InvalidOptionArgumentError } from 'commander'
assert(InvalidOptionArgumentError != null); // This will throw an error
```
This commit fixes the issue by exporting InvalidOptionArgumentError from
the esm entry point. Alternatively we could remove
InvalidOptionArgumentError from typings, I'm happy as long as build and
runtime match.
|
The esm export got dropped/renamed in #1508 when |
shadowspawn
requested changes
Jun 18, 2022
Co-authored-by: John Gee <john@ruru.gen.nz>
|
Looks like there was an indentation boobytrap in the suggestion I made, sorry about that! |
shadowspawn
approved these changes
Jun 19, 2022
|
(Pushed indentation fix.) |
shadowspawn
added
the
pending release
|
Thanks @everett1992 |
|
Released in Commander v9.4.0 |
shadowspawn
removed
the
pending release
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.
After upgrading a typescript project to native es modules imports for
InvalidOptionArgumentErrorwere undefined at runtime butdefined in typescript as an alias to InvalidArgumentError.
A quick test showed that there was a difference between the commonjs and
ecmascript module. The issue wasn't limited to typescript.
This commit fixes the issue by exporting InvalidOptionArgumentError from
the esm entry point. Alternatively we could remove
InvalidOptionArgumentError from typings, I'm happy as long as build and
runtime match.