mirror of
https://github.com/pese-git/cherrypick.git
synced 2026-01-23 21:13:35 +00:00
feat(logger): add extensible logging API, usage examples, and bilingual documentation
- Introduce CherryPickLogger interface, PrintLogger and SilentLogger implementations - Add setGlobalLogger() to CherryPick API for custom DI logging - Log key events (scope, module, error) via logger throughout DI lifecycle - Comprehensive comments and code documentation in both English and Russian - Document usage of logging system in quick_start and full_tutorial documentation (EN/RU) - Provide usage examples in docs and code comments - No logging inside GlobalCycleDetectionMixin (design choice: exceptions handled at Scope, not detector/mixin level) and detailed architectural reasoning - Update helper.dart, logger.dart: comments, examples, API doc improvements BREAKING CHANGE: Projects can now inject any logger via CherryPick.setGlobalLogger; default log behavior clarified and docstrings/usage examples enhanced
This commit is contained in:
@@ -79,6 +79,24 @@ Example:
|
||||
Cherrypick.closeRootScope();
|
||||
```
|
||||
|
||||
## Logging
|
||||
|
||||
To enable logging of all dependency injection (DI) events and errors in CherryPick, set the global logger before creating your scopes:
|
||||
|
||||
```dart
|
||||
import 'package:cherrypick/cherrypick.dart';
|
||||
|
||||
void main() {
|
||||
// Set a global logger before any scopes are created
|
||||
CherryPick.setGlobalLogger(PrintLogger()); // or your own custom logger
|
||||
final scope = CherryPick.openRootScope();
|
||||
// All DI events and cycle errors will now be sent to your logger
|
||||
}
|
||||
```
|
||||
|
||||
- By default, CherryPick uses SilentLogger (no output in production).
|
||||
- Any dependency resolution, scope events, or cycle detection errors are logged via info/error on your logger.
|
||||
|
||||
## Example app
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user