Skip to content

Minor readme improvements #1913

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

Merged
merged 1 commit into from
Feb 7, 2023
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
2 changes: 2 additions & 0 deletions pkgs/checks/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# 0.2.1-dev

# 0.2.0

- **Breaking Changes**
Expand Down
8 changes: 7 additions & 1 deletion pkgs/checks/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ value - for instance reading a field or awaiting the result of a Future.

```dart
check(someString).length.equals(expectedLength);
(await check(someFuture).completes()).equals(expectedCompletion);
await check(someFuture).completes(it()..equals(expectedCompletion));
```

Fields can be extracted from objects for checking further properties with the
Expand Down Expand Up @@ -102,3 +102,9 @@ extension CustomChecks on Subject<CustomType> {
Subject<Bar> get someField => has((a) => a.someField, 'someField');
}
```

# Migrating from `matcher` (`expect`) expectations

See the [migration guide][].

[migration guide]:https://github.com/dart-lang/test/blob/master/pkgs/checks/doc/migrating_from_matcher.md
2 changes: 1 addition & 1 deletion pkgs/checks/pubspec.yaml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
name: checks
version: 0.2.0
version: 0.2.1-dev
description: >-
A framework for checking values against expectations and building custom
expectations.
Expand Down