diff --git a/gomock/internal/mock_gomock/mock_matcher.go b/gomock/internal/mock_gomock/mock_matcher.go index b82fb75..bf3cc1e 100644 --- a/gomock/internal/mock_gomock/mock_matcher.go +++ b/gomock/internal/mock_gomock/mock_matcher.go @@ -5,6 +5,7 @@ // // mockgen -destination internal/mock_gomock/mock_matcher.go go.uber.org/mock/gomock Matcher // + // Package mock_gomock is a generated GoMock package. package mock_gomock diff --git a/gomock/mock_test.go b/gomock/mock_test.go index 41e21df..9037af1 100644 --- a/gomock/mock_test.go +++ b/gomock/mock_test.go @@ -5,6 +5,7 @@ // // mockgen -destination mock_test.go -package gomock_test -source example_test.go // + // Package gomock_test is a generated GoMock package. package gomock_test diff --git a/mockgen/internal/tests/add_generate_directive/mock.go b/mockgen/internal/tests/add_generate_directive/mock.go index 7a6169c..9c9098d 100644 --- a/mockgen/internal/tests/add_generate_directive/mock.go +++ b/mockgen/internal/tests/add_generate_directive/mock.go @@ -5,6 +5,7 @@ // // mockgen -write_generate_directive -destination mock.go -package add_generate_directive . Foo // + // Package add_generate_directive is a generated GoMock package. package add_generate_directive diff --git a/mockgen/internal/tests/aux_imports_embedded_interface/bugreport_mock.go b/mockgen/internal/tests/aux_imports_embedded_interface/bugreport_mock.go index f53bc2b..3a543f8 100644 --- a/mockgen/internal/tests/aux_imports_embedded_interface/bugreport_mock.go +++ b/mockgen/internal/tests/aux_imports_embedded_interface/bugreport_mock.go @@ -5,6 +5,7 @@ // // mockgen -aux_files faux=faux/faux.go -destination bugreport_mock.go -package bugreport -source=bugreport.go Example // + // Package bugreport is a generated GoMock package. package bugreport diff --git a/mockgen/internal/tests/const_array_length/mock.go b/mockgen/internal/tests/const_array_length/mock.go index 782c1a5..bd71ca9 100644 --- a/mockgen/internal/tests/const_array_length/mock.go +++ b/mockgen/internal/tests/const_array_length/mock.go @@ -5,6 +5,7 @@ // // mockgen -package const_length -destination mock.go -source input.go // + // Package const_length is a generated GoMock package. package const_length diff --git a/mockgen/internal/tests/copyright_file/mock.go b/mockgen/internal/tests/copyright_file/mock.go index ff04142..65fd79c 100644 --- a/mockgen/internal/tests/copyright_file/mock.go +++ b/mockgen/internal/tests/copyright_file/mock.go @@ -12,6 +12,7 @@ // // mockgen -package empty_interface -destination mock.go -source input.go -copyright_file=mock_copyright_header // + // Package empty_interface is a generated GoMock package. package empty_interface diff --git a/mockgen/internal/tests/custom_package_name/greeter/greeter_mock_test.go b/mockgen/internal/tests/custom_package_name/greeter/greeter_mock_test.go index 50362c9..e54593b 100644 --- a/mockgen/internal/tests/custom_package_name/greeter/greeter_mock_test.go +++ b/mockgen/internal/tests/custom_package_name/greeter/greeter_mock_test.go @@ -5,6 +5,7 @@ // // mockgen -source greeter.go -destination greeter_mock_test.go -package greeter // + // Package greeter is a generated GoMock package. package greeter diff --git a/mockgen/internal/tests/defined_import_local_name/mock.go b/mockgen/internal/tests/defined_import_local_name/mock.go index 3cd3498..ca9577a 100644 --- a/mockgen/internal/tests/defined_import_local_name/mock.go +++ b/mockgen/internal/tests/defined_import_local_name/mock.go @@ -5,6 +5,7 @@ // // mockgen -package defined_import_local_name -destination mock.go -source input.go -imports b_mock=bytes,c_mock=context // + // Package defined_import_local_name is a generated GoMock package. package defined_import_local_name diff --git a/mockgen/internal/tests/dot_imports/mock.go b/mockgen/internal/tests/dot_imports/mock.go index bf02da8..4e9f67e 100644 --- a/mockgen/internal/tests/dot_imports/mock.go +++ b/mockgen/internal/tests/dot_imports/mock.go @@ -5,6 +5,7 @@ // // mockgen -package dot_imports -destination mock.go -source input.go // + // Package dot_imports is a generated GoMock package. package dot_imports diff --git a/mockgen/internal/tests/empty_interface/mock.go b/mockgen/internal/tests/empty_interface/mock.go index 56a0d24..b19c4b2 100644 --- a/mockgen/internal/tests/empty_interface/mock.go +++ b/mockgen/internal/tests/empty_interface/mock.go @@ -5,6 +5,7 @@ // // mockgen -package empty_interface -destination mock.go -source input.go // + // Package empty_interface is a generated GoMock package. package empty_interface diff --git a/mockgen/internal/tests/exclude/mock.go b/mockgen/internal/tests/exclude/mock.go index b8a430f..7ab3f5f 100644 --- a/mockgen/internal/tests/exclude/mock.go +++ b/mockgen/internal/tests/exclude/mock.go @@ -5,6 +5,7 @@ // // mockgen -source=./internal/tests/exclude/interfaces.go -destination=./internal/tests/exclude/mock.go -package=exclude -exclude_interfaces=IgnoreMe,IgnoreMe2 // + // Package exclude is a generated GoMock package. package exclude diff --git a/mockgen/internal/tests/extra_import/mock.go b/mockgen/internal/tests/extra_import/mock.go index 4b887c6..b730cd3 100644 --- a/mockgen/internal/tests/extra_import/mock.go +++ b/mockgen/internal/tests/extra_import/mock.go @@ -5,6 +5,7 @@ // // mockgen -destination mock.go -package extra_import . Foo // + // Package extra_import is a generated GoMock package. package extra_import diff --git a/mockgen/internal/tests/generated_identifier_conflict/bugreport_mock.go b/mockgen/internal/tests/generated_identifier_conflict/bugreport_mock.go index 376b22c..c66a763 100644 --- a/mockgen/internal/tests/generated_identifier_conflict/bugreport_mock.go +++ b/mockgen/internal/tests/generated_identifier_conflict/bugreport_mock.go @@ -5,6 +5,7 @@ // // mockgen -destination bugreport_mock.go -package bugreport -source=bugreport.go // + // Package bugreport is a generated GoMock package. package bugreport diff --git a/mockgen/internal/tests/generics/source/mock_generics_mock.go b/mockgen/internal/tests/generics/source/mock_generics_mock.go index d92a8d4..8953118 100644 --- a/mockgen/internal/tests/generics/source/mock_generics_mock.go +++ b/mockgen/internal/tests/generics/source/mock_generics_mock.go @@ -5,6 +5,7 @@ // // mockgen --source=generics.go --destination=source/mock_generics_mock.go --package source // + // Package source is a generated GoMock package. package source diff --git a/mockgen/internal/tests/import_embedded_interface/bugreport_mock.go b/mockgen/internal/tests/import_embedded_interface/bugreport_mock.go index 54b559d..f0b9d84 100644 --- a/mockgen/internal/tests/import_embedded_interface/bugreport_mock.go +++ b/mockgen/internal/tests/import_embedded_interface/bugreport_mock.go @@ -5,6 +5,7 @@ // // mockgen -destination bugreport_mock.go -package bugreport -source=bugreport.go // + // Package bugreport is a generated GoMock package. package bugreport diff --git a/mockgen/internal/tests/import_embedded_interface/net_mock.go b/mockgen/internal/tests/import_embedded_interface/net_mock.go index 3eb47d5..8831f62 100644 --- a/mockgen/internal/tests/import_embedded_interface/net_mock.go +++ b/mockgen/internal/tests/import_embedded_interface/net_mock.go @@ -5,6 +5,7 @@ // // mockgen -destination net_mock.go -package bugreport -source=net.go // + // Package bugreport is a generated GoMock package. package bugreport diff --git a/mockgen/internal/tests/import_source/definition/source_mock.go b/mockgen/internal/tests/import_source/definition/source_mock.go index 4280080..783c5a5 100644 --- a/mockgen/internal/tests/import_source/definition/source_mock.go +++ b/mockgen/internal/tests/import_source/definition/source_mock.go @@ -5,6 +5,7 @@ // // mockgen -package source -destination source_mock.go -source=source.go // + // Package source is a generated GoMock package. package source diff --git a/mockgen/internal/tests/import_source/source_mock.go b/mockgen/internal/tests/import_source/source_mock.go index 76fcbbd..740dcfa 100644 --- a/mockgen/internal/tests/import_source/source_mock.go +++ b/mockgen/internal/tests/import_source/source_mock.go @@ -5,6 +5,7 @@ // // mockgen -destination ../source_mock.go -source=source.go // + // Package mock_source is a generated GoMock package. package mock_source diff --git a/mockgen/internal/tests/internal_pkg/subdir/internal/pkg/reflect_output/mock.go b/mockgen/internal/tests/internal_pkg/subdir/internal/pkg/reflect_output/mock.go index f1139ee..e51c0e7 100644 --- a/mockgen/internal/tests/internal_pkg/subdir/internal/pkg/reflect_output/mock.go +++ b/mockgen/internal/tests/internal_pkg/subdir/internal/pkg/reflect_output/mock.go @@ -5,6 +5,7 @@ // // mockgen -destination subdir/internal/pkg/reflect_output/mock.go go.uber.org/mock/mockgen/internal/tests/internal_pkg/subdir/internal/pkg Intf // + // Package mock_pkg is a generated GoMock package. package mock_pkg diff --git a/mockgen/internal/tests/internal_pkg/subdir/internal/pkg/source_output/mock.go b/mockgen/internal/tests/internal_pkg/subdir/internal/pkg/source_output/mock.go index 33ee528..016f1e2 100644 --- a/mockgen/internal/tests/internal_pkg/subdir/internal/pkg/source_output/mock.go +++ b/mockgen/internal/tests/internal_pkg/subdir/internal/pkg/source_output/mock.go @@ -5,6 +5,7 @@ // // mockgen -source subdir/internal/pkg/input.go -destination subdir/internal/pkg/source_output/mock.go // + // Package mock_pkg is a generated GoMock package. package mock_pkg diff --git a/mockgen/internal/tests/missing_import/output/source_mock.go b/mockgen/internal/tests/missing_import/output/source_mock.go index d63b458..4fb6542 100644 --- a/mockgen/internal/tests/missing_import/output/source_mock.go +++ b/mockgen/internal/tests/missing_import/output/source_mock.go @@ -5,6 +5,7 @@ // // mockgen -package source -destination=../output/source_mock.go -source=source.go // + // Package source is a generated GoMock package. package source diff --git a/mockgen/internal/tests/mock_in_test_package/mock_test.go b/mockgen/internal/tests/mock_in_test_package/mock_test.go index 389b83e..be55b03 100644 --- a/mockgen/internal/tests/mock_in_test_package/mock_test.go +++ b/mockgen/internal/tests/mock_in_test_package/mock_test.go @@ -5,6 +5,7 @@ // // mockgen --source=user.go --destination=mock_test.go --package=users_test // + // Package users_test is a generated GoMock package. package users_test diff --git a/mockgen/internal/tests/overlapping_methods/mock.go b/mockgen/internal/tests/overlapping_methods/mock.go index 4c8afce..139c15e 100644 --- a/mockgen/internal/tests/overlapping_methods/mock.go +++ b/mockgen/internal/tests/overlapping_methods/mock.go @@ -5,6 +5,7 @@ // // mockgen -package overlap -destination mock.go -source overlap.go -aux_files go.uber.org/mock/mockgen/internal/tests/overlapping_methods=interfaces.go // + // Package overlap is a generated GoMock package. package overlap diff --git a/mockgen/internal/tests/panicing_test/mock_test.go b/mockgen/internal/tests/panicing_test/mock_test.go index fb8c58e..ebdbd72 100644 --- a/mockgen/internal/tests/panicing_test/mock_test.go +++ b/mockgen/internal/tests/panicing_test/mock_test.go @@ -5,6 +5,7 @@ // // mockgen --source=panic.go --destination=mock_test.go --package=paniccode // + // Package paniccode is a generated GoMock package. package paniccode diff --git a/mockgen/internal/tests/self_package/mock.go b/mockgen/internal/tests/self_package/mock.go index 7aa6ddf..dc322b0 100644 --- a/mockgen/internal/tests/self_package/mock.go +++ b/mockgen/internal/tests/self_package/mock.go @@ -5,6 +5,7 @@ // // mockgen -package core -self_package go.uber.org/mock/mockgen/internal/tests/self_package -destination mock.go go.uber.org/mock/mockgen/internal/tests/self_package Methods // + // Package core is a generated GoMock package. package core diff --git a/mockgen/internal/tests/test_package/mock_test.go b/mockgen/internal/tests/test_package/mock_test.go index 6379372..364f94d 100644 --- a/mockgen/internal/tests/test_package/mock_test.go +++ b/mockgen/internal/tests/test_package/mock_test.go @@ -5,6 +5,7 @@ // // mockgen --source=user_test.go --destination=mock_test.go --package=users_test // + // Package users_test is a generated GoMock package. package users_test diff --git a/mockgen/internal/tests/typed/go.sum b/mockgen/internal/tests/typed/go.sum index e45fa7f..43a2583 100644 --- a/mockgen/internal/tests/typed/go.sum +++ b/mockgen/internal/tests/typed/go.sum @@ -1,26 +1,2 @@ -github.com/yuin/goldmark v1.4.1/go.mod h1:mwnBkeHKe2W/ZEtQ+71ViKU8L12m81fl3OWwC1Zlc8k= -golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= -golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI= golang.org/x/exp v0.0.0-20220609121020-a51bd0440498 h1:TF0FvLUGEq/8wOt/9AV1nj6D4ViZGUIGCMQfCv7VRXY= golang.org/x/exp v0.0.0-20220609121020-a51bd0440498/go.mod h1:yh0Ynu2b5ZUe3MQfp2nM0ecK7wsgouWTDN0FNeJuIys= -golang.org/x/mod v0.5.1/go.mod h1:5OXOZSfqPIIbmVBIIKWRFfZjPR0E5r58TLhUjH0a2Ro= -golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= -golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= -golang.org/x/net v0.0.0-20211015210444-4f30a5c0130f/go.mod h1:9nx3DQGgdP8bBQD5qxJ1jj9UTztislL4KSBs9R2vV5Y= -golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= -golang.org/x/sync v0.0.0-20210220032951-036812b2e83c/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= -golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= -golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= -golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= -golang.org/x/sys v0.0.0-20210423082822-04245dca01da/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= -golang.org/x/sys v0.0.0-20211019181941-9d821ace8654/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= -golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= -golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= -golang.org/x/text v0.3.6/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= -golang.org/x/text v0.3.7/go.mod h1:u+2+/6zg+i71rQMx5EYifcz6MCKuco9NR6JIITiCfzQ= -golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= -golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= -golang.org/x/tools v0.1.8/go.mod h1:nABZi5QlRsZVlzPpHl034qft6wpY4eDcsTt5AaioBiU= -golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= -golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= -golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= diff --git a/mockgen/internal/tests/typed_inorder/mock.go b/mockgen/internal/tests/typed_inorder/mock.go index 39de997..4e4bf21 100644 --- a/mockgen/internal/tests/typed_inorder/mock.go +++ b/mockgen/internal/tests/typed_inorder/mock.go @@ -5,6 +5,7 @@ // // mockgen -package typed_inorder -source=input.go -destination=mock.go -typed // + // Package typed_inorder is a generated GoMock package. package typed_inorder diff --git a/mockgen/internal/tests/unexported_method/bugreport_mock.go b/mockgen/internal/tests/unexported_method/bugreport_mock.go index 9b34080..0f11c48 100644 --- a/mockgen/internal/tests/unexported_method/bugreport_mock.go +++ b/mockgen/internal/tests/unexported_method/bugreport_mock.go @@ -5,6 +5,7 @@ // // mockgen -destination bugreport_mock.go -package bugreport -source=bugreport.go Example // + // Package bugreport is a generated GoMock package. package bugreport diff --git a/mockgen/internal/tests/vendor_dep/mock.go b/mockgen/internal/tests/vendor_dep/mock.go index 5d8a061..7862124 100644 --- a/mockgen/internal/tests/vendor_dep/mock.go +++ b/mockgen/internal/tests/vendor_dep/mock.go @@ -5,6 +5,7 @@ // // mockgen -package vendor_dep -destination mock.go go.uber.org/mock/mockgen/internal/tests/vendor_dep VendorsDep // + // Package vendor_dep is a generated GoMock package. package vendor_dep diff --git a/mockgen/internal/tests/vendor_dep/source_mock_package/mock.go b/mockgen/internal/tests/vendor_dep/source_mock_package/mock.go index 3312141..8092c70 100644 --- a/mockgen/internal/tests/vendor_dep/source_mock_package/mock.go +++ b/mockgen/internal/tests/vendor_dep/source_mock_package/mock.go @@ -5,6 +5,7 @@ // // mockgen -destination source_mock_package/mock.go -source=vendor_dep.go // + // Package mock_vendor_dep is a generated GoMock package. package mock_vendor_dep diff --git a/mockgen/internal/tests/vendor_pkg/mock.go b/mockgen/internal/tests/vendor_pkg/mock.go index 9b6264c..6276ec1 100644 --- a/mockgen/internal/tests/vendor_pkg/mock.go +++ b/mockgen/internal/tests/vendor_pkg/mock.go @@ -5,6 +5,7 @@ // // mockgen -destination mock.go -package vendor_pkg golang.org/x/tools/present Elem // + // Package vendor_pkg is a generated GoMock package. package vendor_pkg diff --git a/mockgen/mockgen.go b/mockgen/mockgen.go index feb747f..d742b32 100644 --- a/mockgen/mockgen.go +++ b/mockgen/mockgen.go @@ -314,8 +314,10 @@ func (g *generator) Generate(pkg *model.Package, outputPkgName string, outputPac } g.p("//") g.p("// Generated by this command:") + g.p("//") // only log the name of the executable, not the full path - g.p("// %v", strings.Join(append([]string{filepath.Base(os.Args[0])}, os.Args[1:]...), " ")) + g.p("//\t%v", strings.Join(append([]string{filepath.Base(os.Args[0])}, os.Args[1:]...), " ")) + g.p("//") // Get all required imports, and generate unique names for them all. im := pkg.Imports() @@ -386,6 +388,10 @@ func (g *generator) Generate(pkg *model.Package, outputPkgName string, outputPac } if *writePkgComment { + // Ensure there's an empty line before the package to follow the recommendations: + // https://github.com/golang/go/wiki/CodeReviewComments#package-comments + g.p("") + g.p("// Package %v is a generated GoMock package.", outputPkgName) } g.p("package %v", outputPkgName) diff --git a/sample/concurrent/mock/concurrent_mock.go b/sample/concurrent/mock/concurrent_mock.go index ef49c58..b397185 100644 --- a/sample/concurrent/mock/concurrent_mock.go +++ b/sample/concurrent/mock/concurrent_mock.go @@ -5,6 +5,7 @@ // // mockgen -destination mock/concurrent_mock.go go.uber.org/mock/sample/concurrent Math // + // Package mock_concurrent is a generated GoMock package. package mock_concurrent diff --git a/sample/mock_user_test.go b/sample/mock_user_test.go index 3cffce4..f5f3e69 100644 --- a/sample/mock_user_test.go +++ b/sample/mock_user_test.go @@ -5,6 +5,7 @@ // // mockgen -destination mock_user_test.go -package user_test go.uber.org/mock/sample Index,Embed,Embedded // + // Package user_test is a generated GoMock package. package user_test