Merge pull request #61 from mterwill/collapse

Adjust template to auto-collapse generated code in GitHub
twirphp · Jun 29, 2021 · bb5a2f3 · bb5a2f3
2 parents b40d2f8 + f392a03
commit bb5a2f3
Show file tree

Hide file tree

Showing 16 changed files with 19 additions and 16 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 ## [Unreleased]
 
+- Adjust generated code comment to auto-collapse in GitHub diffs
 
 ## [0.7.2] - 2021-05-12
 

diff --git a/example/generated/Twitch/Twirp/Example/Haberdasher.php b/example/generated/Twitch/Twirp/Example/Haberdasher.php
diff --git a/example/generated/Twitch/Twirp/Example/HaberdasherAbstractClient.php b/example/generated/Twitch/Twirp/Example/HaberdasherAbstractClient.php
diff --git a/example/generated/Twitch/Twirp/Example/HaberdasherClient.php b/example/generated/Twitch/Twirp/Example/HaberdasherClient.php
diff --git a/example/generated/Twitch/Twirp/Example/HaberdasherJsonClient.php b/example/generated/Twitch/Twirp/Example/HaberdasherJsonClient.php
diff --git a/example/generated/Twitch/Twirp/Example/HaberdasherServer.php b/example/generated/Twitch/Twirp/Example/HaberdasherServer.php
diff --git a/example/generated/Twitch/Twirp/Example/TwirpError.php b/example/generated/Twitch/Twirp/Example/TwirpError.php
diff --git a/protoc-gen-twirp_php/internal/gen/generator.go b/protoc-gen-twirp_php/internal/gen/generator.go
@@ -13,8 +13,8 @@ import (
 
 const twirpVersion = "v5.3.0"
 
-var globalTemplates = template.Must(template.New("").Funcs(TxtFuncMap()).ParseFS(global.FS(), "*.php"))
-var serviceTemplates = template.Must(template.New("").Funcs(TxtFuncMap()).ParseFS(service.FS(), "*.php"))
+var globalTemplates = template.Must(template.New("").Funcs(TxtFuncMap()).ParseFS(global.FS(), "*.php.tmpl"))
+var serviceTemplates = template.Must(template.New("").Funcs(TxtFuncMap()).ParseFS(service.FS(), "*.php.tmpl"))
 
 type serviceFileData struct {
 	File         *protogen.File
@@ -43,6 +43,7 @@ func Generate(plugin *protogen.Plugin, version string) error {
 					php.ServiceName(file, svc),
 					strings.Replace(tpl.Name(), "_Service_", "", -1),
 				)
+				fileName = strings.TrimSuffix(fileName, ".tmpl")
 
 				generatedFile := plugin.NewGeneratedFile(fileName, "")
 
@@ -64,6 +65,7 @@ func Generate(plugin *protogen.Plugin, version string) error {
 	for namespace := range namespaces {
 		for _, tpl := range globalTemplates.Templates() {
 			fileName := fmt.Sprintf("%s/%s", php.PathFromNamespace(namespace), tpl.Name())
+			fileName = strings.TrimSuffix(fileName, ".tmpl")
 
 			generatedFile := plugin.NewGeneratedFile(fileName, "")
 

diff --git a/...twirp_php/templates/global/TwirpError.php → ..._php/templates/global/TwirpError.php.tmpl b/...twirp_php/templates/global/TwirpError.php → ..._php/templates/global/TwirpError.php.tmpl
@@ -1,5 +1,5 @@
 <?php
-# Generated by the protocol buffer compiler (protoc-gen-twirp_php {{ .Version }}).  DO NOT EDIT!
+# Generated by the protocol buffer compiler.  DO NOT EDIT! (protoc-gen-twirp_php {{ .Version }})
 
 declare(strict_types=1);
 

diff --git a/protoc-gen-twirp_php/templates/global/global.go b/protoc-gen-twirp_php/templates/global/global.go
@@ -5,7 +5,7 @@ import (
 	"io/fs"
 )
 
-//go:embed *.php
+//go:embed *.php.tmpl
 var files embed.FS
 
 // FS returns a filesystem with the templates.

diff --git a/..._php/templates/service/AbstractClient.php → ...templates/service/AbstractClient.php.tmpl b/..._php/templates/service/AbstractClient.php → ...templates/service/AbstractClient.php.tmpl
@@ -1,5 +1,5 @@
 <?php
-# Generated by the protocol buffer compiler (protoc-gen-twirp_php {{ .Version }}).  DO NOT EDIT!
+# Generated by the protocol buffer compiler.  DO NOT EDIT! (protoc-gen-twirp_php {{ .Version }})
 # source: {{ .File.Proto.Name }}
 
 declare(strict_types=1);

diff --git a/...en-twirp_php/templates/service/Client.php → ...irp_php/templates/service/Client.php.tmpl b/...en-twirp_php/templates/service/Client.php → ...irp_php/templates/service/Client.php.tmpl
@@ -1,5 +1,5 @@
 <?php
-# Generated by the protocol buffer compiler (protoc-gen-twirp_php {{ .Version }}).  DO NOT EDIT!
+# Generated by the protocol buffer compiler.  DO NOT EDIT! (protoc-gen-twirp_php {{ .Version }})
 # source: {{ .File.Proto.Name }}
 
 declare(strict_types=1);

diff --git a/...wirp_php/templates/service/JsonClient.php → ...php/templates/service/JsonClient.php.tmpl b/...wirp_php/templates/service/JsonClient.php → ...php/templates/service/JsonClient.php.tmpl
@@ -1,5 +1,5 @@
 <?php
-# Generated by the protocol buffer compiler (protoc-gen-twirp_php {{ .Version }}).  DO NOT EDIT!
+# Generated by the protocol buffer compiler.  DO NOT EDIT! (protoc-gen-twirp_php {{ .Version }})
 # source: {{ .File.Proto.Name }}
 
 declare(strict_types=1);

diff --git a/...en-twirp_php/templates/service/Server.php → ...irp_php/templates/service/Server.php.tmpl b/...en-twirp_php/templates/service/Server.php → ...irp_php/templates/service/Server.php.tmpl
@@ -1,5 +1,5 @@
 <?php
-# Generated by the protocol buffer compiler (protoc-gen-twirp_php {{ .Version }}).  DO NOT EDIT!
+# Generated by the protocol buffer compiler.  DO NOT EDIT! (protoc-gen-twirp_php {{ .Version }})
 # source: {{ .File.Proto.Name }}
 
 declare(strict_types=1);

diff --git a/...twirp_php/templates/service/_Service_.php → ..._php/templates/service/_Service_.php.tmpl b/...twirp_php/templates/service/_Service_.php → ..._php/templates/service/_Service_.php.tmpl
@@ -1,5 +1,5 @@
 <?php
-# Generated by the protocol buffer compiler (protoc-gen-twirp_php {{ .Version }}).  DO NOT EDIT!
+# Generated by the protocol buffer compiler.  DO NOT EDIT! (protoc-gen-twirp_php {{ .Version }})
 # source: {{ .File.Proto.Name }}
 
 declare(strict_types=1);

diff --git a/protoc-gen-twirp_php/templates/service/service.go b/protoc-gen-twirp_php/templates/service/service.go
@@ -5,7 +5,7 @@ import (
 	"io/fs"
 )
 
-//go:embed *.php
+//go:embed *.php.tmpl
 var files embed.FS
 
 // FS returns a filesystem with the templates.