Skip to content

Commit

Permalink
fix(deps): update dependency commander to v12 (#286)
Browse files Browse the repository at this point in the history
[![Mend
Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com)

This PR contains the following updates:

| Package | Change | Age | Adoption | Passing | Confidence |
|---|---|---|---|---|---|
| [commander](https://github.com/tj/commander.js) | [`^11.1.0` ->
`^12.0.0`](https://renovatebot.com/diffs/npm/commander/11.1.0/12.0.0) |
[![age](https://developer.mend.io/api/mc/badges/age/npm/commander/12.0.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![adoption](https://developer.mend.io/api/mc/badges/adoption/npm/commander/12.0.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![passing](https://developer.mend.io/api/mc/badges/compatibility/npm/commander/11.1.0/12.0.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|
[![confidence](https://developer.mend.io/api/mc/badges/confidence/npm/commander/11.1.0/12.0.0?slim=true)](https://docs.renovatebot.com/merge-confidence/)
|

---

### 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](https://github.com/tj/commander.js/compare/v11.1.0...v12.0.0)

##### Added

- `.addHelpOption()` as another way of configuring built-in help option
(\[[#&#8203;2006](https://github.com/tj/commander.js/issues/2006)])
- `.helpCommand()` for configuring built-in help command
(\[[#&#8203;2087](https://github.com/tj/commander.js/issues/2087)])

##### Fixed

- *Breaking:* use non-zero exit code when spawned executable subcommand
terminates due to a signal
(\[[#&#8203;2023](https://github.com/tj/commander.js/issues/2023)])
- *Breaking:* check `passThroughOptions` constraints when using
`.addCommand` and throw if parent command does not have
`.enablePositionalOptions()` enabled
(\[[#&#8203;1937](https://github.com/tj/commander.js/issues/1937)])

##### Changed

- *Breaking:* Commander 12 requires Node.js v18 or higher
(\[[#&#8203;2027](https://github.com/tj/commander.js/issues/2027)])
- *Breaking:* throw an error if add an option with a flag which is
already in use
(\[[#&#8203;2055](https://github.com/tj/commander.js/issues/2055)])
- *Breaking:* throw an error if add a command with name or alias which
is already in use
(\[[#&#8203;2059](https://github.com/tj/commander.js/issues/2059)])
- *Breaking:* throw error when calling `.storeOptionsAsProperties()`
after setting an option value
(\[[#&#8203;1928](https://github.com/tj/commander.js/issues/1928)])
- replace non-standard JSDoc of `@api private` with documented
`@private`
(\[[#&#8203;1949](https://github.com/tj/commander.js/issues/1949)])
- `.addHelpCommand()` now takes a Command (passing string or boolean
still works as before but deprecated)
(\[[#&#8203;2087](https://github.com/tj/commander.js/issues/2087)])
- refactor internal implementation of built-in help option
(\[[#&#8203;2006](https://github.com/tj/commander.js/issues/2006)])
- refactor internal implementation of built-in help command
(\[[#&#8203;2087](https://github.com/tj/commander.js/issues/2087)])

##### Deprecated

- `.addHelpCommand()` passing string or boolean (use `.helpCommand()` or
pass a Command)
(\[[#&#8203;2087](https://github.com/tj/commander.js/issues/2087)])

##### Removed

- *Breaking:* removed default export of a global Command instance from
CommonJS (use the named `program` export instead)
(\[[#&#8203;2017](https://github.com/tj/commander.js/issues/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 [Mend
Renovate](https://www.mend.io/free-developer-tools/renovate/). View
repository job log
[here](https://developer.mend.io/github/probot/smee-client).

<!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNy4xNTMuMiIsInVwZGF0ZWRJblZlciI6IjM3LjE1My4yIiwidGFyZ2V0QnJhbmNoIjoibWFzdGVyIn0=-->

---------

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: uzlopak <[email protected]>
  • Loading branch information
renovate[bot] and Uzlopak authored Feb 3, 2024
1 parent 3662ad3 commit aa8f7ea
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 7 deletions.
2 changes: 1 addition & 1 deletion bin/smee.js
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#!/usr/bin/env node

const program = require('commander')
const { program } = require('commander')
const { version } = require('../package.json')

const Client = require('..')
Expand Down
10 changes: 5 additions & 5 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@
"author": "",
"license": "ISC",
"dependencies": {
"commander": "^11.1.0",
"commander": "^12.0.0",
"eventsource": "^2.0.2",
"validator": "^13.11.0"
},
Expand Down

0 comments on commit aa8f7ea

Please sign in to comment.