|
1 | 1 | # 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. |
2 | 13 |
|
3 | 14 | ## 4.0.0-RC
|
4 | 15 | ### Added
|
|
15 | 26 | - Added `CliktCommand.allHelpParams()`, which can be overridden to change which parameters are displayed in help output
|
16 | 27 | - Added `Context.argumentFileReader` which allows custom loading of argument files
|
17 | 28 | - 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. |
19 | 29 | - Options named `-?` or `/?` are now supported
|
20 | 30 | - Added `option(eager=true)` to create an eager option that takes values
|
21 | 31 | - Added `option(acceptsUnattachedValue=false)` to force the option to only accept values like `--option=1` and not `--option 1`
|
|
27 | 37 | - Removed legacy JS publications. Now only the JS/IR artifacts are published.
|
28 | 38 | - Removed `CliktHelpFormatter`. Use `MordantHelpFormatter` instead.
|
29 | 39 |
|
30 |
| -### Deprecated |
31 |
| -- Deprecated `CliktCommand.commandHelp` and `commandHelpEpilog` properties in favor of the methods with the same name. |
32 |
| - |
33 | 40 | ### Changed
|
34 | 41 | - `prompt` and `confirm` are now implemented with mordant's prompt functionality, and the method parameters have changed to match mordant's
|
35 | 42 | - 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 | 50 | - `CliktError` now includes `statusCode` and `printError` properties.
|
44 | 51 | - The constructor of `UsageError` and its subclasses no longer takes a `context` parameter. The context is now inferred automatically.
|
45 | 52 | - `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. |
48 | 53 |
|
49 | 54 | ### Fixed
|
50 | 55 | - 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