https://github.com/piotrfleury/discover
Find every source not covered by tests in your Flutter project.
https://github.com/piotrfleury/discover
Last synced: 29 days ago
JSON representation
Find every source not covered by tests in your Flutter project.
- Host: GitHub
- URL: https://github.com/piotrfleury/discover
- Owner: PiotrFLEURY
- License: bsd-3-clause
- Created: 2025-03-30T15:03:47.000Z (about 1 month ago)
- Default Branch: main
- Last Pushed: 2025-04-09T09:10:57.000Z (about 1 month ago)
- Last Synced: 2025-04-09T10:29:13.917Z (about 1 month ago)
- Language: Dart
- Size: 298 KB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
## discover
[![style: very good analysis][very_good_analysis_badge]][very_good_analysis_link]
Generated by the [Very Good CLI][very_good_cli_link] 🤖
An uncovered sources discovery CLI created by Very Good CLI.
Find every source not covered by tests in your Flutter project.
---
## Getting Started 🚀
If the CLI application is available on [pub](https://pub.dev), activate globally via:
```sh
dart pub global activate discover
```
Or locally via:
```sh
dart pub global activate --source=path
```
> 🚨 Note 🚨
>
> An issue prevents from updating the CLI using local path.
>
> If you want to update the CLI, you need to remove `.dart_tool` directory before running the command again.
> See [issue 4295](https://github.com/dart-lang/pub/issues/4295)
## Usage
### Perform coverage scan
```sh
# Scan command
$ discover scan
# Scan command option
$ discover scan --path
```
### Tooling commands
```sh
# Show CLI version
$ discover --version
# Show usage help
$ discover --help
```
### Ignore files
You can ignore files by creating a `.discoverignore` file in the root of your project.
```
|-- android
|-- ios
|-- lib
|-- linux
|-- macos
|-- test
|-- windows
|-- .discoverignore
```
Sample `.discoverignore` file:
```
lib/**/*.g.dart
lib/**/*.freezed.dart
lib/view/**/*.dart
```
## 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