Skip to content
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

Add 13.1 to CHANGELOG #2315

Merged
merged 1 commit into from
Jan 20, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,12 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
<!-- markdownlint-disable MD024 -->
<!-- markdownlint-disable MD004 -->

## [13.1.0] (2025-01-21)

### Added

- support a pair of long option flags to allow a memorable shortened flag, like `.option('--ws, --workspace')` ([#2312])

## [13.0.0] (2024-12-30)

### Added
Expand Down Expand Up @@ -74,6 +80,27 @@ program.action((options) => {
});
```

**Stricter option flag parsing**

Commander now throws an error for option flag combinations that are not supported.
In particular, a short flag with multiple characters is now an error.

```js
program.option('-ws, --workspace'); // throws error
```

A short option has a single character:

```js
program.option('-w, --workspace');
```

Or from Commander 13.1 you can have an extra long flag instead of a short flag to allow a more memorable shortcut for the full name:

```js
program.option('--ws, --workspace');
```

## [13.0.0-0] (2024-12-07)

(Released in 13.0.0)
Expand Down Expand Up @@ -1360,6 +1387,7 @@ program
[#2251]: https://github.com/tj/commander.js/pull/2251
[#2270]: https://github.com/tj/commander.js/pull/2270
[#2299]: https://github.com/tj/commander.js/pull/2299
[#2312]: https://github.com/tj/commander.js/pull/2312


<!-- Referenced in 5.x -->
Expand Down Expand Up @@ -1440,6 +1468,7 @@ program
[#1028]: https://github.com/tj/commander.js/pull/1028

[Unreleased]: https://github.com/tj/commander.js/compare/master...develop
[13.1.0]: https://github.com/tj/commander.js/compare/v13.0.0...v13.1.0
[13.0.0]: https://github.com/tj/commander.js/compare/v12.1.0...v13.0.0
[13.0.0-0]: https://github.com/tj/commander.js/compare/v12.1.0...v13.0.0-0
[12.1.0]: https://github.com/tj/commander.js/compare/v12.0.0...v12.1.0
Expand Down
Loading