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:

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

Contributions

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

Libraries

gg