feat(dart/transform): Avoid print in transformer code.

Tim Blasi · kegluneq · commit e310bee9e29d · 2016-04-06T22:31:08.000Z
Replace direct uses of `print` in the transformer with explicit uses of stderr. Add a few @OverRide annotations for clarification of other `print` implementations. Clarify error message on incorrect custom_annotations value. Closes angular#7855
diff --git a/modules_dart/transform/lib/src/transform/common/async_string_writer.dart b/modules_dart/transform/lib/src/transform/common/async_string_writer.dart
@@ -1,6 +1,7 @@
 library angular2.transform.common.async_string_writer;
 
 import 'dart:async';
+
 import 'package:analyzer/src/generated/java_core.dart';
 
 /// [PrintWriter] implementation that allows asynchronous printing via
@@ -18,6 +19,7 @@ class AsyncStringWriter extends PrintWriter {
 
   AsyncStringWriter([Object content = ""]) : this._(new StringBuffer(content));
 
+  @override
   void print(x) {
     _curr.write(x);
   }
@@ -54,6 +56,7 @@ class AsyncStringWriter extends PrintWriter {
     }).whenComplete(_semaphoreDecrementAndCleanup);
   }
 
+  @override
   String toString() => _bufs.map((buf) => '$buf').join('(async gap)');
 
   void _semaphoreIncrement() {
diff --git a/modules_dart/transform/lib/src/transform/common/logging.dart b/modules_dart/transform/lib/src/transform/common/logging.dart
@@ -1,6 +1,7 @@
 library angular2.src.transform.common.logging;
 
 import 'dart:async';
+import 'dart:io' show stderr;
 
 import 'package:barback/barback.dart';
 import 'package:source_span/source_span.dart';
@@ -49,12 +50,16 @@ void _logElapsed(Stopwatch timer, String operationName, AssetId assetId) {
   log.fine(buf.toString(), asset: assetId);
 }
 
-/// Prints logged messages to the console.
+/// Writes logged messages to the provided [StringSink].
 ///
-/// A simple implementation of [TransformLogger] that prints messages to the
-/// console and discards `asset` and `span` information.
-class PrintLogger implements TransformLogger {
-  void _printWithPrefix(prefix, msg) => print('$prefix: $msg');
+/// A simple implementation of [TransformLogger] that writes messages to a
+/// [StringSink] and discards `asset` and `span` information.
+class SinkLogger implements TransformLogger {
+  final StringSink _sink;
+
+  SinkLogger(this._sink);
+
+  void _printWithPrefix(prefix, msg) => _sink.writeln('$prefix: $msg');
 
   @override
   void info(msg, {AssetId asset, SourceSpan span}) =>
@@ -74,6 +79,14 @@ class PrintLogger implements TransformLogger {
   }
 }
 
+/// Prints logged messages to stderr.
+///
+/// A simple implementation of [TransformLogger] that prints messages to
+/// [stderr] and discards `asset` and `span` information.
+class PrintLogger extends SinkLogger {
+  PrintLogger() : super(stderr);
+}
+
 class PrintLoggerError extends Error {
   final String message;
   final AssetId asset;
diff --git a/modules_dart/transform/lib/src/transform/common/options_reader.dart b/modules_dart/transform/lib/src/transform/common/options_reader.dart
@@ -1,12 +1,15 @@
 library angular2.transform.common.options_reader;
 
+import 'dart:io';
+
 import 'package:barback/barback.dart';
+
 import 'annotation_matcher.dart';
 import 'mirror_mode.dart';
 import 'options.dart';
 import './url_resolver.dart';
 
-  TransformerOptions parseBarbackSettings(BarbackSettings settings) {
+TransformerOptions parseBarbackSettings(BarbackSettings settings) {
   var config = settings.configuration;
   var entryPoints = _readStringList(config, ENTRY_POINT_PARAM);
   var initReflector =
@@ -79,7 +82,8 @@ List<String> _readStringList(Map config, String paramName) {
     error = true;
   }
   if (error) {
-    print('Invalid value for "$paramName" in the Angular 2 transformer.');
+    stderr.writeln(
+        'Invalid value for "$paramName" in the Angular 2 transformer.');
   }
   return result;
 }
@@ -111,7 +115,7 @@ List<ClassDescriptor> _readCustomAnnotations(Map config) {
     }
   }
   if (error) {
-    print(CUSTOM_ANNOTATIONS_ERROR);
+    stderr.writeln(CUSTOM_ANNOTATIONS_ERROR);
   }
   return descriptors;
 }
@@ -121,7 +125,7 @@ const CUSTOM_ANNOTATIONS_ERROR = '''
   Expected something that looks like the following:
 
   transformers:
-  - angular2:
+  - angular2[/transform/codegen]:
       custom_annotations:
         - name: MyAnnotation
           import: 'package:my_package/my_annotation.dart'

Original file line number	Diff line number	Diff line change
`@@ -1,12 +1,15 @@`
`1`	`1`	`library angular2.transform.common.options_reader;`
`2`	`2`
	`3`	`+import 'dart:io';`
	`4`	`+`
`3`	`5`	`import 'package:barback/barback.dart';`
	`6`	`+`
`4`	`7`	`import 'annotation_matcher.dart';`
`5`	`8`	`import 'mirror_mode.dart';`
`6`	`9`	`import 'options.dart';`
`7`	`10`	`import './url_resolver.dart';`
`8`	`11`
`9`		`- TransformerOptions parseBarbackSettings(BarbackSettings settings) {`
	`12`	`+TransformerOptions parseBarbackSettings(BarbackSettings settings) {`
`10`	`13`	`var config = settings.configuration;`
`11`	`14`	`var entryPoints = _readStringList(config, ENTRY_POINT_PARAM);`
`12`	`15`	`var initReflector =`
`@@ -79,7 +82,8 @@ List<String> _readStringList(Map config, String paramName) {`
`79`	`82`	`error = true;`
`80`	`83`	`}`
`81`	`84`	`if (error) {`
`82`		`- print('Invalid value for "$paramName" in the Angular 2 transformer.');`
	`85`	`+ stderr.writeln(`
	`86`	`+ 'Invalid value for "$paramName" in the Angular 2 transformer.');`
`83`	`87`	`}`
`84`	`88`	`return result;`
`85`	`89`	`}`
`@@ -111,7 +115,7 @@ List<ClassDescriptor> _readCustomAnnotations(Map config) {`
`111`	`115`	`}`
`112`	`116`	`}`
`113`	`117`	`if (error) {`
`114`		`- print(CUSTOM_ANNOTATIONS_ERROR);`
	`118`	`+ stderr.writeln(CUSTOM_ANNOTATIONS_ERROR);`
`115`	`119`	`}`
`116`	`120`	`return descriptors;`
`117`	`121`	`}`
`@@ -121,7 +125,7 @@ const CUSTOM_ANNOTATIONS_ERROR = '''`
`121`	`125`	`Expected something that looks like the following:`
`122`	`126`
`123`	`127`	`transformers:`
`124`		`- - angular2:`
	`128`	`+ - angular2[/transform/codegen]:`
`125`	`129`	`custom_annotations:`
`126`	`130`	`- name: MyAnnotation`
`127`	`131`	`import: 'package:my_package/my_annotation.dart'`