WidgetDriver

A Flutter presentation layer framework, which will clean up your
widget code and make your widgets testable without the need for thousands of mock objects.
Let's go driving! 🚙💨

The WidgetDriver framework is built up on different dart packages. The core package which contains the actual framework is the widget_driver. Then there are some helper packages which support with code generation and making testing easier.

Here is an overview of all the packages:

widget_driver

Source code

The core package which provides the WidgetDriver framework.

Import it into your pubspec dependencies: section.

widget_driver_generator

Source code

The package providing generators to automate the creation of your TestDrivers and WidgetDriverProviders.

Import it into your pubspec dev_dependencies: section.

widget_driver_annotation

Source code

The annotation package which has no dependencies.

You do not need to import this since the widget_driver package already imports it for you.
But if you need/want to import it then import it into your pubspec dependencies: section.

widget_driver_test

Source code

Contains helper classes/methods to support with:

Testing your DrivableWidgets
Testing your WidgetDrivers
Mocking your TestDrivers

Import it into your pubspec dev_dependencies: section.

example

Source code

A Flutter example app showing how to set up all dependencies and how to use the WidgetDriver framework and how to test your widgets and drivers.

Contribute

So you're thinking about supporting us and contributing to the WidgetDriver package. That's great 😀

The first step is to read our contributing guide.

Helpful commands

Makefile file located in the repository root can give you an insight of all available targets which can help you in your development.

Following Makefile targets are available in the project:

all                  Run all steps including building the Android and iOS
build                Run all steps including building the Android and iOS example apps from the widget_driver project
build_android        Run the Android build of the example app (located inside `widget_driver/example`) without deploying to any device
build_ios            Run the iOS build of the example app (located inside `widget_driver/example`) without deploying to any device
clean                Clean all the cache and dependencies from dart modules.
format               Format all Dart files in the project with the line length set to 120
help                 Show all commands
install              Fetch all dependencies for all packages
lint                 Run flutter lint in all projects
quality              Run only linter and tests
test                 Run all tests in all projects

publish to pub.dev

To make the plugins accessible, we want to publish them to pub.dev. For each plugin, publish-PLUGIN.yaml contains a job that deploys it to pub.dev. They are triggered manually.

devmil/widget_driver