Skip to content

Commit 77a910b

Browse files
committed
🎨 Format file and fix lins
1 parent 5546aa5 commit 77a910b

File tree

10 files changed

+57
-28
lines changed

10 files changed

+57
-28
lines changed

lib/logger/bolt_logger.dart

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,8 @@ class BoltLogger {
2121

2222
static final _instance = BoltLogger._();
2323

24+
// Is cancelled in discharge
25+
//ignore: cancel_subscriptions
2426
StreamSubscription<LogRecord>? _subscription;
2527

2628
final Map<String, BoltCharge> _outputs = {};

lib/logger/charges/bolt_charge.dart

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,9 @@ export 'package:dcc_toolkit/logger/charges/memory_charge.dart';
66

77
/// Interface for creating [BoltCharge]s to power the [BoltLogger]
88
abstract interface class BoltCharge {
9-
109
/// The name of the charge.
1110
abstract final String name;
11+
1212
/// Log the output of the [ZapEvent].
1313
void logOutput(ZapEvent event);
1414

lib/logger/charges/debug_console_charge.dart

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,9 @@ class DebugConsoleCharge implements BoltCharge {
2727
event.origin.stackTrace != null ||
2828
event.origin.error != null);
2929

30-
return shouldPaint ? event.lines.map((line) => '$_red$line$_reset').toList() : event.lines;
30+
return shouldPaint
31+
? event.lines.map((line) => '$_red$line$_reset').toList()
32+
: event.lines;
3133
}
3234

3335
@override

lib/logger/charges/file_charge.dart

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -13,21 +13,23 @@ import 'package:intl/intl.dart';
1313
///
1414
/// {@endtemplate}
1515
class FileCharge implements BoltCharge {
16-
1716
/// {@macro file_charge}
18-
FileCharge(this.path, {this.bufferSize = 1000, this.writeDelay = const Duration(seconds: 5)}) {
17+
FileCharge(this.path,
18+
{this.bufferSize = 1000, this.writeDelay = const Duration(seconds: 5),}) {
1919
final fileName = '${DateFormat('yyyy-MM-dd').format(DateTime.now())}.log';
2020
_file = File('$path/$fileName');
2121

2222
Timer.periodic(writeDelay, (_) => _flush());
2323
}
2424
@override
25-
String get name => 'FileCharge';
25+
String get name => 'FileCharge';
2626

2727
/// The size of the buffer (in lines) before writing to the file.
2828
final int bufferSize;
29+
2930
/// The path to the directory where the log files will be written.
3031
final String path;
32+
3133
/// The delay between writing to the file.
3234
final Duration writeDelay;
3335
File? _file;

lib/logger/charges/memory_charge.dart

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ class MemoryCharge implements BoltCharge {
1616
MemoryCharge({this.maxItems = 1000});
1717

1818
@override
19-
String get name => 'MemoryCharge';
19+
String get name => 'MemoryCharge';
2020

2121
/// The maximum amount of logs to store in memory.
2222
final int maxItems;
@@ -41,7 +41,7 @@ class MemoryCharge implements BoltCharge {
4141

4242
@override
4343
void discharge() {
44-
_controller.close();
45-
_items.clear();
44+
_controller.close();
45+
_items.clear();
4646
}
4747
}
Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,11 @@
11
/// StackTrace extension methods.
22
extension ZapStackTraceExtension on StackTrace {
3-
43
/// Strike the [StackTrace] which will format it so that it's easier to read.
54
String get strike => toString()
65
.split('\n')
7-
.map((e) => e.isNotEmpty && e.startsWith('#') ? e.replaceAll(RegExp(r'\s\s+'), ' ') : null)
6+
.map((e) => e.isNotEmpty && e.startsWith('#')
7+
? e.replaceAll(RegExp(r'\s\s+'), ' ')
8+
: null,)
89
.whereType<String>()
910
.join('\n');
1011
}

lib/logger/extensions/zap_extension.dart

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,10 @@ extension ZapExtension on Object {
1515

1616
/// {@macro shock}
1717
void shock(
18-
Object? message, {
19-
String? tag,
20-
Level level = Level.SEVERE,
21-
}) {
18+
Object? message, {
19+
String? tag,
20+
Level level = Level.SEVERE,
21+
}) {
2222
//ignore: no_runtimeType_toString
2323
BoltLogger.shock(message, tag: tag ?? runtimeType.toString(), level: level);
2424
}

lib/logger/log_record_formatter.dart

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ class LogRecordFormatter {
2525
}
2626

2727
List<String> _formatMessage(LogRecord record) {
28-
if (record.message == 'null'|| record.message.trim().isEmpty) return [];
28+
if (record.message == 'null' || record.message.trim().isEmpty) return [];
2929

3030
return record.message.split('\n');
3131
}
@@ -36,7 +36,8 @@ class LogRecordFormatter {
3636
return record.error.toString().split('\n').map((e) => e.trim()).toList();
3737
}
3838

39-
List<String> _formatStacktrace(LogRecord record) => record.stackTrace?.strike.split('\n') ?? [];
39+
List<String> _formatStacktrace(LogRecord record) =>
40+
record.stackTrace?.strike.split('\n') ?? [];
4041

4142
String _prefix(LogRecord record) {
4243
final tag = record.loggerName;

lib/logger/zap_event.dart

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
import 'package:dcc_toolkit/logger/log_record_formatter.dart';
22
import 'package:logging/logging.dart';
3+
34
/// {@template zap_event}
45
/// A zap event that contains the [lines] of a log record and the [origin] [LogRecord].
56
/// {@endtemplate}

test/logger/bolt_logger_test.dart

Lines changed: 32 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
// Mocktail doesn't work properly with tear-offs
2+
//ignore_for_file: unnecessary_lambdas
13
import 'package:dcc_toolkit/dcc_toolkit.dart';
24
import 'package:flutter_test/flutter_test.dart';
35
import 'package:logging/logging.dart';
@@ -10,7 +12,8 @@ void main() {
1012
tearDown(() => BoltLogger.discharge());
1113

1214
group('charge tests', () {
13-
test('BoltLogger without a charge only redirect log event to root Logger', () {
15+
test('BoltLogger without a charge only redirect log event to root Logger',
16+
() {
1417
final records = <LogRecord>[];
1518
Logger.root.level = Level.ALL;
1619
final sub = Logger.root.onRecord.listen(records.add);
@@ -71,7 +74,8 @@ void main() {
7174
BoltLogger.charge([memoryCharge]);
7275
});
7376

74-
parameterizedGroup1('BoltLogger/extension function tests', [true, false], (bool useBoltLogger) {
77+
parameterizedGroup1('BoltLogger/extension function tests', [true, false],
78+
(bool useBoltLogger) {
7579
test('zap/shock sends a message via a ZapEvent to a charge', () {
7680
if (useBoltLogger) {
7781
BoltLogger.zap('zap');
@@ -83,9 +87,11 @@ void main() {
8387

8488
expect(memoryCharge.items.length, 2);
8589
expect(memoryCharge.items[0].origin.message, 'zap');
86-
expect(memoryCharge.items[0].origin.loggerName, useBoltLogger ? 'BoltLogger' : 'TestReferenceClass');
90+
expect(memoryCharge.items[0].origin.loggerName,
91+
useBoltLogger ? 'BoltLogger' : 'TestReferenceClass',);
8792
expect(memoryCharge.items[1].origin.message, 'shock');
88-
expect(memoryCharge.items[1].origin.loggerName, useBoltLogger ? 'BoltLogger' : 'TestReferenceClass');
93+
expect(memoryCharge.items[1].origin.loggerName,
94+
useBoltLogger ? 'BoltLogger' : 'TestReferenceClass',);
8995
expect(memoryCharge.items[1].origin.level, Level.SEVERE);
9096
});
9197

@@ -104,7 +110,8 @@ void main() {
104110
expect(memoryCharge.items[1].origin.level, Level.SEVERE);
105111
});
106112

107-
parameterizedTest1('zap/shock sends a LogLevel via a ZapEvent to a Charge', [
113+
parameterizedTest1(
114+
'zap/shock sends a LogLevel via a ZapEvent to a Charge', [
108115
Level.ALL,
109116
Level.CONFIG,
110117
Level.FINE,
@@ -223,25 +230,38 @@ void main() {
223230
expect(memoryCharge.items[1].origin.stackTrace, stackTrace);
224231
});
225232

226-
test('zap/shock sends a List with more than 3 elements via a ZapEvent to a Charge', () {
233+
test(
234+
'zap/shock sends a List with more than 3 elements via a ZapEvent to a Charge',
235+
() {
227236
final exception = Exception('exception');
228237
final stackTrace = StackTrace.current;
229238
final error = Error();
230239
if (useBoltLogger) {
231-
expect(() => BoltLogger.zap(['zap', exception, stackTrace, error]), throwsAssertionError);
232-
expect(() => BoltLogger.shock(['shock', exception, stackTrace, error]), throwsAssertionError);
240+
expect(() => BoltLogger.zap(['zap', exception, stackTrace, error]),
241+
throwsAssertionError,);
242+
expect(
243+
() => BoltLogger.shock(['shock', exception, stackTrace, error]),
244+
throwsAssertionError,);
233245
} else {
234-
expect(() => TestReferenceClass().zapExtension(['zap', exception, stackTrace, error]), throwsAssertionError);
235-
expect(() => TestReferenceClass().shockExtension(['shock', exception, stackTrace, error]), throwsAssertionError);
246+
expect(
247+
() => TestReferenceClass()
248+
.zapExtension(['zap', exception, stackTrace, error]),
249+
throwsAssertionError,);
250+
expect(
251+
() => TestReferenceClass()
252+
.shockExtension(['shock', exception, stackTrace, error]),
253+
throwsAssertionError,);
236254
}
237255
});
238256
});
239257
});
240258
}
241259

242260
class TestReferenceClass {
243-
void zapExtension(Object? message, {String? tag, Level level = Level.INFO}) => zap(message, tag: tag, level: level);
261+
void zapExtension(Object? message, {String? tag, Level level = Level.INFO}) =>
262+
zap(message, tag: tag, level: level);
244263

245-
void shockExtension(Object? message, {String? tag, Level level = Level.SEVERE}) =>
264+
void shockExtension(Object? message,
265+
{String? tag, Level level = Level.SEVERE,}) =>
246266
shock(message, tag: tag, level: level);
247267
}

0 commit comments

Comments
 (0)