mirror of
https://github.com/pese-git/cherrypick.git
synced 2026-01-23 21:13:35 +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 method or class as a dependency provider (factory/provider) for CherryPick module code generation.
|
|
///
|
|
/// Use `@provide` on any method inside a `@module()` annotated class when you want that method
|
|
/// to be used as a DI factory/provider during code generation.
|
|
///
|
|
/// This should be used for methods that create dynamic, optional, or complex dependencies, especially
|
|
/// if you want to control the codegen/injection pipeline explicitly and support parameters.
|
|
///
|
|
/// Example:
|
|
/// ```dart
|
|
/// import 'package:cherrypick_annotations/cherrypick_annotations.dart';
|
|
///
|
|
/// @module()
|
|
/// abstract class FeatureModule {
|
|
/// @provide
|
|
/// Future<Api> provideApi(@params Map<String, dynamic> args) async => ...;
|
|
///
|
|
/// @singleton()
|
|
/// @provide
|
|
/// Logger provideLogger() => Logger();
|
|
/// }
|
|
/// ```
|
|
///
|
|
/// See also: [@singleton], [@instance], [@params], [@named]
|
|
@experimental
|
|
final class provide {
|
|
/// Creates a [provide] annotation for marking provider methods/classes in DI modules.
|
|
const provide();
|
|
}
|