Skip to content

Commit c3a99e8

Browse files
committed
Geneate with comments
1 parent 753ea3c commit c3a99e8

File tree

8 files changed

+46
-21
lines changed

8 files changed

+46
-21
lines changed

pkg/capabilities/v2/chain-capabilities/evm/server/client_server_gen.go

Lines changed: 10 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

pkg/capabilities/v2/consensus/server/consensus_server_gen.go

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

pkg/capabilities/v2/protoc/pkg/template_generator.go

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -185,6 +185,20 @@ func (t *TemplateGenerator) runTemplate(name, tmplText string, args any, partial
185185
return "", fmt.Errorf("unsupported mode: %s", md.Mode)
186186
}
187187
},
188+
"CleanComments": func(line string) string {
189+
line = strings.TrimSpace(line)
190+
switch {
191+
case strings.HasPrefix(line, "//"):
192+
return strings.TrimSpace(strings.TrimPrefix(line, "//"))
193+
case strings.HasPrefix(line, "/*"):
194+
line = strings.TrimPrefix(line, "/*")
195+
line = strings.TrimSuffix(line, "*/")
196+
return strings.TrimSpace(line)
197+
default:
198+
return line
199+
}
200+
},
201+
188202
"ConfigType": func(s *protogen.Service) (string, error) {
189203
md, err := getCapabilityMetadata(s)
190204
if err != nil {

pkg/capabilities/v2/protoc/pkg/templates/server.go.tmpl

Lines changed: 12 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -29,24 +29,23 @@ var _ = emptypb.Empty{}
2929
{{ range .Services}}
3030
{{ $hasTriggers := false }}
3131
{{ $hasActions := false }}
32-
{{ $service := . }}
33-
{{ if .Comments.Leading.String }}//{{.GoName}}Capability {{.Comments.Leading.String}} {{ end -}}
34-
type {{.GoName}}Capability interface { {{- if .Comments.Trailing.String }}//{{.GoName}}Capability {{.Comments.Trailing.String}} {{ end }}
32+
{{ $service := . -}}
33+
{{ if .Comments.Leading.String }}//{{.GoName}}Capability {{CleanComments .Comments.Leading.String}} {{ end }}
34+
type {{.GoName}}Capability interface { {{- if .Comments.Trailing.String }}//{{.GoName}}Capability {{CleanComments .Comments.Trailing.String}} {{ end }}
3535
{{- range .Methods}}
3636
{{- if isTrigger . }}
3737
{{ $hasTriggers = true }}
38-
{{- if .Comments.Leading.String }}//Register{{.GoName}} registration for {{.Comments.Leading.String}} {{ end -}}
39-
Register{{.GoName}}(ctx context.Context, triggerID string, metadata capabilities.RequestMetadata, input *{{ImportAlias .Input.GoIdent.GoImportPath}}.{{.Input.GoIdent.GoName}}) (<- chan capabilities.TriggerAndId[*{{ImportAlias .Output.GoIdent.GoImportPath}}.{{.Output.GoIdent.GoName}}], error) {{- if .Comments.Trailing.String }}// {{.Comments.Trailing.String}} {{ end }}
40-
{{ if .Comments.Leading.String }}//Unregister{{.GoName}} unregistration for {{.Comments.Leading.String}} {{ end }}
41-
Unregister{{.GoName}}(ctx context.Context, triggerID string, metadata capabilities.RequestMetadata, input *{{ImportAlias .Input.GoIdent.GoImportPath}}.{{.Input.GoIdent.GoName}}) error {{- if .Comments.Trailing.String }}// {{.Comments.Trailing.String}} {{ end -}}
38+
{{- if .Comments.Leading.String }}//Register{{.GoName}} registration for {{CleanComments .Comments.Leading.String}} {{ end }}
39+
Register{{.GoName}}(ctx context.Context, triggerID string, metadata capabilities.RequestMetadata, input *{{ImportAlias .Input.GoIdent.GoImportPath}}.{{.Input.GoIdent.GoName}}) (<- chan capabilities.TriggerAndId[*{{ImportAlias .Output.GoIdent.GoImportPath}}.{{.Output.GoIdent.GoName}}], error) {{- if .Comments.Trailing.String }}// {{CleanComments .Comments.Trailing.String}} {{ end }}
40+
{{ if .Comments.Leading.String }}//Unregister{{.GoName}} unregistration for {{CleanComments .Comments.Leading.String}} {{ end }}
41+
Unregister{{.GoName}}(ctx context.Context, triggerID string, metadata capabilities.RequestMetadata, input *{{ImportAlias .Input.GoIdent.GoImportPath}}.{{.Input.GoIdent.GoName}}) error {{- if .Comments.Trailing.String }}// {{CleanComments .Comments.Trailing.String}} {{ end }}
4242
{{- else }}
4343
{{ $hasActions = true }}
44-
{{- if .Comments.Leading.String }}//{{.GoName}} {{.Comments.Leading.String}} {{ end -}}
45-
{{.GoName}}(ctx context.Context, metadata capabilities.RequestMetadata, input *{{ImportAlias .Input.GoIdent.GoImportPath}}.{{.Input.GoIdent.GoName}} {{if ne "emptypb.Empty" (ConfigType $service)}}, {{(ConfigType $service)}}{{ end }}) (*{{ImportAlias .Output.GoIdent.GoImportPath}}.{{.Output.GoIdent.GoName}}, error) {{- if .Comments.Trailing.String }}// {{.Comments.Trailing.String}} {{ end -}}
46-
{{- end }}
44+
{{- if .Comments.Leading.String }}//{{.GoName}} {{CleanComments .Comments.Leading.String}} {{ end }}
45+
{{.GoName}}(ctx context.Context, metadata capabilities.RequestMetadata, input *{{ImportAlias .Input.GoIdent.GoImportPath}}.{{.Input.GoIdent.GoName}} {{if ne "emptypb.Empty" (ConfigType $service)}}, {{(ConfigType $service)}}{{ end }}) (*{{ImportAlias .Output.GoIdent.GoImportPath}}.{{.Output.GoIdent.GoName}}, error) {{- if .Comments.Trailing.String }}// {{CleanComments .Comments.Trailing.String}} {{ end }}
46+
{{ end }}
4747
{{- end }}
4848

49-
5049
Start(ctx context.Context) error
5150
Close() error
5251
HealthReport() map[string]error
@@ -63,9 +62,8 @@ func New{{.GoName}}Server(capability {{.GoName}}Capability) *{{.GoName}}Server {
6362
stopCh: stopCh,
6463
}
6564
}
66-
67-
{{ if .Comments.Leading.String }}//{{.GoName}}Server {{.Comments.Leading.String}} {{ end -}}
68-
type {{.GoName}}Server struct { {{- if .Comments.Trailing.String }}// {{.Comments.Trailing.String}} {{ end -}}
65+
{{ if .Comments.Leading.String }}//{{.GoName}}Server {{CleanComments .Comments.Leading.String}} {{ end }}
66+
type {{.GoName}}Server struct { {{- if .Comments.Trailing.String }}// {{CleanComments .Comments.Trailing.String}} {{ end }}
6967
{{.GoName|LowerFirst}}Capability
7068
capabilityRegistry core.CapabilitiesRegistry
7169
stopCh chan struct{}

pkg/capabilities/v2/protoc/pkg/test_capabilities/actionandtrigger/server/action_and_trigger_server_gen.go

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

pkg/capabilities/v2/protoc/pkg/test_capabilities/basicaction/server/basic_action_server_gen.go

Lines changed: 6 additions & 7 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

pkg/capabilities/v2/protoc/pkg/test_capabilities/consensus/server/consensus_server_gen.go

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

pkg/capabilities/v2/triggers/cron/server/trigger_server_gen.go

Lines changed: 1 addition & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)