mirror of
https://github.com/pese-git/cherrypick.git
synced 2026-01-24 05:25:19 +00:00
264c4bbb88
- Add detailed English doc comments for all main annotations (inject, injectable, instance, provide, scope, etc) - Add fully documented example/example.dart illustrating real-world DI scenario - Clarify stub sections (Module class, generated mixins) - Aligns package with pub.dev quality and best practice requirements No breaking changes.
45 lines
1.6 KiB
Dart
45 lines
1.6 KiB
Dart
//
|
|
// Copyright 2021 Sergey Penkovsky (sergey.penkovsky@gmail.com)
|
|
// Licensed under the Apache License, Version 2.0 (the "License");
|
|
// you may not use this file except in compliance with the License.
|
|
// You may obtain a copy of the License at
|
|
// https://www.apache.org/licenses/LICENSE-2.0
|
|
// Unless required by applicable law or agreed to in writing, software
|
|
// distributed under the License is distributed on an "AS IS" BASIS,
|
|
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
// See the License for the specific language governing permissions and
|
|
// limitations under the License.
|
|
//
|
|
|
|
import 'package:meta/meta.dart';
|
|
|
|
/// Marks a class as injectable, enabling automatic field injection by CherryPick's code generator.
|
|
///
|
|
/// Use `@injectable()` on a class whose fields (marked with `@inject`) you want to be automatically injected from the DI [Scope].
|
|
/// When used together with code generation (see cherrypick_generator), a mixin will be generated to inject fields.
|
|
///
|
|
/// Example:
|
|
/// ```dart
|
|
/// import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
|
///
|
|
/// @injectable()
|
|
/// class ProfileScreen with _\$ProfileScreen {
|
|
/// @inject()
|
|
/// late final UserManager manager;
|
|
///
|
|
/// @inject()
|
|
/// @named('main')
|
|
/// late final ApiClient api;
|
|
/// }
|
|
///
|
|
/// // After running build_runner, call:
|
|
/// // profileScreen.injectFields();
|
|
/// ```
|
|
///
|
|
/// After running the generator, the mixin (`_\$ProfileScreen`) will be available to help auto-inject all [@inject] fields in your widget/service/controller.
|
|
@experimental
|
|
final class injectable {
|
|
/// Creates an [injectable] annotation for classes.
|
|
const injectable();
|
|
}
|