-
Notifications
You must be signed in to change notification settings - Fork 171
/
mixin_logger.dart
152 lines (132 loc) · 3.58 KB
/
mixin_logger.dart
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
library mixin_logger;
import 'package:ansicolor/ansicolor.dart';
import 'package:flutter/foundation.dart';
import 'src/format.dart';
import 'src/write_to_file_web.dart'
if (dart.library.io) 'src/write_to_file_ffi.dart' as platform;
const kLogMode = !kReleaseMode;
enum _LogLevel {
verbose,
debug,
info,
warning,
error,
wtf,
}
final _verbosePen = AnsiPen()..gray();
final _debugPen = AnsiPen()..blue();
final _infoPen = AnsiPen()..green();
final _warningPen = AnsiPen()..yellow();
final _errorPen = AnsiPen()..red();
final _wtfPen = AnsiPen()..magenta();
final _writeToFile = platform.WriteToFileImpl();
void Function(String log)? onWriteToFile;
extension _LogLevelExtension on _LogLevel {
String get prefix {
switch (this) {
case _LogLevel.verbose:
return '[V]';
case _LogLevel.debug:
return '[D]';
case _LogLevel.info:
return '[I]';
case _LogLevel.warning:
return '[W]';
case _LogLevel.error:
return '[E]';
case _LogLevel.wtf:
return '[WTF]';
}
}
String colorize(String message) {
if (!_writeToFile.enableLogColor) {
return message;
}
switch (this) {
case _LogLevel.verbose:
return _verbosePen(message);
case _LogLevel.debug:
return _debugPen(message);
case _LogLevel.info:
return _infoPen(message);
case _LogLevel.warning:
return _warningPen(message);
case _LogLevel.error:
return _errorPen(message);
case _LogLevel.wtf:
return _wtfPen(message);
}
}
}
///
/// Init logger to write log to file.
///
/// [logDir] the directory to store log files.
/// [fileLeading] the leading of log file content, it will be written
/// to the first line of each log file.
void initLogger(
String logDir, {
int maxFileCount = 10,
int maxFileLength = 1024 * 1024 * 10, // 10 MB
String? fileLeading,
}) {
assert(maxFileCount > 1, 'maxFileCount must be greater than 1');
assert(maxFileLength > 10 * 1024, 'maxFileLength must be greater than 10 KB');
if (fileLeading != null) {
assert(fileLeading.length < maxFileLength, 'fileLeading is too long');
}
_writeToFile.init(logDir, maxFileCount, maxFileLength, fileLeading);
}
/// Set the leading of log file content, it will be written
/// to the first line of each log file.
void setLoggerFileLeading(String? leading) {
_writeToFile.setLoggerFileLeading(leading);
}
/// verbose log
void v(String message) {
_print(message, _LogLevel.verbose);
}
/// debug log
void d(String message) {
_print(message, _LogLevel.debug);
}
/// info log
void i(String message) {
_print(message, _LogLevel.info);
}
/// warning log
void w(String message) {
_print(message, _LogLevel.warning);
}
/// error log
/// [error] the error object
/// [stackTrace] the stack trace of the error
void e(String message, [Object? error, StackTrace? stackTrace]) {
var messageWithStack = message;
if (error != null) {
messageWithStack += ' ($error)';
}
if (stackTrace != null) {
messageWithStack += ':\n$stackTrace';
}
_print(messageWithStack, _LogLevel.error);
}
/// wtf log
void wtf(String message) {
_print(message, _LogLevel.wtf);
}
void _print(String message, _LogLevel level) {
final logToFile = kLogMode || level.index > _LogLevel.debug.index;
if (!logToFile && !kLogMode) {
return;
}
final output = '${formatDateTime(DateTime.now())} ${level.prefix} $message';
if (logToFile && !kIsWeb) {
_writeToFile.writeLog(output);
onWriteToFile?.call(output);
}
if (kLogMode) {
// ignore: avoid_print
print(level.colorize(output));
}
}