Skip to content

Commit 59b4603

Browse files
committed
Update changelog
1 parent ff1602a commit 59b4603

File tree

1 file changed

+11
-6
lines changed

1 file changed

+11
-6
lines changed

CHANGELOG.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,15 @@
11
# Changelog
2+
## 4.0.0
3+
### Added
4+
- Added `Context.errorEncountered` which is true if parsing has continued after an error was encountered.
5+
- `option().help{""}` and `argument().help{""}` extensions that set the parameter's help text lazily, with access to the current context so that you can add colors.
6+
7+
### Changed
8+
- `Option.optionHelp` and `Argument.argumentHelp`, `CliktCommand.commandHelp`, and `CliktCommand.commandHelpEpilog` are now methods that take the context as an argument, and the `help` parameter to `copy` is now a `helpGetter` lambda. `CliktCommand.shortHelp` now takes the context as an argument.
9+
- The `message` method on `TransformContext` interfaces is now an extension.
10+
11+
### Deprecated
12+
- Deprecated `CliktCommand.commandHelp` and `commandHelpEpilog` properties in favor of the methods with the same name.
213

314
## 4.0.0-RC
415
### Added
@@ -15,7 +26,6 @@
1526
- Added `CliktCommand.allHelpParams()`, which can be overridden to change which parameters are displayed in help output
1627
- Added `Context.argumentFileReader` which allows custom loading of argument files
1728
- Added `Context.allowGroupedShortOptions` which can disable parsing `-abc` as `-a -b -c`
18-
- Added `Context.errorEncountered` which is true if parsing has continued after an error was encountered.
1929
- Options named `-?` or `/?` are now supported
2030
- Added `option(eager=true)` to create an eager option that takes values
2131
- Added `option(acceptsUnattachedValue=false)` to force the option to only accept values like `--option=1` and not `--option 1`
@@ -27,9 +37,6 @@
2737
- Removed legacy JS publications. Now only the JS/IR artifacts are published.
2838
- Removed `CliktHelpFormatter`. Use `MordantHelpFormatter` instead.
2939

30-
### Deprecated
31-
- Deprecated `CliktCommand.commandHelp` and `commandHelpEpilog` properties in favor of the methods with the same name.
32-
3340
### Changed
3441
- `prompt` and `confirm` are now implemented with mordant's prompt functionality, and the method parameters have changed to match mordant's
3542
- When using `treatUnknownOptionsAsArgs`, grouped short options like `-abc` will be treated as an argument rather than reporting an error as long as they don't match any short options in the command. ([#340](https://github.com/ajalt/clikt/pull/340))
@@ -43,8 +50,6 @@
4350
- `CliktError` now includes `statusCode` and `printError` properties.
4451
- The constructor of `UsageError` and its subclasses no longer takes a `context` parameter. The context is now inferred automatically.
4552
- `UsageError.formatUsage` now takes the localization and formatter as arguments
46-
- `Option.optionHelp` and `Argument.argumentHelp`, `CliktCommand.commandHelp`, and `CliktCommand.commandHelpEpilog` are now methods that take the context as an argument, and the `help` parameter to `copy` is now a `helpGetter` lambda. `CliktCommand.shortHelp` now takes the context as an argument.
47-
- The `message` method on `TransformContext` interfaces is now an extension.
4853

4954
### Fixed
5055
- When parsing a command line with more than one error, Clikt will now always report the error that occurs earliest if it can't report them all ([#361](https://github.com/ajalt/clikt/issues/361))

0 commit comments

Comments
 (0)