mirror of
https://github.com/pese-git/cherrypick.git
synced 2026-01-23 21:13:35 +00:00
docs(log_format): add detailed English documentation for formatLogMessage function
This commit is contained in:
@@ -12,12 +12,33 @@
|
|||||||
//
|
//
|
||||||
|
|
||||||
|
|
||||||
/// Ёдиный форматтер лог-сообщений CherryPick.
|
/// Formats a log message string for CherryPick's logging system.
|
||||||
///
|
///
|
||||||
/// Используйте для формирования сообщений всех уровней (info, warn, error)
|
/// This function provides a unified structure for framework logs (info, warn, error, debug, etc.),
|
||||||
/// Например:
|
/// making it easier to parse and analyze events related to DI operations such as resolving bindings,
|
||||||
/// log.info(formatLogMessage(type:'Binding', name:..., params:{...}, description:'created'));
|
/// scope creation, module installation, etc.
|
||||||
|
///
|
||||||
|
/// All parameters except [name] and [params] are required.
|
||||||
|
///
|
||||||
|
/// Example:
|
||||||
|
/// ```dart
|
||||||
|
/// final msg = formatLogMessage(
|
||||||
|
/// type: 'Binding',
|
||||||
|
/// name: 'MyService',
|
||||||
|
/// params: {'parent': 'AppModule', 'lifecycle': 'singleton'},
|
||||||
|
/// description: 'created',
|
||||||
|
/// );
|
||||||
|
/// // Result: [Binding:MyService] parent=AppModule lifecycle=singleton created
|
||||||
|
/// ```
|
||||||
|
///
|
||||||
|
/// Parameters:
|
||||||
|
/// - [type]: The type of the log event subject (e.g., 'Binding', 'Scope', 'Module'). Required.
|
||||||
|
/// - [name]: Optional name of the subject (binding/scope/module) to disambiguate multiple instances/objects.
|
||||||
|
/// - [params]: Optional map for additional context (e.g., id, parent, lifecycle, named, etc.).
|
||||||
|
/// - [description]: Concise description of the event. Required.
|
||||||
|
///
|
||||||
|
/// Returns a structured string:
|
||||||
|
/// [type(:name)] param1=val1 param2=val2 ... description
|
||||||
String formatLogMessage({
|
String formatLogMessage({
|
||||||
required String type, // Binding, Scope, Module, ...
|
required String type, // Binding, Scope, Module, ...
|
||||||
String? name, // Имя binding/scope/module
|
String? name, // Имя binding/scope/module
|
||||||
|
|||||||
Reference in New Issue
Block a user