Skip to content

Commit 74ba64c

Browse files
authored
Clean up logging pkg:build_runner already logs the input asset ID (#325)
Effectively undoes 83ddeb78f8 #252 Also, only log at the generator. Only print the number if there is more than 1
1 parent f2adf1e commit 74ba64c

File tree

4 files changed

+11
-21
lines changed

4 files changed

+11
-21
lines changed

CHANGELOG.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,8 @@
11
## 0.8.1
22

3+
* Cleanup logging output that duplicates headers provided by
4+
`package:build_runner`.
5+
36
* `InvalidGenerationSourceError` added an optional `element`
47
parameter to support more helpful error messages.
58

lib/src/builder.dart

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,6 @@ class _Builder extends Builder {
7272

7373
Future _generateForLibrary(
7474
LibraryElement library, BuildStep buildStep) async {
75-
log.fine('Running $_generators for ${buildStep.inputId}');
7675
var generatedOutputs =
7776
await _generate(library, _generators, buildStep).toList();
7877

@@ -204,16 +203,21 @@ class LibraryBuilder extends _Builder {
204203
Stream<GeneratedOutput> _generate(LibraryElement library,
205204
List<Generator> generators, BuildStep buildStep) async* {
206205
var libraryReader = new LibraryReader(library);
207-
for (var gen in generators) {
206+
for (var i = 0; i < generators.length; i++) {
207+
var gen = generators[i];
208208
try {
209-
log.finer('Running $gen for ${buildStep.inputId}');
209+
var msg = 'Running $gen';
210+
if (generators.length > 1) {
211+
msg = '$msg - ${i+1} of ${generators.length}';
212+
}
213+
log.fine(msg);
210214
var createdUnit = await gen.generate(libraryReader, buildStep);
211215

212216
if (createdUnit != null && createdUnit.isNotEmpty) {
213217
yield new GeneratedOutput(gen, createdUnit);
214218
}
215219
} catch (e, stack) {
216-
log.severe('Error running $gen for ${buildStep.inputId}.', e, stack);
220+
log.severe('Error running $gen', e, stack);
217221
yield new GeneratedOutput.fromError(gen, e, stack);
218222
}
219223
}

pubspec.yaml

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,6 @@ dev_dependencies:
1616
build_test: ">0.9.0 <0.11.0"
1717
collection: ^1.1.2
1818
cli_util: '>=0.1.0 <0.2.0'
19-
logging: ^0.11.3
2019
test: ^0.12.3
2120
_test_annotations:
2221
path: ./_test_annotations

test/builder_test.dart

Lines changed: 0 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@
66
import 'dart:async';
77

88
import 'package:build_test/build_test.dart';
9-
import 'package:logging/logging.dart';
109
import 'package:source_gen/source_gen.dart';
1110
import 'package:test/test.dart';
1211

@@ -191,16 +190,6 @@ void main() {
191190
});
192191
});
193192

194-
test('Error logs contain original input ids', () async {
195-
var logs = <LogRecord>[];
196-
await testBuilder(new LibraryBuilder(new _ThrowingGenerator()),
197-
{'$_pkgName|lib/a.dart': 'void hello() {}'},
198-
onLog: logs.add);
199-
await new Future(() {});
200-
expect(
201-
logs.map((l) => l.message), contains(contains('$_pkgName|lib/a.dart')));
202-
});
203-
204193
test('Should have a readable toString() message for builders', () {
205194
final builder = new LibraryBuilder(const _NoOpGenerator());
206195
expect(builder.toString(), 'Generating .g.dart: NOOP');
@@ -251,11 +240,6 @@ class _BadOutputGenerator extends Generator {
251240
Future<String> generate(LibraryReader library, _) async => 'not valid code!';
252241
}
253242

254-
class _ThrowingGenerator extends Generator {
255-
@override
256-
Future<String> generate(_, __) async => throw new UnimplementedError();
257-
}
258-
259243
final _customHeader = '// Copyright 1979';
260244

261245
const _pkgName = 'pkg';

0 commit comments

Comments
 (0)