Merge pull request #28 from davidmorgan/better-error-messages

Improve error output on failure to generate.

CHANGELOG.md

@@ -1,9 +1,13 @@
 # Changelog
 
+## 0.1.1
+
+- Improve error output on failure to generate.
+
 ## 0.1.0
 
- - Upgrade to source_gen 0.5.0.
- - Breaking change; see example for required changes to build.dart.
+- Upgrade to source_gen 0.5.0.
+- Breaking change; see example for required changes to build.dart.
 
 ## 0.0.6
 

built_value/pubspec.yaml

@@ -1,5 +1,5 @@
 name: built_value
-version: 0.1.0
+version: 0.1.1
 description: >
   Value types with builders. This library is the runtime dependency.
 authors:

built_value_generator/lib/built_value_generator.dart

@@ -47,9 +47,7 @@ class BuiltValueGenerator extends Generator {
     ]);
 
     if (errors.isNotEmpty) {
-      throw new InvalidGenerationSourceError(
-          'Please make changes to use built_value.',
-          todo: errors.join(' '));
+      throw _makeError(errors);
     }
 
     return generateCode(className, fields, builderFields);
@@ -69,7 +67,7 @@ class BuiltValueGenerator extends Generator {
     final name = classElement.displayName;
 
     if (!classElement.isAbstract) {
-      result.add('Make class abstract');
+      result.add('Make class abstract.');
     }
 
     final expectedConstructor = '$name._()';
@@ -100,7 +98,7 @@ class BuiltValueGenerator extends Generator {
   Iterable<String> checkBuilderClass(
       String className, ClassElement classElement) {
     if (classElement == null) {
-      return <String>['Add abstract class ${className}Builder'];
+      return <String>['Add abstract class: ${className}Builder'];
     }
 
     final result = <String>[];
@@ -164,7 +162,7 @@ class BuiltValueGenerator extends Generator {
       final fieldName = field.displayName;
       if (field.getter == null || field.getter.isSynthetic) {
         checkFieldTypes = false;
-        result.add('Make field $fieldName a getter');
+        result.add('Make field $fieldName a getter.');
       }
     }
 
@@ -174,7 +172,7 @@ class BuiltValueGenerator extends Generator {
           field.getter.isAbstract ||
           !field.getter.isSynthetic) {
         checkFieldTypes = false;
-        result.add('Make builder field $fieldName a normal field');
+        result.add('Make builder field $fieldName a normal field.');
       }
     }
 
@@ -199,7 +197,7 @@ class BuiltValueGenerator extends Generator {
             fieldType.replaceAll('Built', '') !=
                 builderFieldType.replaceAll('Builder', '')) {
           result.add(
-              'Make builder field ${field.displayName} have type $fieldType');
+              'Make builder field ${field.displayName} have type: $fieldType');
         }
       }
     }
@@ -327,4 +325,14 @@ class BuiltValueGenerator extends Generator {
 
     return result.toString();
   }
+
+  InvalidGenerationSourceError _makeError(Iterable<String> todos) {
+    final message = new StringBuffer(
+        'Please make the following changes to use built_value:\n');
+    for (var i = 0; i != todos.length; ++i) {
+      message.write('\n${i + 1}. ${todos.elementAt(i)}');
+    }
+
+    return new InvalidGenerationSourceError(message.toString());
+  }
 }

built_value_generator/pubspec.yaml

@@ -1,5 +1,5 @@
 name: built_value_generator
-version: 0.1.0
+version: 0.1.1
 description: >
   Value types with builders. This library is the dev dependency.
 authors:
@@ -13,8 +13,8 @@ dependencies:
   analyzer: '>=0.27.1 <0.28.0'
   build: '^0.3.0'
   built_collection: '^1.0.0'
-  built_value: '^0.1.0'
-  source_gen: '>=0.5.0 <0.6.0'
+  built_value: '^0.1.1'
+  source_gen: '>=0.5.0+03 <0.6.0'
   quiver: '>=0.21.0 <0.22.0'
 
 dev_dependencies:

built_value_generator/test/built_value_generator_test.dart

@@ -22,7 +22,7 @@ abstract class Value extends Built<Value, ValueBuilder> {
 abstract class ValueBuilder extends Builder<Value, ValueBuilder> {
   ValueBuilder._();
   factory ValueBuilder() = _\$ValueBuilder;
-}'''), contains("TODO: Import generated part: part 'value.g.dart';"));
+}'''), contains("1. Import generated part: part 'value.g.dart';"));
     });
 
     test('suggests to make value class abstract', () async {
@@ -36,7 +36,7 @@ class Value extends Built<Value, ValueBuilder> {
 abstract class ValueBuilder extends Builder<Value, ValueBuilder> {
   ValueBuilder._();
   factory ValueBuilder() = _\$ValueBuilder;
-}'''), contains("TODO: Make class abstract"));
+}'''), contains("1. Make class abstract."));
     });
 
     test('suggests to add constructor to value class', () async {
@@ -49,7 +49,7 @@ abstract class Value extends Built<Value, ValueBuilder> {
 abstract class ValueBuilder extends Builder<Value, ValueBuilder> {
   ValueBuilder._();
   factory ValueBuilder() = _\$ValueBuilder;
-}'''), contains("TODO: Make class have exactly one constructor: Value._();"));
+}'''), contains("1. Make class have exactly one constructor: Value._();"));
     });
 
     test('allows code in constructor of value class', () async {
@@ -68,7 +68,7 @@ abstract class ValueBuilder extends Builder<Value, ValueBuilder> {
   factory ValueBuilder() = _\$ValueBuilder;
 }'''),
           isNot(contains(
-              "TODO: Make class have exactly one constructor: Value._();")));
+              "1. Make class have exactly one constructor: Value._();")));
     });
 
     test('suggests to add factory to value class', () async {
@@ -83,7 +83,7 @@ abstract class ValueBuilder extends Builder<Value, ValueBuilder> {
   ValueBuilder._();
   factory ValueBuilder() = _\$ValueBuilder;
 }'''),
-          contains("TODO: Make class have factory: "
+          contains("1. Make class have factory: "
               "factory Value([updates(ValueBuilder b)]) = _\$Value;"));
     });
 
@@ -94,7 +94,7 @@ part 'value.g.dart';
 abstract class Value extends Built<Value, ValueBuilder> {
   Value._();
   factory Value([updates(ValueBuilder b)]) = _\$Value;
-}'''), contains("TODO: Add abstract class ValueBuilder"));
+}'''), contains("1. Add abstract class: ValueBuilder"));
     });
 
     test('suggests to make builder class abstract', () async {
@@ -108,7 +108,7 @@ abstract class Value extends Built<Value, ValueBuilder> {
 class ValueBuilder extends Builder<Value, ValueBuilder> {
   ValueBuilder._();
   factory ValueBuilder() = _\$ValueBuilder;
-}'''), contains("TODO: Make builder class abstract"));
+}'''), contains("1. Make builder class abstract"));
     });
 
     test('suggests to add constructor to builder class', () async {
@@ -123,7 +123,7 @@ abstract class Value extends Built<Value, ValueBuilder> {
 abstract class ValueBuilder extends Builder<Value, ValueBuilder> {
   factory ValueBuilder() = _\$ValueBuilder;
 }'''),
-          contains("TODO: Make builder class "
+          contains("1. Make builder class "
               "have exactly one constructor: ValueBuilder._();"));
     });
 
@@ -139,7 +139,7 @@ abstract class Value extends Built<Value, ValueBuilder> {
 abstract class ValueBuilder extends Builder<Value, ValueBuilder> {
   ValueBuilder._();
 }'''),
-          contains("TODO: Make builder class have exactly one factory: "
+          contains("1. Make builder class have exactly one factory: "
               "factory ValueBuilder() = _\$ValueBuilder;"));
     });
 
@@ -156,7 +156,7 @@ abstract class ValueBuilder extends Builder<Value, ValueBuilder> {
   ValueBuilder._();
   factory ValueBuilder() = _\$ValueBuilder;
   int foo;
-}'''), contains("TODO: Make field foo a getter"));
+}'''), contains("1. Make field foo a getter."));
     });
 
     test('suggests builder fields must be getters', () async {
@@ -172,7 +172,7 @@ abstract class ValueBuilder extends Builder<Value, ValueBuilder> {
   ValueBuilder._();
   factory ValueBuilder() = _\$ValueBuilder;
   int get foo;
-}'''), contains("TODO: Make builder field foo a normal field"));
+}'''), contains("1. Make builder field foo a normal field."));
     });
 
     test('suggests builder fields must be in sync', () async {
@@ -187,7 +187,7 @@ abstract class Value extends Built<Value, ValueBuilder> {
 abstract class ValueBuilder extends Builder<Value, ValueBuilder> {
   ValueBuilder._();
   factory ValueBuilder() = _\$ValueBuilder;
-}'''), contains("TODO: Make builder have exactly these fields: foo"));
+}'''), contains("1. Make builder have exactly these fields: foo"));
     });
 
     test('suggests builder fields must be same type', () async {
@@ -203,7 +203,7 @@ abstract class ValueBuilder extends Builder<Value, ValueBuilder> {
   ValueBuilder._();
   factory ValueBuilder() = _\$ValueBuilder;
   String foo;
-}'''), contains("TODO: Make builder field foo have type int"));
+}'''), contains("1. Make builder field foo have type: int"));
     });
 
     test('ignores setters', () async {

example/pubspec.yaml

@@ -1,5 +1,5 @@
 name: example
-version: 0.1.0
+version: 0.1.1
 description: >
   Just an example, not for publishing.
 authors:
@@ -11,8 +11,8 @@ environment:
 
 dependencies:
   built_collection: '^1.0.0'
-  built_value: '^0.1.0'
+  built_value: '^0.1.1'
 
 dev_dependencies:
-  built_value_generator: '^0.1.0'
+  built_value_generator: '^0.1.1'
   test: any