Flutter Rules for Windsurf, Cursor, and Other AI-Powered IDEs

⚡ TLDR

If you want to use .cursor/rules or .windsurfrules, just copy the contents of the rule set of your choice (e.g., combined/flutter_dart__under_6K.md) into your IDE’s global or local rules.
For maximum control, you can also copy the /rules folder into your project and reference rules as needed (e.g., "Read @rules/firebase/ and set up a project with Realtime Database, App Check, and Analytics.").

🚀 Introduction

This repository provides a comprehensive, (almost) non-opinionated collection of Flutter-related rules tailored for use with Windsurf, Cursor, and other AI-powered IDEs. These rules are designed to improve your development workflow, ensure consistency, and help you get the most out of your AI coding assistant.

📁 Repository Structure

rules/
Contains individual rule files, each focused on a specific topic or tool (e.g., bloc.md, effective_dart.md, etc.).
These files are:
- Based only on official documentation from Flutter, Dart, or relevant package websites.
- Categorized by subject to make them easy to mix, match, and reference.
- Meant to be refined, adjusted, or extracted based on your project needs.
combined/
Contains pre-made, curated sets of rules that combine commonly used topics (e.g., Flutter + Riverpod + Mockito).
These files:
- Are kept under 6,000 characters to comply with Windsurf's limit.
- Can be used as-is by copying them into your global or local rules configuration.

✅ How To Use

Option 1: Use Pre-Made Combined Rules

If you want a quick setup:

Browse the combined/ folder.
Copy a file that suits your project.
Paste it into your IDE's global or local rules config.
You're ready to go.

Option 2: Use Individual Rule Files

If you prefer more control:

Browse the rules/ folder.
Pick files relevant to your project (e.g., riverpod.md, bloc.md, etc.).
You can:
- Include them directly in your IDE setup.
- Reference them in prompts to add context.
- Extract only the parts that are useful for your context.
- Include them partially or fully in a PRD (Product Requirements Document).

Everything is modular — use what works best for you.

Option 3: Download All Rules via CLI

You can fetch the latest rules directly into your project with a single command:

git clone --depth 1 https://github.com/evanca/flutter-ai-rules.git temp_repo && mkdir -p docs && cp -r temp_repo/rules/* docs && rm -rf temp_repo

This will copy all rules into a docs folder in your project. After all rules are in the docs folder, you can reference them individually based on your needs—without the limitations of IDE ruleset length. Simply use them as context where applicable. For example:

“Read @docs/bloc.md and create test coverage for new methods.”

Pro tip:
You can also add a global rule that references this docs folder. For example, in your global rules or settings, you might write:
“We have a /docs folder containing various rules based on Flutter and Dart documentation.”

📏 No Opinions, Just Documentation

All rules are sourced from official documentation — no personal preferences or subjective interpretations. That’s intentional. You’re free to alter them to your taste, but this repo keeps things objective by sticking to the source.

Note: This might sometimes lead to contradictory rules (e.g., if one package suggests one folder architecture and another recommends a different one).

📌 Use Cases

Set up global rules for a Flutter project in your IDE.
Configure project-specific constraints for popular state management packages.
Provide clear expectations in a PDR when working with a team.
Extract only what you need to avoid rule clutter.

🛠️ Contributing

Contributions are welcome! If you'd like to suggest a new rule or improve an existing one, here’s how you can help:

Fork this repository.
Add or modify rules in the appropriate folder.
Submit a pull request with a clear explanation of your changes.
Make sure to include an official documentation link for any rule set you’re adding or modifying to keep everything objective and reliable.

📚 References

Here are the official sources that have been used to build these rules:

Flutter

Flutter App Architecture - Official Flutter architecture guidelines
Flutter Common Errors - Common errors documentation
Flutter ChangeNotifier State Management - Simple state management with ChangeNotifier

Dart

Effective Dart - Official Dart style guidelines
Dart 3 Updates - Documentation on Dart 3 features including:

State Management

Bloc Library - Official Bloc library documentation
Provider - Official Provider package documentation
Riverpod - Official Riverpod documentation

Testing

Mockito - Official Mockito for Dart documentation
Mocktail - Official Mocktail documentation

Firebase

Firebase for Flutter - Official Firebase Flutter documentation
Code with Andrea - How to Setup Flutter & Firebase with Multiple Flavors using the FlutterFire CLI

License

evanca/flutter-ai-rules

ErrorLooks like something went wrong!

About

Topics

Resources

License

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Error
Looks like something went wrong!

Packages