# This is the full, recommended configuration for the `clean_architecture_kit` package.
# Copy and paste this entire content into your `analysis_options.yaml` file.

analyzer:
  plugins:
    # The custom_lint framework discovers all other lint packages, like `clean_architecture_kit`,
    # automatically from your project's dev_dependencies.
    - custom_lint

# The top-level `custom_lint` key manages all custom linting.
custom_lint:
  rules:
    # --- ENABLE/DISABLE INDIVIDUAL LINT RULES ---
    # To disable a rule, set its value to `false`.
    
    # Purity Rules
    - domain_layer_purity: true
    - data_source_purity: true
    - presentation_layer_purity: true
    - repository_implementation_purity: true
    - disallow_flutter_imports_in_domain: true
    - disallow_flutter_types_in_domain: true
    
    # Dependency & Structure Rules
    - enforce_layer_independence: true
    - enforce_abstract_data_source_dependency: true
    - enforce_file_and_folder_location: true

    # Naming, Type Safety & Inheritance Rules
    - enforce_naming_conventions: true
    - enforce_custom_return_type: true
    - enforce_use_case_inheritance: true
    - enforce_repository_inheritance: true

    # Code Generation Rule
    - missing_use_case: true

    # --- SHARED CONFIGURATION for the 'clean_architecture_kit' plugin ---
    # The configuration map is provided as a special entry in the rules list.
    - clean_architecture:
      # [SECTION 1: PROJECT STRUCTURE]
      project_structure: 'feature_first' # Options: 'layer_first' or 'feature_first'
    
      # For 'feature_first' structure.
      feature_first_paths:
        features_root: "features"
    
      # For 'layer_first' structure.
      layer_first_paths:
        domain: "domain"
        data: "data"
        presentation: "presentation"
    
      # [SECTION 2: LAYER & DIRECTORY DEFINITIONS]
      # Define the canonical names for your sub-directories.
      layer_definitions:
        domain:
          entities: ['entities']
          repositories: ['repositories']
          use_cases: ['usecases']
        data:
          repositories: ['repositories']
          data_sources: ['datasources']
          models: ['models']
        presentation:
          managers: ['bloc', 'cubit', 'provider']
    
      # [SECTION 3: NAMING CONVENTIONS]
      # Use {{name}} as a placeholder for the base name (e.g., 'Auth' in 'AuthRepository').
      naming_conventions:
        model: '{{name}}Model'
        use_case: '{{name}}Usecase'
        use_case_record_parameter: '_{{name}}Params'
        repository_interface: '{{name}}Repository'
        repository_implementation: '{{name}}RepositoryImpl'
        data_source_interface: '{{name}}DataSource'
        data_source_implementation: 'Default{{name}}DataSource'
    
      # [SECTION 4: TYPE SAFETY RULES]
      # These paths point to the base classes provided by `clean_architecture_kit` itself.
      type_safety:
        return_type_name: ['FutureEither']
        import_path: ['package:clean_architecture_kit/clean_architecture_kit.dart']
        apply_to: ['usecases', 'repository_interface']
    
      # [SECTION 5: INHERITANCE AND BASE CLASSES]
      # These paths also point to the base classes provided by `clean_architecture_kit`.
      inheritance:
        repository_base_path: 'package:clean_architecture_kit/clean_architecture_kit.dart'
        repository_base_name: 'Repository'
      
        unary_use_case_path: 'package:clean_architecture_kit/clean_architecture_kit.dart'
        unary_use_case_name: 'UnaryUsecase'
    
        nullary_use_case_path: 'package:clean_architecture_kit/clean_architecture_kit.dart'
        nullary_use_case_name: 'NullaryUsecase'
    
      # [SECTION 6: GENERATION OPTIONS] (Optional)
      # Uncomment and configure this section to add annotations to generated use cases.
      generation_options:
        use_case_annotations:
          - import_path: 'package:injectable/injectable.dart'
            annotation_text: 'Injectable()'