Prefer Void Public Cubit Methods

newdartrecommended

Prefer void public methods on Cubit instances.

Note

This lint rule was introduced in version 0.2.0-dev.2 of package:bloc_lint

Rationale

Public methods on Cubit instances should be used to notify the Cubit and initiate state changes via the emit method. If the caller needs access to any state information, they should access it from the state instead.

Note

The following rules are related and are usually enabled in combination with prefer_void_public_cubit_methods.

• avoid_public_bloc_methods
• avoid_public_fields

Examples

Avoid non-void public methods on Cubit instances.

BAD:

counter_cubit.dart

import 'package:bloc/bloc.dart';

class CounterCubit extends Cubit<int> {
  CounterCubit() : super(0);

  int increment() {
    emit(state + 1);
    return state;
  }
}

GOOD:

counter_cubit.dart

import 'package:bloc/bloc.dart';

class CounterCubit extends Cubit<int> {
  CounterCubit() : super(0);

  void increment() => emit(state + 1);
}

Enable

To enable the prefer_void_public_cubit_methods rule, add it to your analysis_options.yaml under bloc > rules:

YAML List

analysis_options.yaml

bloc:
  rules:
    - prefer_void_public_cubit_methods

YAML Map

analysis_options.yaml

bloc:
  rules:
    prefer_void_public_cubit_methods: true