mark deprecated methods and print which method use instead

webrpc · Oct 18, 2024 · ccce583 · ccce583
1 parent 5275eca
commit ccce583
Show file tree

Hide file tree

Showing 4 changed files with 24 additions and 4 deletions.
diff --git a/_examples/golang-basics/example.gen.go b/_examples/golang-basics/example.gen.go
diff --git a/_examples/golang-basics/example.ridl b/_examples/golang-basics/example.ridl
@@ -95,6 +95,10 @@ service ExampleService
  @internal
  - Status() => (status: bool)
  - Version() => (version: Version)
+ # Get user endpoint
+ #
+ # gives you basic info about user
+ @deprecated:GetUserV2
  - GetUser(header: map<string,string>, userID: uint64) => (user: User)
  - FindUser(s: SearchFilter) => (name: string, user: User)
  - LogEvent(event: string)
diff --git a/_examples/golang-basics/example_test.go b/_examples/golang-basics/example_test.go
@@ -10,7 +10,7 @@ import (
 )
 
 var (
- client ExampleService
+ client ExampleServiceClient
 )
 
 // func TestMain()

diff --git a/types.go.tmpl b/types.go.tmpl
@@ -70,6 +70,10 @@ type {{$service.Name}} interface {
  // {{ replaceAll $comment "\"" "'" }}
  {{- end }}
  {{- end }}
+ {{- $deprecated := index $method.Annotations "deprecated" -}}
+ {{- if $deprecated }}
+ // Deprecated: {{ if ne $deprecated.Value "" }}use {{ $deprecated.Value }}{{ end }}
+ {{- end }}
  {{ if eq $method.StreamOutput true -}}
  {{$method.Name}}(ctx context.Context{{range $_, $input := $method.Inputs}}, {{$input.Name}} {{template "field" dict "Name" $input.Name "Type" $input.Type "TypeMap" $typeMap "TypePrefix" $typePrefix "Optional" $input.Optional "TypeMeta" $input.Meta}}{{end}}, stream {{$method.Name}}StreamWriter) error
  {{- else -}}
@@ -172,6 +176,10 @@ type {{$service.Name}}Client interface {
  // {{ replaceAll $comment "\"" "'" }}
  {{- end }}
  {{- end }}
+ {{- $deprecated := index $method.Annotations "deprecated" -}}
+ {{- if $deprecated }}
+ // Deprecated: {{ if ne $deprecated.Value "" }}use {{ $deprecated.Value }}{{ end }}
+ {{- end }}
  {{ if eq $method.StreamOutput true -}}
  {{$method.Name}}(ctx context.Context{{range $_, $input := $method.Inputs}}, {{$input.Name}} {{template "field" dict "Name" $input.Name "Type" $input.Type "TypeMap" $typeMap "TypePrefix" $typePrefix "Optional" $input.Optional "TypeMeta" $input.Meta}}{{end}}) ({{$method.Name}}StreamReader, error)
  {{- else -}}