Skip to content

Commit 3c5180c

Browse files
docs(config): Corrected BetterCommand refs in README for patch 0.7.1 (#59)
1 parent 6b6ff27 commit 3c5180c

File tree

3 files changed

+10
-5
lines changed

3 files changed

+10
-5
lines changed

packages/config/CHANGELOG.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,7 @@
11
# Changelog
22

3+
## 0.7.1
4+
- docs: Corrected BetterCommand references and links in README
5+
36
## 0.7.0
47
- feat: Moved out the `config` library from the `cli_tools` package and into its own package, to be published as `config` on pub.dev.

packages/config/README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,8 @@ enabling direct use of the new features.
5555

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

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

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

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

301-
See the full example [example/config_simple_example.dart](example/config_simple_example.dart).
303+
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).
302304

303305
## Using configuration files
304306

packages/config/pubspec.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name: config
2-
version: 0.7.0
2+
version: 0.7.1
33
description: A package for parsing command-line arguments and configuration files.
44
repository: https://github.com/serverpod/cli_tools
55
issue_tracker: https://github.com/serverpod/cli_tools/issues

0 commit comments

Comments
 (0)