ferry_generator

Install package

flutter pub add ferry_generator

Package Overview

Package selection guidance compiled from public package information, community data, and project usage.

Ferry Generator is a code generation tool for the Ferry GraphQL client, designed to create type-safe Dart classes from GraphQL operations. It simplifies working with GraphQL by automatically generating models, queries, mutations, and subscriptions based on schema and query files. This reduces boilerplate and minimizes runtime errors by ensuring types align with the GraphQL API. The generator integrates seamlessly into Flutter projects and supports multiple platforms including Android, iOS, macOS, Windows, and Linux.

Use cases

Automatically generate GraphQL operation types
Create type-safe models from GraphQL schema
Simplify mutation and query handling in Flutter apps
Enable compile-time validation of GraphQL operations
Support cross-platform GraphQL clients

Key features

Generates Dart classes from GraphQL files
Ensures type safety for GraphQL operations
Integrates with Ferry client
Supports queries, mutations, and subscriptions
Produces minimal boilerplate code

Suitable for

Flutter developers using Ferry GraphQL client
Teams prioritizing type safety in GraphQL usage
Projects requiring efficient GraphQL code generation
Apps targeting multiple platforms with shared GraphQL logic
Developers seeking reduced manual code maintenance

Considerations

Requires a GraphQL schema and operation files
Depends on Ferry client for runtime functionality
Needs proper setup in pubspec.yaml
May require additional configuration for complex schemas
Best used in conjunction with Ferry's runtime library

Original README

Original README snapshot from the linked source repository. Visit the repository for the latest content.

A simple, powerful GraphQL Client for Flutter and Dart

Documentation 📖

Features

✅ Fully Typed: work faster and safer with compile time checks and IDE autocomplete, including fully typed Cache reads and writes.
🔄 Built-In Code Generators: automatically generated immutable data classes for all your GraphQL Operations and Fragments, based on your schema.
🌐 Customizable Network Interface: highly customizable network interface using gql_link, allowing you to compose and extend Links.
✨ Normalized Optimistic Cache: keep data in sync with cache normalization and update your UI instantly with optimistic data.
💾 Multiple Data Stores: extensible Store interface with built-in MemoryStore and HiveStore (which uses hive for offline persistence).
📄 Refetch & Pagination: easily update responses with new data or combine multiple responses, allowing for seamless pagination.
📱 Flutter Widgets: Widgets for Queries, Mutations, and Subscriptions, available out of the box.
🧈 Smooth: Run queries in a separate Isolate to free up resources on the UI thread

Packages

This repo is a monorepo for ferry and related packages.

Pub	Package	Description
	`package:ferry`	Stream-based GraphQL Client
	`package:ferry_cache`	Normalized, strongly typed, optimistic cache
	`package:ferry_exec`	Strongly typed GraphQL execution interface
	`package:ferry_flutter`	Flutter Widgets for GraphQL Operations
	`package:ferry_generator`	Dart Type Generator for GraphQL Operations
	`package:ferry_store`	Data Persistence for `ferry`'s cache
	`package:ferry_hive_store`	Hive implementation of `ferry_store`
	`package:normalize`	Normalization / denormalization of GraphQL data