Skip to content
Merged
Show file tree
Hide file tree
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
3 changes: 3 additions & 0 deletions packages/config/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,7 @@
# Changelog

## 0.7.1
- docs: Corrected BetterCommand references and links in README

## 0.7.0
- feat: Moved out the `config` library from the `cli_tools` package and into its own package, to be published as `config` on pub.dev.
10 changes: 6 additions & 4 deletions packages/config/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,8 @@ enabling direct use of the new features.

It achieves complete compatibility with the original package with the exception
of addCommand(), which you can replace with
[`BetterCommandRunner`](lib/src/better_command_runner/better_command_runner.dart).
[`BetterCommandRunner`](https://github.com/serverpod/cli_tools/blob/pkg-split/packages/cli_tools/lib/src/better_command_runner/better_command_runner.dart)
from the [`cli_tools package`](https://pub.dev/packages/cli_tools).

- **Compatibility**: The `ConfigParser` implements the same interface as
`ArgParser`, and returns a `ConfigResults` object that implements `ArgResults`.
Expand All @@ -70,7 +71,7 @@ of addCommand(), which you can replace with

- **Key Differences**:
- The `addCommand()` method is not supported
(see [`BetterCommandRunner`](lib/src/better_command_runner/better_command_runner.dart) instead)
(see [`BetterCommandRunner`](https://github.com/serverpod/cli_tools/blob/pkg-split/packages/cli_tools/lib/src/better_command_runner/better_command_runner.dart) instead)
- All validation is performed up-front with consistent error messages
- The parser supports additional configuration sources (environment variables, config files)

Expand Down Expand Up @@ -296,9 +297,10 @@ from the `args` package.
To use the config library with these, they need to be subclassed
to modify the use of `ArgParser` and introduce `Configuration`. This has
already been done for you, with the `BetterCommand` and `BetterCommandRunner`
classes in the `better_command_runner` library in this package.
classes in the `better_command_runner` library in the
[`cli_tools package`](https://pub.dev/packages/cli_tools).

See the full example [example/config_simple_example.dart](example/config_simple_example.dart).
See the full example [cli_tools/example/simple_command_example.dart](https://github.com/serverpod/cli_tools/blob/pkg-split/packages/cli_tools/example/simple_command_example.dart).

## Using configuration files

Expand Down
2 changes: 1 addition & 1 deletion packages/config/pubspec.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: config
version: 0.7.0
version: 0.7.1
description: A package for parsing command-line arguments and configuration files.
repository: https://github.com/serverpod/cli_tools
issue_tracker: https://github.com/serverpod/cli_tools/issues
Expand Down