Fork of bergundy/nexus-proto-annotations

Author: spkane31

README.md

@@ -0,0 +1,123 @@
+# nexus-proto-annotations
+
+Protobuf annotations for Nexus services and operations.
+
+## Install
+
+### With buf
+
+Add a dependency to your `buf.yaml` file:
+
+```
+deps:
+  - buf.build/nexus-rpc/nexus
+```
+
+### Unmanaged
+
+Copy the `nexus` directory from this repository and include it as one of the sources to `protoc`.
+
+## Usage
+
+### Service
+
+#### (nexus.v1.service).name
+
+`string`
+
+Defines the Nexus Service name. Defaults to the proto Service full name.
+
+**Example:**
+
+```protobuf
+syntax = "proto3";
+
+package example.v1;
+
+import "nexus/v1/options.proto";
+
+service ExampleService {
+  option (nexus.v1.service).name = "example.v1.Example";
+}
+```
+
+#### (nexus.v1.service).tags
+
+`repeated string`
+
+Tags a Nexus Service. Used by code generators for Service inclusion and exclusion.
+
+**Example:**
+
+```protobuf
+syntax = "proto3";
+
+package example.v1;
+
+import "nexus/v1/options.proto";
+
+service ExampleService {
+  option (nexus.v1.service).tags = "tag1";
+  option (nexus.v1.service).tags = "tag2";
+}
+```
+
+### Method
+
+#### (nexus.v1.operation).name
+
+`string`
+
+Defines the Nexus Operation name. Defaults to the proto Method name.
+
+**Example:**
+
+```protobuf
+syntax = "proto3";
+
+package example.v1;
+
+import "nexus/v1/options.proto";
+
+service ExampleService {
+  rpc Foo(FooInput) returns (FooResponse) {
+	option (nexus.v1.operation).name = "foo";
+  }
+}
+```
+
+#### (nexus.v1.operation).tags
+
+`repeated string`
+
+Tags a Nexus Service. Used by code generators for Operation inclusion and exclusion.
+
+**Example:**
+
+```protobuf
+syntax = "proto3";
+
+package example.v1;
+
+import "nexus/v1/options.proto";
+
+service ExampleService {
+  rpc Foo(FooInput) returns (FooResponse) {
+	option (nexus.v1.operation).tags = "tag1";
+	option (nexus.v1.operation).tags = "tag2";
+  }
+}
+```
+
+## Contribute
+
+### Generate Go files
+
+Any change in the proto definitions must be reflected in the associated Go package and commited. Run the following command on change:
+
+`buf generate`
+
+
+### Push to the buf registy
+
+`buf push`

buf.gen.yaml

@@ -0,0 +1,12 @@
+version: v2
+clean: true
+managed:
+  enabled: true
+  override:
+  - file_option: go_package_prefix
+    value: github.com/nexus-rpc/nexus-proto-annotations/go
+plugins:
+  - remote: buf.build/protocolbuffers/go
+    out: go
+    opt:
+      - paths=source_relative

buf.yaml

@@ -0,0 +1,16 @@
+version: v2
+modules:
+  - name: buf.build/nexus-rpc/nexus
+    path: .
+lint:
+  use:
+    - BASIC
+  except:
+    - FIELD_NOT_REQUIRED
+    - PACKAGE_NO_IMPORT_CYCLE
+breaking:
+  use:
+    - FILE
+  except:
+    - EXTENSION_NO_DELETE
+    - FIELD_SAME_DEFAULT

go.mod

@@ -0,0 +1,5 @@
+module github.com/nexus-rpc/nexus-proto-annotations
+
+go 1.25.4
+
+require google.golang.org/protobuf v1.36.1

go.sum

@@ -0,0 +1,6 @@
+github.com/google/go-cmp v0.5.5 h1:Khx7svrCpmxxtHBq5j2mp/xVjsi8hQMfNLvJFAlrGgU=
+github.com/google/go-cmp v0.5.5/go.mod h1:v8dTdLbMG2kIc/vJvl+f65V22dbkXbowE6jgT/gNBxE=
+golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543 h1:E7g+9GITq07hpfrRu66IVDexMakfv52eLZ2CXBWiKr4=
+golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
+google.golang.org/protobuf v1.36.1 h1:yBPeRvTftaleIgM3PZ/WBIZ7XM/eEYAaEyCwvyjq/gk=
+google.golang.org/protobuf v1.36.1/go.mod h1:9fA7Ob0pmnwhb644+1+CVWFRbNajQ6iRojtC/QF5bRE=