Skip to content

Commit c91b5f0

Browse files
committed
[memory-bank] Drop weird protoc-generator.sh reference from documentation
1 parent d448776 commit c91b5f0

File tree

11 files changed

+0
-85
lines changed

11 files changed

+0
-85
lines changed

memory-bank/components/content-service-api.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -98,13 +98,6 @@ This script performs the following actions:
9898
- Generates TypeScript code
9999
- Updates license headers
100100

101-
### Implementation Details
102-
The `generate.sh` script uses functions from the shared script at `scripts/protoc-generator.sh`, which provides common functionality for all API components:
103-
104-
- `install_dependencies`: Installs required protoc plugins
105-
- `protoc_buf_generate`: Uses the `buf` tool to generate code based on the configuration in `buf.gen.yaml`
106-
- `update_license`: Updates license headers in generated files
107-
108101
### Building After Code Generation
109102
After regenerating the code, you may need to rebuild components that depend on the Content Service API. This typically involves:
110103

memory-bank/components/ide-metrics-api.md

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -86,15 +86,6 @@ This script performs the following actions:
8686
- Generates Java code
8787
- Updates license headers
8888

89-
### Implementation Details
90-
The `generate.sh` script uses functions from the shared script at `scripts/protoc-generator.sh` and defines some custom functions:
91-
92-
- `install_dependencies`: Installs required protoc plugins
93-
- `local_go_protoc`: Generates Go code with specific include paths
94-
- `go_protoc_gateway`: Generates gRPC Gateway code for REST endpoints
95-
- `local_java_protoc`: Generates Java code
96-
- `update_license`: Updates license headers in generated files
97-
9889
The IDE Metrics API is unique in that it generates both gRPC and REST API endpoints using the gRPC Gateway, and it also generates Java code for use in JetBrains IDE plugins.
9990

10091
### Building After Code Generation

memory-bank/components/ide-service-api.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -105,14 +105,6 @@ This script performs the following actions:
105105
- Generates TypeScript code using `ts_proto`
106106
- Updates license headers
107107

108-
### Implementation Details
109-
The `generate.sh` script uses functions from the shared script at `scripts/protoc-generator.sh`:
110-
111-
- `install_dependencies`: Installs required protoc plugins
112-
- `go_protoc`: Generates Go code
113-
- `typescript_ts_protoc`: Generates TypeScript code using ts_proto
114-
- `update_license`: Updates license headers in generated files
115-
116108
The IDE Service API generates TypeScript code using the ts_proto plugin, which creates more modern TypeScript interfaces compared to the standard protoc TypeScript generator.
117109

118110
### Building After Code Generation

memory-bank/components/image-builder-api.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -109,14 +109,6 @@ This script performs the following actions:
109109
- Patches the generated TypeScript code for compatibility
110110
- Updates license headers
111111

112-
### Implementation Details
113-
The `generate.sh` script uses functions from the shared script at `scripts/protoc-generator.sh`:
114-
115-
- `install_dependencies`: Installs required protoc plugins
116-
- `go_protoc`: Generates Go code
117-
- `typescript_protoc`: Generates TypeScript code
118-
- `update_license`: Updates license headers in generated files
119-
120112
Additionally, the script:
121113
- Generates mock implementations using `mockgen` for testing
122114
- Patches the generated TypeScript code using a script from the content-service-api

memory-bank/components/local-app-api.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -74,13 +74,6 @@ This script performs the following actions:
7474
- Generates Go code using `protoc-gen-go` and `protoc-gen-go-grpc`
7575
- Updates license headers
7676

77-
### Implementation Details
78-
The `generate.sh` script uses functions from the shared script at `scripts/protoc-generator.sh` and defines some custom functions:
79-
80-
- `install_dependencies`: Installs required protoc plugins
81-
- `local_go_protoc`: Generates Go code with specific include paths for third-party dependencies
82-
- `update_license`: Updates license headers in generated files
83-
8477
The Local App API has a dependency on the Supervisor API for tunnel visibility definitions, which is included in the protoc generation process.
8578

8679
### Building After Code Generation

memory-bank/components/registry-facade-api.md

Lines changed: 0 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -86,13 +86,6 @@ This script performs the following actions:
8686
- Generates Go code using `protoc-gen-go` and `protoc-gen-go-grpc`
8787
- Updates license headers
8888

89-
### Implementation Details
90-
The `generate.sh` script uses functions from the shared script at `scripts/protoc-generator.sh`:
91-
92-
- `install_dependencies`: Installs required protoc plugins
93-
- `go_protoc`: Generates Go code
94-
- `update_license`: Updates license headers in generated files
95-
9689
The Registry Facade API is relatively simple compared to other APIs, focusing primarily on defining the structure of image specifications rather than complex service interactions.
9790

9891
### Building After Code Generation

memory-bank/components/supervisor-api.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -149,14 +149,6 @@ This script performs the following actions:
149149
- Updates license headers
150150
- Removes trailing whitespace from Java files
151151

152-
### Implementation Details
153-
The `generate.sh` script uses functions from the shared script at `scripts/protoc-generator.sh` and defines some custom functions:
154-
155-
- `install_dependencies`: Installs required protoc plugins
156-
- `local_go_protoc`: Generates Go code with specific include paths for third-party dependencies
157-
- `go_protoc_gateway`: Generates gRPC Gateway code for REST endpoints
158-
- `update_license`: Updates license headers in generated files
159-
160152
The `generate-java.sh` script:
161153
- Temporarily modifies proto files to handle Java reserved keywords
162154
- Downloads the gRPC Java plugin if needed

memory-bank/components/usage-api.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -118,14 +118,6 @@ This script performs the following actions:
118118
- Generates Go and TypeScript code using buf
119119
- Updates license headers
120120

121-
### Implementation Details
122-
The `generate.sh` script uses functions from the shared script at `scripts/protoc-generator.sh`:
123-
124-
- `install_dependencies`: Installs required protoc plugins
125-
- `lint`: Lints the proto files using buf
126-
- `protoc_buf_generate`: Generates code using buf based on the configuration in `buf.gen.yaml`
127-
- `update_license`: Updates license headers in generated files
128-
129121
The `buf.gen.yaml` file configures the code generation:
130122
- Generates Go code with appropriate module paths
131123
- Generates TypeScript code using ts_proto with specific options for nice-grpc compatibility

memory-bank/components/ws-daemon-api.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -119,14 +119,6 @@ This script performs the following actions:
119119
- Patches the generated TypeScript code for compatibility
120120
- Updates license headers
121121

122-
### Implementation Details
123-
The `generate.sh` script uses functions from the shared script at `scripts/protoc-generator.sh`:
124-
125-
- `install_dependencies`: Installs required protoc plugins
126-
- `go_protoc`: Generates Go code
127-
- `typescript_protoc`: Generates TypeScript code
128-
- `update_license`: Updates license headers in generated files
129-
130122
Additionally, the script:
131123
- Generates mock implementations using `mockgen` for testing
132124
- Updates JSON tags in the generated Go code using `gomodifytags`

memory-bank/components/ws-manager-api.md

Lines changed: 0 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -139,14 +139,6 @@ This script performs the following actions:
139139
- Patches the generated TypeScript code for compatibility
140140
- Updates license headers
141141

142-
### Implementation Details
143-
The `generate.sh` script uses functions from the shared script at `scripts/protoc-generator.sh`:
144-
145-
- `install_dependencies`: Installs required protoc plugins
146-
- `go_protoc`: Generates Go code
147-
- `typescript_protoc`: Generates TypeScript code
148-
- `update_license`: Updates license headers in generated files
149-
150142
Additionally, the script:
151143
- Generates mock implementations using `mockgen` for testing
152144
- Patches the generated TypeScript code using a script from the content-service-api

0 commit comments

Comments
 (0)