https://github.com/piotrfleury/golden_cli
A Dart CLI made to help with multi plaform Golden comparisons in Flutter.
https://github.com/piotrfleury/golden_cli
Last synced: 3 months ago
JSON representation
A Dart CLI made to help with multi plaform Golden comparisons in Flutter.
- Host: GitHub
- URL: https://github.com/piotrfleury/golden_cli
- Owner: PiotrFLEURY
- License: bsd-3-clause
- Created: 2024-03-31T12:57:49.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-06-25T17:36:51.000Z (11 months ago)
- Last Synced: 2024-12-28T05:25:35.736Z (4 months ago)
- Language: Dart
- Size: 94.7 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
## golden_cli
[![style: very good analysis][very_good_analysis_badge]][very_good_analysis_link]
Generated by the [Very Good CLI][very_good_cli_link] 🤖
A Dart CLI made to help with multi platform Golden comparisons in Flutter.
---
## Getting Started 🚀
If the CLI application is available on [pub](https://pub.dev), activate globally via:
```sh
dart pub global activate golden_cli
```
Or locally via:
```sh
dart pub global activate --source=path
```
## Usage
```sh
# Execute golden test using main branch as reference
$ golden test
# cleanup
$ golden clean
# generate golden files
$ golden gen
# get goldens without generating them
$ golden get
# Using a specific branch
$ golden test -r feature/branch
$ golden clean -r feature/branch
$ golden gen -r feature/branch
$ golden get -r feature/branch
# Show CLI version
$ golden --version
# Show usage help
$ golden --help
```
## Running Tests with coverage 🧪
To run all unit tests use the following command:
```sh
$ dart pub global activate coverage 1.2.0
$ dart test --coverage=coverage
$ dart pub global run coverage:format_coverage --lcov --in=coverage --out=coverage/lcov.info
```
To view the generated coverage report you can use [lcov](https://github.com/linux-test-project/lcov)
.
```sh
# Generate Coverage Report
$ genhtml coverage/lcov.info -o coverage/
# Open Coverage Report
$ open coverage/index.html
```
---
[very_good_analysis_badge]: https://img.shields.io/badge/style-very_good_analysis-B22C89.svg
[very_good_analysis_link]: https://pub.dev/packages/very_good_analysis
[very_good_cli_link]: https://github.com/VeryGoodOpenSource/very_good_cli