mirror of
https://github.com/pese-git/cherrypick.git
synced 2026-01-24 05:25:19 +00:00
7d45d00d6a
- Added comprehensive English documentation for all DI generator and support files: * inject_generator.dart — full class/method doc-comments, usage samples * module_generator.dart — doc-comments, feature explanation, complete example * src/annotation_validator.dart — class and detailed static method descriptions * src/type_parser.dart — doc, example for ParsedType and TypeParser, specific codegen notes * src/bind_spec.dart — interface, static factory, and codegen docs with DI scenarios * src/bind_parameters_spec.dart — details and samples for code generation logic * src/metadata_utils.dart — full doc and examples for annotation utilities * src/exceptions.dart — user- and contributor-friendly errors, structured output, category explanations * src/generated_class.dart — usage-centric doc-comments, example of resulting generated DI class - Removed Russian/duplicate comments for full clarity and maintainability - Ensured that new and existing contributors can easily extend and maintain DI code generation logic BREAKING CHANGE: All documentation now English-only; comments include usage examples for each principal structure or routine See #docs, #generator, #cherrypick
77 lines
2.7 KiB
Dart
77 lines
2.7 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:analyzer/dart/element/element.dart';
|
|
|
|
/// ---------------------------------------------------------------------------
|
|
/// MetadataUtils
|
|
///
|
|
/// Static utilities for querying and extracting information from
|
|
/// Dart annotations ([ElementAnnotation]) in the context of code generation,
|
|
/// such as checking for the presence of specific DI-related annotations.
|
|
/// Designed to be used internally by code generation and validation routines.
|
|
///
|
|
/// # Example usage
|
|
/// ```dart
|
|
/// if (MetadataUtils.anyMeta(method.metadata, 'singleton')) {
|
|
/// // The method is annotated with @singleton
|
|
/// }
|
|
/// final name = MetadataUtils.getNamedValue(field.metadata);
|
|
/// if (name != null) print('@named value: $name');
|
|
/// ```
|
|
/// ---------------------------------------------------------------------------
|
|
class MetadataUtils {
|
|
/// Checks whether any annotation in [meta] matches the [typeName]
|
|
/// (type name is compared in a case-insensitive manner and can be partial).
|
|
///
|
|
/// Returns true if an annotation (such as @singleton, @provide, @named) is found.
|
|
///
|
|
/// Example:
|
|
/// ```dart
|
|
/// bool isSingleton = MetadataUtils.anyMeta(myMethod.metadata, 'singleton');
|
|
/// ```
|
|
static bool anyMeta(List<ElementAnnotation> meta, String typeName) {
|
|
return meta.any((m) =>
|
|
m
|
|
.computeConstantValue()
|
|
?.type
|
|
?.getDisplayString()
|
|
.toLowerCase()
|
|
.contains(typeName.toLowerCase()) ??
|
|
false);
|
|
}
|
|
|
|
/// Extracts the string value from a `@named('value')` annotation if present in [meta].
|
|
///
|
|
/// Returns the named value or `null` if not annotated.
|
|
///
|
|
/// Example:
|
|
/// ```dart
|
|
/// // For: @named('dev') ApiClient provideApi() ...
|
|
/// final named = MetadataUtils.getNamedValue(method.metadata); // 'dev'
|
|
/// ```
|
|
static String? getNamedValue(List<ElementAnnotation> meta) {
|
|
for (final m in meta) {
|
|
final cv = m.computeConstantValue();
|
|
|
|
final typeStr = cv?.type?.getDisplayString().toLowerCase();
|
|
|
|
if (typeStr?.contains('named') ?? false) {
|
|
return cv?.getField('value')?.toStringValue();
|
|
}
|
|
}
|
|
|
|
return null;
|
|
}
|
|
}
|