https://github.com/lual98/widgetbook_golden_test

Library to run golden tests for declared Widgetbook cases
https://github.com/lual98/widgetbook_golden_test

flutter flutter-testing golden-tests widgetbook

Last synced: about 2 months ago
JSON representation

Library to run golden tests for declared Widgetbook cases

• Host: GitHub
• URL: https://github.com/lual98/widgetbook_golden_test
• Owner: lual98
• License: mit
• Created: 2025-08-15T22:56:10.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2026-02-02T20:24:28.000Z (about 2 months ago)
• Last Synced: 2026-02-03T10:36:21.674Z (about 2 months ago)
• Topics: flutter, flutter-testing, golden-tests, widgetbook
• Language: Dart
• Homepage:
• Size: 3.41 MB
• Stars: 4
• Watchers: 1
• Forks: 1
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# Widgetbook Golden Test

[![codecov](https://codecov.io/github/lual98/widgetbook_golden_test/graph/badge.svg?token=UK9N7GQJ7H)](https://codecov.io/github/lual98/widgetbook_golden_test)

A monorepo containing tools to automatically generate Flutter golden tests from [Widgetbook](https://widgetbook.io) use cases.

## Repository Structure

This repository uses a workspace-based monorepo structure:

| Package | Description |

| --- | --- |

| [`widgetbook_golden_test`](packages/widgetbook_golden_test) | The main package for end-users. Provides easy-to-use functions for running golden tests. |

| [`widgetbook_golden_test_core`](packages/widgetbook_golden_test_core) | The core engine used by `widgetbook_golden_test`. Contains the rendering and mocking logic. |

| [`widgetbook_golden_test_alchemist`](packages/widgetbook_golden_test_alchemist) | The Alchemist package for end-users. Provides easy-to-use functions for running golden tests. |

## Getting Started

To get started with automatic golden test generation, it is recommended to use the [`widgetbook_golden_test`](packages/widgetbook_golden_test) package.

### Prerequisites

- A Flutter project using [Widgetbook](https://pub.dev/packages/widgetbook).

- [widgetbook_generator](https://pub.dev/packages/widgetbook_generator) configured in your project.

### Installation

Add `widgetbook_golden_test` to your `dev_dependencies`:

```yaml

dev_dependencies:

  widgetbook_golden_test: ^latest_version

```

## How It Works

1. **Write Use Cases**: Annotate your widgets with `@UseCase` as usual.

2. **Generate Directories**: Run `dart run build_runner build -d` to generate your Widgetbook directories.

3. **Run Golden Tests**: Create a test file that calls `runWidgetbookGoldenTests` with the generated directories.

Visual regression testing becomes zero-effort once your Widgetbook is set up!

## License

[MIT](LICENSE)