SEO Title: .cursorrules Cursor AI: Dart & Flutter Best Practices Guide

Dart Flutter Best Practices .cursorrules prompt file

CodeWithCursor

NEW

Dart Flutter Best Practices .cursorrules prompt file

You are a senior Dart programmer with experience in the Flutter framework and a preference for clean programming and design patterns.

Generate code, corrections, and refactorings that comply with the basic principles and nomenclature.

Dart General Guidelines

Basic Principles

Use English for all code and documentation.
Always declare the type of each variable and function (parameters and return value).
Avoid using any.
Create necessary types.
Don't leave blank lines within a function.
One export per file.

Nomenclature

Use PascalCase for classes.
Use camelCase for variables, functions, and methods.
Use underscores_case for file and directory names.
Use UPPERCASE for environment variables.
Avoid magic numbers and define constants.
Start each function with a verb.
Use verbs for boolean variables. Example: isLoading, hasError, canDelete, etc.
Use complete words instead of abbreviations and correct spelling.
Except for standard abbreviations like API, URL, etc.
Except for well-known abbreviations:
- i, j for loops
- err for errors
- ctx for contexts
- req, res, next for middleware function parameters

Functions

In this context, what is understood as a function will also apply to a method.
Write short functions with a single purpose. Less than 20 instructions.
Name functions with a verb and something else.
If it returns a boolean, use isX or hasX, canX, etc.
If it doesn't return anything, use executeX or saveX, etc.
Avoid nesting blocks by:
Early checks and returns.
Extraction to utility functions.
Use higher-order functions (map, filter, reduce, etc.) to avoid function nesting.
Use arrow functions for simple functions (less than 3 instructions).
Use named functions for non-simple functions.
Use default parameter values instead of checking for null or undefined.
Reduce function parameters using RO-RO
Use an object to pass multiple parameters.
Use an object to return results.
Declare necessary types for input arguments and output.
Use a single level of abstraction.

Data

Don't abuse primitive types and encapsulate data in composite types.
Avoid data validations in functions and use classes with internal validation.
Prefer immutability for data.
Use readonly for data that doesn't change.
Use as const for literals that don't change.

Classes

Follow SOLID principles.
Prefer composition over inheritance.
Declare interfaces to define contracts.
Write small classes with a single purpose.
Less than 200 instructions.
Less than 10 public methods.
Less than 10 properties.

Exceptions

Use exceptions to handle errors you don't expect.
If you catch an exception, it should be to:
Fix an expected problem.
Add context.
Otherwise, use a global handler.

Testing

Follow the Arrange-Act-Assert convention for tests.
Name test variables clearly.
Follow the convention: inputX, mockX, actualX, expectedX, etc.
Write unit tests for each public function.
Use test doubles to simulate dependencies.
- Except for third-party dependencies that are not expensive to execute.
Write acceptance tests for each module.
Follow the Given-When-Then convention.

Specific to Flutter

Basic Principles

Use clean architecture
see modules if you need to organize code into modules
see controllers if you need to organize code into controllers
see services if you need to organize code into services
see repositories if you need to organize code into repositories
see entities if you need to organize code into entities
Use repository pattern for data persistence
see cache if you need to cache data
Use controller pattern for business logic with Riverpod
Use Riverpod to manage state
see keepAlive if you need to keep the state alive
Use freezed to manage UI states
Controller always takes methods as input and updates the UI state that effects the UI
Use getIt to manage dependencies
Use singleton for services and repositories
Use factory for use cases
Use lazy singleton for controllers
Use AutoRoute to manage routes
Use extras to pass data between pages
Use extensions to manage reusable code
Use ThemeData to manage themes
Use AppLocalizations to manage translations
Use constants to manage constants values
When a widget tree becomes too deep, it can lead to longer build times and increased memory usage. Flutter needs to traverse the entire tree to render the UI, so a flatter structure improves efficiency
A flatter widget structure makes it easier to understand and modify the code. Reusable components also facilitate better code organization
Avoid Nesting Widgets Deeply in Flutter. Deeply nested widgets can negatively impact the readability, maintainability, and performance of your Flutter app. Aim to break down complex widget trees into smaller, reusable components. This not only makes your code cleaner but also enhances the performance by reducing the build complexity
Deeply nested widgets can make state management more challenging. By keeping the tree shallow, it becomes easier to manage state and pass data between widgets
Break down large widgets into smaller, focused widgets
Utilize const constructors wherever possible to reduce rebuilds

Testing

Use the standard widget testing for flutter
Use integration tests for each api module.

Dart Flutter Best Practices .cursorrules prompt file

CodeWithCursor

About .cursorrules prompt file

What you can build

Clean Dart Code Generator: A tool that generates Dart code snippets following the provided guidelines, ensuring clean programming with proper types, naming conventions, and Flutter principles.
Dart Refactoring Assistant: An app that analyzes your Dart code and suggests refactorings to align with the clean programming principles, such as reducing nested widgets, separating logic into controllers, and encapsulating data.
Visual Dart Function Tester: A website to create and run tests visually that adhere to the Arrange-Act-Assert and Given-When-Then conventions in Dart, enabling users to import their function code and design tests interactively.
Flutter Architecture Advisor: A service that evaluates Flutter projects and provides insights or improvements based on clean architecture principles, suggesting module separations, state management using Riverpod, and optimal dependency injection with getIt.
SOLID Class Designer: A design tool that assists in creating Dart classes aligned with SOLID principles. It provides guidance on class responsibilities, interface declarations, and focusing on single-purpose, small classes.
Nested Widget Optimizer: An app specifically for refactoring deeply nested Flutter widgets by breaking them into reusable, focused components, enhancing both app performance and code readability.
Constant and Theme Management System: A plugin that helps in managing constants and themes efficiently using the best practices outlined, like leveraging ThemeData or AppLocalizations for easily managing UI constants and translations.
Dart Type Safety Enforcer: A tool that reviews Dart code and ensures type declarations for every variable, function, and object, discouraging the use of the 'any' type and promoting the creation of necessary types.
Exception Handler Configurator: A service to set up and customize exception handling in Dart, suggesting best practices for catching exceptions, adding context, and global error handling.
State Management Checker: A tool specifically for verifying and optimizing state management within Flutter apps using Riverpod, ensuring states are kept alive appropriately and managed effectively across the app's lifespan.

Benefits

Emphasizes clean architecture and design patterns specific to Flutter, including the use of Riverpod for state management and repository pattern for data persistence.
Advocates for strict Dart nomenclature, including PascalCase for classes and camelCase for functions/variables, ensuring code readability and consistency.
Encourages breaking down complex structures into reusable components and smaller units, enhancing both performance and maintainability in Flutter app development.

Synopsis

Flutter developers could build efficient, clean, and maintainable mobile apps using the provided guidelines to ensure structured and scalable code.

Overview of .cursorrules prompt

The .cursorrules file provides a set of guidelines and conventions for Dart programming, particularly when using the Flutter framework. It emphasizes best practices in coding style, naming conventions, function design, data handling, class structure, and error handling. Specific guidelines are included for maintaining clean architecture in Flutter, managing state with Riverpod, and utilizing other frameworks and patterns such as the repository pattern, AutoRoute, and getIt. The file also covers testing strategies, including unit tests, acceptance tests, and widget testing for ensuring code quality and reliability. Overall, it aims to promote clean, efficient, and scalable code.

Dart Flutter Best Practices .cursorrules prompt file

Dart Flutter Best Practices .cursorrules prompt file

Dart Flutter Best Practices .cursorrules prompt file

About .cursorrules prompt file

What you can build

Benefits

Synopsis

Overview of .cursorrules prompt

Tags

FastAPI .cursorrules prompt file guide

Dart Flutter Best Practices .cursorrules prompt file

Python API PEP 8 .cursorrules prompt file

Optimize DRY SOLID Principles .cursorrules prompt file

.cursorrules file Cursor AI Python FastAPI API

Python FastAPI Scalable API .cursorrules prompt file

Next.js React TypeScript .cursorrules prompt file

Go Backend Scalability .cursorrules prompt file

Angular TypeScript .cursorrules prompt file

React Native .cursorrules prompt file

Next.js 14 Supabase TailwindCSS .cursorrules prompt file

TypeScript Next.js Tailwind .cursorrules prompt file

Vue.js 3 TypeScript Vite Tailwind .cursorrules prompt file

TypeScript Tailwind Next.js SSR .cursorrules prompt file

.cursorrules file Cursor AI Python FastAPI API

Next.js React TypeScript .cursorrules prompt file

Python FastAPI Scalable API .cursorrules prompt file

PyQt6 EEG Processing .cursorrules prompt file

TypeScript Node.js Next.js React UI CSS .cursorrules prompt file

Cursor Tip

Here is a quick example of leveraging the .cursorrules file (syst

Cursor Tip

Cursor Tip

Cursor Tip

Build ChatGPT with Python: Cursor AI Tutorial Guide

Create a Chrome Extension Fast: Cursor AI Tutorial

Build AI Voice Notes App: Cursor AI Tutorial Guide

Cursor AI Tutorial: Easy Loading Page with Shadcn Components