-
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Remove default export of global program #2017
Merged
shadowspawn
merged 2 commits into
tj:release/12.x
from
shadowspawn:feature/remove-default-export-of-global-program
Sep 15, 2023
Merged
Remove default export of global program #2017
shadowspawn
merged 2 commits into
tj:release/12.x
from
shadowspawn:feature/remove-default-export-of-global-program
Sep 15, 2023
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
abetomo
approved these changes
Sep 15, 2023
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
+1
Vylpes
pushed a commit
to Vylpes/random-bunny
that referenced
this pull request
Apr 10, 2024
This PR contains the following updates: | Package | Type | Update | Change | |---|---|---|---| | [commander](https://github.com/tj/commander.js) | dependencies | major | [`^11.1.0` -> `^12.0.0`](https://renovatebot.com/diffs/npm/commander/11.1.0/12.0.0) | --- ### Release Notes <details> <summary>tj/commander.js (commander)</summary> ### [`v12.0.0`](https://github.com/tj/commander.js/blob/HEAD/CHANGELOG.md#1200-2024-02-03) [Compare Source](tj/commander.js@v11.1.0...v12.0.0) ##### Added - `.addHelpOption()` as another way of configuring built-in help option (\[[#​2006](tj/commander.js#2006)]) - `.helpCommand()` for configuring built-in help command (\[[#​2087](tj/commander.js#2087)]) ##### Fixed - *Breaking:* use non-zero exit code when spawned executable subcommand terminates due to a signal (\[[#​2023](tj/commander.js#2023)]) - *Breaking:* check `passThroughOptions` constraints when using `.addCommand` and throw if parent command does not have `.enablePositionalOptions()` enabled (\[[#​1937](tj/commander.js#1937)]) ##### Changed - *Breaking:* Commander 12 requires Node.js v18 or higher (\[[#​2027](tj/commander.js#2027)]) - *Breaking:* throw an error if add an option with a flag which is already in use (\[[#​2055](tj/commander.js#2055)]) - *Breaking:* throw an error if add a command with name or alias which is already in use (\[[#​2059](tj/commander.js#2059)]) - *Breaking:* throw error when calling `.storeOptionsAsProperties()` after setting an option value (\[[#​1928](tj/commander.js#1928)]) - replace non-standard JSDoc of `@api private` with documented `@private` (\[[#​1949](tj/commander.js#1949)]) - `.addHelpCommand()` now takes a Command (passing string or boolean still works as before but deprecated) (\[[#​2087](tj/commander.js#2087)]) - refactor internal implementation of built-in help option (\[[#​2006](tj/commander.js#2006)]) - refactor internal implementation of built-in help command (\[[#​2087](tj/commander.js#2087)]) ##### Deprecated - `.addHelpCommand()` passing string or boolean (use `.helpCommand()` or pass a Command) (\[[#​2087](tj/commander.js#2087)]) ##### Removed - *Breaking:* removed default export of a global Command instance from CommonJS (use the named `program` export instead) (\[[#​2017](tj/commander.js#2017)]) ##### Migration Tips **global program** If you are using the [deprecated](./docs/deprecated.md#default-import-of-global-command-object) default import of the global Command object, you need to switch to using a named import (or create a new `Command`). ```js // const program = require('commander'); const { program } = require('commander'); ``` **option and command clashes** A couple of configuration problems now throw an error, which will pick up issues in existing programs: - adding an option which uses the same flag as a previous option - adding a command which uses the same name or alias as a previous command </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Renovate Bot](https://github.com/renovatebot/renovate). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4wLjAiLCJ1cGRhdGVkSW5WZXIiOiIzNy4wLjAiLCJ0YXJnZXRCcmFuY2giOiJkZXZlbG9wIn0=--> Reviewed-on: https://gitea.vylpes.xyz/RabbitLabs/random-bunny/pulls/145 Reviewed-by: Vylpes <ethan@vylpes.com> Co-authored-by: Renovate Bot <renovate@vylpes.com> Co-committed-by: Renovate Bot <renovate@vylpes.com>
This was referenced May 26, 2024
This was referenced Jun 6, 2024
This was referenced Jun 19, 2024
This was referenced Jul 16, 2024
This was referenced Aug 16, 2024
Open
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.
Pull Request
Problem
We have been slowly moving towards removing the default export of global Command instance. Already removed from the README, removed from the TypeScript, and omitted from the esm interface.
Recently observed some problems due to the legacy export: #2013 #2014
Deprecation:
commander.js/docs/deprecated.md
Lines 41 to 60 in 4ef19fa
Issue: #2016
Solution
Remove from the CommonJS exports too!
ChangeLog
program
export instead)