Support deprecated annotation, closes #3

README.md

@@ -17,10 +17,11 @@
 1. [Support for well-known wrapper types](https://github.com/grpc-ecosystem/protoc-gen-grpc-gateway-ts/pull/50)
 2. Updated to support gRPC gateway v2 and latest protoc-gen-go
 3. Support for proto3 optional fields
-4. Updated to satisfy strict TS and eslint checks
-5. Generator options managed through standard flags
-6. Fixes inconsistent field naming when fields contain numbers, e.g. `k8s_field` --> `k8sField`
-7. Fixes module names when they contain dots or dashes
+4. Support for deprecated message and field annotations
+5. Updated to satisfy strict TS and eslint checks
+6. Generator options managed through standard flags
+7. Fixes inconsistent field naming when fields contain numbers, e.g. `k8s_field` --> `k8sField`
+8. Fixes module names when they contain dots or dashes
 
 ## Getting Started:
 

data/message.go

@@ -6,6 +6,8 @@ type Message struct {
  Nested bool
  // Name is the name of the Message
  Name string
+ // Message has been marked as deprecated
+ IsDeprecated bool
  //FQType is the fully qualified type name for the message itself
  FQType string
  // Enums is a list of NestedEnums inside
@@ -88,6 +90,8 @@ type Field struct {
  IsOneOfField bool
  // IsOptional indicates the field is flagged as optional.
  IsOptional bool
+ // IsDeprecated indicates the field is deprecated.
+ IsDeprecated bool
  // Message is the reference back to the parent message
  Message *Message
  // OneOfIndex is the index in the one of fields

generator/template.go

@@ -36,19 +36,37 @@ export enum {{.Name}} {
 
 {{- define "messages" -}}
 {{- range . -}}
+{{- if .IsDeprecated -}}
+/**
+ * @deprecated This message has been deprecated.
+ */
+{{end -}}
 {{- if .HasOneOfFields -}}
 type Base{{.Name}} = {
 {{- range .NonOneOfFields}}
+ {{if .IsDeprecated -}}
+ /** @deprecated This field has been deprecated. */
+ {{end -}}
  {{tsTypeKey .}}: {{tsTypeDef .}};
 {{- end}}
 {{- range .OptionalFields -}}
+ {{if .IsDeprecated -}}
+ /** @deprecated This field has been deprecated. */
+ {{end -}}
  {{tsTypeKey .}}: {{tsTypeDef .}};
 {{- end}}
 };
 
 export type {{.Name}} = Base{{.Name}}
 {{- range $groupId, $fields := .OneOfFieldsGroups}} &
- OneOf<{ {{range $index, $field := $fields}}{{fieldName $field.Name}}: {{tsType $field}}{{if (lt (add $index 1) (len $fields))}}; {{end}}{{end}} }>;
+ OneOf<{
+{{- range $index, $field := $fields}}
+ {{if $field.IsDeprecated -}}
+ /** @deprecated This field has been deprecated. */
+ {{end -}}
+ {{fieldName $field.Name}}: {{tsType $field}};
+{{- end}}
+ }>;
 {{- end -}}
 
 {{/* Standard, non oneof messages */}}
@@ -59,6 +77,9 @@ export type {{.Name}} = Base{{.Name}}
 {{- else -}}
  export type {{.Name}} = {
 {{- range .Fields}}
+ {{if .IsDeprecated -}}
+ /** @deprecated This field has been deprecated. */
+ {{end -}}
  {{tsTypeKey .}}: {{tsTypeDef .}};
 {{- end}}
 };

registry/field.go

@@ -60,6 +60,7 @@ func (r *Registry) analyseField(fileData *data.File, msgData *data.Message, pack
  IsExternal: isExternal,
  IsOneOfField: f.OneofIndex != nil,
  IsOptional: f.GetProto3Optional(),
+ IsDeprecated: f.GetOptions().GetDeprecated(),
  Message: msgData,
  }
 

registry/message.go

@@ -55,6 +55,7 @@ func (r *Registry) analyseMessage(fileData *data.File, packageName, fileName str
  data := data.NewMessage()
  data.Name = packageIdentifier
  data.FQType = fqName
+ data.IsDeprecated = message.GetOptions().GetDeprecated()
 
  newParents := append(parents, message.GetName())