gg 3.0.23 copy "gg: ^3.0.23" to clipboard
gg: ^3.0.23 copied to clipboard

A collection of checks and actions like analyzing, linting, testing, code coverage, committing, pushing, publishing.

gg #

gg is a Dart package designed to streamline your development workflow by offering a suite of pre-commit checks. These include code analysis, linting, testing, and coverage verification, all complemented by highly optimized and colorized error messages.

Key Features #

  • Precise Colorized Error Messages: Get detailed feedback with error messages that are both precise and easy to understand, enhanced with color for better readability.
  • Optimized for VSCode: Error messages are tailored for display in Visual Studio Code, ensuring a seamless integration into your development environment.
  • Enforces 100% Code Coverage: Achieve and maintain high-quality code with enforced 100% test coverage for your codebase.
  • GitHub Action Integration: Easily integrate gg with GitHub Actions to automate your testing workflow directly within GitHub.

Preparation #

Install required tools #

  • dart global activate pana

Create a New Library Project #

dart create -t package hello_world
cd hello_world

Add gg as a Development Dependency #

Enhance your project with gg by adding it as a development dependency:

dart pub add --dev gg

Discover gg Commands #

Learn about the available commands and their applications:

dart pub run gg -h

Execute All Tests and Checks #

dart run gg all

Fix the issues #

Address issues identified by gg, aiming for a clean, error-free codebase..

Ensure Comprehensive Code Coverage #

gg demands excellence in testing:

  • Achieve 100% Code Coverage: Mandatory complete test coverage for all code.
  • Review Short and Precise Coverage Reports: Analyze uncovered lines and their corresponding tests.
  • Maintain Mandatory Test Files: Ensure each implementation file has a dedicated test file achieving 100% coverage.

Exclude lines from code that should be excluded from code coverage:

// coverage:ignore-line
// coverage:ignore-start
// coverage:ignore-end

Set Up GitHub Action for Automated Checks #

Automate your testing process by setting up the gg GitHub Action, like here:

https://github.com/inlavigo/gg/blob/main/.github/workflows/pipeline.yaml

Contributions #

Report your errors and contributions to https://github.com/inlavigo/gg.

1
likes
160
points
1k
downloads

Publisher

verified publisherinlavigo.com

Weekly Downloads

A collection of checks and actions like analyzing, linting, testing, code coverage, committing, pushing, publishing.

Repository (GitHub)

Documentation

API reference

License

MIT (license)

Dependencies

args, gg_args, gg_capture_print, gg_changelog, gg_console_colors, gg_direct_json, gg_git, gg_is_flutter, gg_is_github, gg_log, gg_process, gg_publish, gg_status_printer, gg_test, gg_version, matcher, meta, mocktail, path, pub_semver, recase, yaml, yaml_edit

More

Packages that depend on gg