y_lints #

Custom lint rules that enforce clean architecture boundaries in Dart and Flutter projects. Classes are tagged with simple annotations (@DomainEntity, @Repository, @DataSource, @FeatureCubit, …) and the lints verify that each tagged class lives in the right folder, follows the right naming convention, and only depends on layers it is allowed to see.

Built on top of custom_lint.

Installation #

Add custom_lint and y_lints as dev dependencies:

dev_dependencies:
  custom_lint: ^0.7.0
  y_lints: ^0.0.1

Enable the plugin in your analysis_options.yaml:

analyzer:
  plugins:
    - custom_lint

Then run:

dart run custom_lint

Usage #

Import the annotations and tag your classes. The lints do the rest.

import 'package:y_lints/annotations.dart';

// lib/domain/entities/user_entity.dart
@DomainEntity()
class UserEntity {
  const UserEntity({required this.id, required this.name});
  final String id;
  final String name;
}

// lib/domain/repositories/user_repository.dart
@Repository()
abstract class UserRepository {
  Future<UserEntity> fetch(String id);
}

// lib/data/models/user_model.dart
@Model()
class UserModel extends UserEntity {
  const UserModel({required super.id, required super.name});
}

Expected folder layout #

lib/
├── domain/
│   ├── entities/              # @DomainEntity — pure entities
│   └── repositories/          # @Repository   — abstract contracts
├── data/
│   ├── models/                # @Model        — DTOs extending entities
│   ├── repositories/          # @RepositoryImpl
│   └── datasources/
│       └── <feature>/
│           ├── i_*.dart       # @DataSource   — contract
│           └── implementations/
│               ├── remote_*.dart  # @RemoteDataSource
│               └── mock_*.dart    # @MockDataSource
└── presentation/
    └── <feature>/
        ├── cubits/<cubit_name>/
        │   ├── *_cubit.dart   # @FeatureCubit
        │   └── *_state.dart   # @FeatureState
        ├── view/
        │   └── *_builder.dart # @FeatureBuilder — state consumer
        └── pages/             # @Page — any location, Page suffix
            └── *_page.dart

Rules #

Disabling a rule #

Disable any rule in analysis_options.yaml:

custom_lint:
  rules:
    - domain_entity_purity: false

Custom folder layout #

If your project doesn't live under lib/domain, lib/data, lib/presentation, override the layer roots through a y_lints config block:

custom_lint:
  rules:
    - y_lints:
        root: lib/            # default
        domain: domain/       # default
        data: data/           # default
        presentation: presentation/  # default

All four fields are optional. For example, to rename presentation/ to ui/:

custom_lint:
  rules:
    - y_lints:
        presentation: ui/

Or to move everything under lib/src/:

custom_lint:
  rules:
    - y_lints:
        root: lib/src/

Intra-layer folder names (entities/, repositories/, models/, datasources/, cubits/, view/) and file conventions (i_*.dart, remote_*.dart, mock_*.dart, *_model.dart, *_cubit.dart, *_state.dart) are fixed.

License #

MIT — see LICENSE.