This repository offers a curated collection of Flutter and Dart development rules for AI-powered IDEs like Cursor and Windsurf. It aims to enhance developer workflows and ensure code consistency by providing objective, documentation-based guidance, targeting Flutter developers seeking to leverage AI assistants for code generation and adherence to best practices.

How It Works

The project organizes rules into individual files within the rules/ directory, each based solely on official documentation for Flutter, Dart, and related packages. These are categorized by topic for modularity. Additionally, the combined/ directory offers pre-packaged rule sets, under 6,000 characters, for quick integration into IDEs. Users can copy these files directly or reference individual rules for more granular control.

Quick Start & Requirements

• To use pre-made rules, copy contents from combined/ into your IDE's global or local rules configuration.
• For project-specific integration, clone the repository: 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.
• No specific software prerequisites beyond an AI-enabled IDE that supports rule-based configurations.

Highlighted Details

• Rules are strictly derived from official documentation, ensuring objectivity.
• Modular design allows for flexible use of individual rules or combined sets.
• Supports referencing rules directly within IDE prompts for contextual AI assistance.
• Includes rules for state management (Bloc, Provider, Riverpod), testing (Mockito, Mocktail), and Firebase integration.

Maintenance & Community

The repository is maintained by evanca. Contributions are welcome via pull requests, with a requirement to cite official documentation for new or modified rules.

Licensing & Compatibility

The repository does not explicitly state a license. Users should verify compatibility for commercial or closed-source use.

Limitations & Caveats

The objective sourcing of rules may occasionally lead to contradictory recommendations if official documentation presents differing approaches. The repository does not specify an explicit license, which may impact commercial adoption.