Include the source file name in the generated header (google#125)

sigurdm · Sep 7, 2018 · 8c22ab8 · 8c22ab8
1 parent ed85e03
commit 8c22ab8
Show file tree

Hide file tree

Showing 20 changed files with 24 additions and 3 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,8 +1,11 @@
+## 0.10.2
+
+* Add link to source file in generated code.
+
 ## 0.10.1
 
-* Breaking change: Prefix generated Dart proto imports by proto file path instead of by package.
+* Prefix generated Dart proto imports by proto file path instead of by package.
   Tighten up member name checks for generated enum classes.
-  Requires package:protobuf version 0.10.2 or newer.
 
 ## 0.10.0
 

diff --git a/lib/file_generator.dart b/lib/file_generator.dart
@@ -510,6 +510,7 @@ import 'package:grpc/grpc.dart';
     out.println('''
 ///
 //  Generated code. Do not modify.
+//  source: ${descriptor.name}
 ///
 // ignore_for_file: non_constant_identifier_names,library_prefixes,unused_import
 ''');

diff --git a/lib/src/dart_options.pb.dart b/lib/src/dart_options.pb.dart
@@ -1,5 +1,6 @@
 ///
 //  Generated code. Do not modify.
+//  source: dart_options.proto
 ///
 // ignore_for_file: non_constant_identifier_names,library_prefixes,unused_import
 

diff --git a/lib/src/descriptor.pb.dart b/lib/src/descriptor.pb.dart
@@ -1,5 +1,6 @@
 ///
 //  Generated code. Do not modify.
+//  source: descriptor.proto
 ///
 // ignore_for_file: non_constant_identifier_names,library_prefixes,unused_import
 

diff --git a/lib/src/descriptor.pbenum.dart b/lib/src/descriptor.pbenum.dart
@@ -1,5 +1,6 @@
 ///
 //  Generated code. Do not modify.
+//  source: descriptor.proto
 ///
 // ignore_for_file: non_constant_identifier_names,library_prefixes,unused_import
 

diff --git a/lib/src/plugin.pb.dart b/lib/src/plugin.pb.dart
@@ -1,5 +1,6 @@
 ///
 //  Generated code. Do not modify.
+//  source: plugin.proto
 ///
 // ignore_for_file: non_constant_identifier_names,library_prefixes,unused_import
 

diff --git a/pubspec.yaml b/pubspec.yaml
@@ -1,5 +1,5 @@
 name: protoc_plugin
-version: 0.10.1
+version: 0.10.2
 author: Dart Team <[email protected]>
 description: Protoc compiler plugin to generate Dart code
 homepage: https://github.com/dart-lang/dart-protoc-plugin

diff --git a/test/goldens/grpc_service.pb b/test/goldens/grpc_service.pb
@@ -1,5 +1,6 @@
 ///
 //  Generated code. Do not modify.
+//  source: test
 ///
 // ignore_for_file: non_constant_identifier_names,library_prefixes,unused_import
 

diff --git a/test/goldens/grpc_service.pbgrpc b/test/goldens/grpc_service.pbgrpc
@@ -1,5 +1,6 @@
 ///
 //  Generated code. Do not modify.
+//  source: test
 ///
 // ignore_for_file: non_constant_identifier_names,library_prefixes,unused_import
 

diff --git a/test/goldens/header_in_package.pb b/test/goldens/header_in_package.pb
@@ -1,5 +1,6 @@
 ///
 //  Generated code. Do not modify.
+//  source: test
 ///
 // ignore_for_file: non_constant_identifier_names,library_prefixes,unused_import
 

diff --git a/test/goldens/header_with_fixnum.pb b/test/goldens/header_with_fixnum.pb
@@ -1,5 +1,6 @@
 ///
 //  Generated code. Do not modify.
+//  source: test
 ///
 // ignore_for_file: non_constant_identifier_names,library_prefixes,unused_import
 

diff --git a/test/goldens/imports.pb b/test/goldens/imports.pb
@@ -1,5 +1,6 @@
 ///
 //  Generated code. Do not modify.
+//  source: test.proto
 ///
 // ignore_for_file: non_constant_identifier_names,library_prefixes,unused_import
 

diff --git a/test/goldens/imports.pbjson b/test/goldens/imports.pbjson
@@ -1,5 +1,6 @@
 ///
 //  Generated code. Do not modify.
+//  source: test.proto
 ///
 // ignore_for_file: non_constant_identifier_names,library_prefixes,unused_import
 
diff --git a/test/goldens/oneMessage.pb b/test/goldens/oneMessage.pb
@@ -1,5 +1,6 @@
 ///
 //  Generated code. Do not modify.
+//  source: test
 ///
 // ignore_for_file: non_constant_identifier_names,library_prefixes,unused_import
 

diff --git a/test/goldens/oneMessage.pbjson b/test/goldens/oneMessage.pbjson
@@ -1,5 +1,6 @@
 ///
 //  Generated code. Do not modify.
+//  source: test
 ///
 // ignore_for_file: non_constant_identifier_names,library_prefixes,unused_import
 

diff --git a/test/goldens/service.pb b/test/goldens/service.pb
@@ -1,5 +1,6 @@
 ///
 //  Generated code. Do not modify.
+//  source: test
 ///
 // ignore_for_file: non_constant_identifier_names,library_prefixes,unused_import
 

diff --git a/test/goldens/service.pbserver b/test/goldens/service.pbserver
@@ -1,5 +1,6 @@
 ///
 //  Generated code. Do not modify.
+//  source: test
 ///
 // ignore_for_file: non_constant_identifier_names,library_prefixes,unused_import
 

diff --git a/test/goldens/topLevelEnum.pb b/test/goldens/topLevelEnum.pb
@@ -1,5 +1,6 @@
 ///
 //  Generated code. Do not modify.
+//  source: test
 ///
 // ignore_for_file: non_constant_identifier_names,library_prefixes,unused_import
 

diff --git a/test/goldens/topLevelEnum.pbenum b/test/goldens/topLevelEnum.pbenum
@@ -1,5 +1,6 @@
 ///
 //  Generated code. Do not modify.
+//  source: test
 ///
 // ignore_for_file: non_constant_identifier_names,library_prefixes,unused_import
 

diff --git a/test/goldens/topLevelEnum.pbjson b/test/goldens/topLevelEnum.pbjson
@@ -1,5 +1,6 @@
 ///
 //  Generated code. Do not modify.
+//  source: test
 ///
 // ignore_for_file: non_constant_identifier_names,library_prefixes,unused_import