Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/invertase/spec
✅ A streamlined testing framework for Dart & Flutter.
https://github.com/invertase/spec
cli dart flutter hacktoberfest testing
Last synced: 7 days ago
JSON representation
✅ A streamlined testing framework for Dart & Flutter.
- Host: GitHub
- URL: https://github.com/invertase/spec
- Owner: invertase
- License: apache-2.0
- Created: 2021-06-14T14:50:29.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-03-10T13:53:36.000Z (10 months ago)
- Last Synced: 2024-12-16T16:06:58.600Z (12 days ago)
- Topics: cli, dart, flutter, hacktoberfest, testing
- Language: Dart
- Homepage: https://docs.page/invertase/spec
- Size: 2.34 MB
- Stars: 302
- Watchers: 9
- Forks: 18
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
✅ Spec
A streamlined testing framework for Dart & Flutter.
## What is it?
Spec builds on-top of existing Dart & Flutter testing tools to provide a streamlined & elegant testing environment. Spec provides both a CLI tool
and Dart package.
- [Documentation](https://docs.page/invertase/spec)
### CLI
The Spec CLI allows you to run the `spec` command from your CLI environment and run your tests:
- Intuitive testing output interface, inspired by [Jest](https://jestjs.io/).
- Interactive CLI (via `spec --watch`); automatically re-run tests when source code changes & rerunning of only failed tests.
- Run both Dart & Flutter tests in parallel with a single command.
- Run tests from multiple packages at the same time using [Melos](https://github.com/invertase/melos).
### Package
The `spec` package provides a different take on how to write tests. Designed with type-safety and IDE autocompletion in mind, spec alters the way you
write your tests to be more declarative, less error prone and force good habits.
## Getting Started
### Matchers
Spec CLI works alongside normal Dart `test` matchers, however also ships with custom matchers, see the [API reference docs](https://pub.dev/documentation/spec/latest/spec/spec-library.html).
**Example of testing using Spec matchers**:
```dart
import 'package:spec/spec.dart';
void main() {
test('future example', () async {
final future = Future.value(42);
expect(future).toEqual(future);
await expect(future).completion.toEqual(42);
await expect(future).throws.isArgumentError();
});
test('stream example', () async {
final stream = Stream.value(42);
await expect(stream).emits.toEqual(42);
await expect(stream).emits.isNull();
await expect(stream).emits.not.isNull();
await expect(stream).emitsError.isArgumentError();
});
test('function example', () {
void throwsFn() => throw Error();
expect(throwsFn).returnsNormally();
expect(throwsFn).throws.isArgumentError();
});
}
```
### CLI
#### Installation
```bash
dart pub global activate spec_cli
```
#### Usage
**Run tests**:
```bash
spec
```
**Run tests in interactive mode**:
```bash
spec --watch
```
Interactive mode supports a number of keyboard shortcuts:
```
Watch Usage:
› Press f to run only failed tests.
› Press t to filter by a test name regex pattern.
› Press q to quit watch mode.
› Press Enter to trigger a test run.
```
### GitHub Action
If you want to use Spec in your GitHub actions pipeline you can utilize the
[Spec GitHub action](https://github.com/marketplace/actions/spec-action), instructions for
how to use it can be found on the the `spec-action`'s marketplace page and in its
[repository](https://github.com/bluefireteam/spec-action).
---
[LICENSE](/LICENSE)
Built and maintained by Invertase.