Skip to content

Go: prune excessive comments #8152

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
jkschneider merged 2 commits into from
Jun 30, 2026
+16 −632
Merged

Go: prune excessive comments #8152

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0ff5c3e
Remove excessive comments
greg-at-moderne Jun 30, 2026
eb2a7d4
Remove excessive comments
greg-at-moderne Jun 30, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 0 additions & 14 deletions rewrite-go/cmd/explore/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,9 +43,7 @@ type Greeter struct {
Prefix string
}

// Greet returns a greeting for the given name.
func (g *Greeter) Greet(name string) string {
// Trim whitespace from the name
name = strings.TrimSpace(name)
if name == "" {
return g.Prefix + "World"
Expand All @@ -67,8 +65,6 @@ func main() {
fmt.Fprintf(os.Stderr, "Parse error: %v\n", err)
os.Exit(1)
}

// --- Section 1: AST dump with positions ---
fmt.Println("=== AST Nodes ===")
fmt.Println()
depth := 0
Expand All @@ -89,8 +85,6 @@ func main() {
depth++
return true
})

// --- Section 2: Type checking ---
fmt.Println()
fmt.Println("=== Type Information ===")
fmt.Println()
Expand All @@ -102,7 +96,6 @@ func main() {
Uses: make(map[*ast.Ident]types.Object),
}

// Type-check (will have errors due to nil importer, but populates info for local types)
_, _ = conf.Check("main", fset, []*ast.File{file}, info)

fmt.Println("-- Definitions --")
Expand All @@ -125,8 +118,6 @@ func main() {
obj.Type(), fset.Position(obj.Pos()),
)
}

// --- Section 3: Comment associations ---
fmt.Println()
fmt.Println("=== Comment Map ===")
fmt.Println()
Expand All @@ -143,8 +134,6 @@ func main() {
}
}
}

// --- Section 4: Whitespace reconstruction ---
fmt.Println()
fmt.Println("=== Whitespace Between Tokens ===")
fmt.Println()
Expand All @@ -155,7 +144,6 @@ func main() {
src := []byte(sampleSource)
tokenFile := fset.File(file.Pos())

// Collect all positions in order by walking the AST
var positions []struct {
pos token.Pos
name string
Expand All @@ -173,15 +161,13 @@ func main() {
return true
})

// Show whitespace gaps between consecutive node start positions
fmt.Println("First 10 whitespace gaps between nodes:")
shown := 0
for i := 1; i < len(positions) && shown < 10; i++ {
startOffset := tokenFile.Offset(positions[i-1].pos)
endOffset := tokenFile.Offset(positions[i].pos)
if endOffset > startOffset {
between := string(src[startOffset:endOffset])
// Only show gaps that contain whitespace beyond the node's own text
if strings.ContainsAny(between, " \t\n") {
fmt.Printf(" Between %s and %s:\n", positions[i-1].name, positions[i].name)
fmt.Printf(" raw: %q\n", between)
Expand Down
44 changes: 0 additions & 44 deletions rewrite-go/cmd/rpc/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,7 +51,6 @@ import (
"github.com/openrewrite/rewrite/rewrite-go/pkg/visitor"
)

// jsonRPCRequest represents an incoming JSON-RPC 2.0 message (request or response).
type jsonRPCRequest struct {
JSONRPC string `json:"jsonrpc"`
ID json.RawMessage `json:"id"`
Expand All @@ -60,22 +59,19 @@ type jsonRPCRequest struct {
Result json.RawMessage `json:"result"` // present in responses
}

// jsonRPCResponse represents an outgoing JSON-RPC 2.0 response.
type jsonRPCResponse struct {
JSONRPC string `json:"jsonrpc"`
ID json.RawMessage `json:"id"`
Result any `json:"result,omitempty"`
Error *rpcError `json:"error,omitempty"`
}

// rpcError is the error object in a JSON-RPC response.
type rpcError struct {
Code int `json:"code"`
Message string `json:"message"`
Data string `json:"data,omitempty"`
}

// server holds the RPC state.
type server struct {
localObjects map[string]any
remoteObjects map[string]any // forward direction: tracks what Java has from Go
Expand Down Expand Up @@ -113,11 +109,9 @@ type server struct {
// remote object id (the `p` value in Visit/Generate/BatchVisit).
preparedContexts map[string]*recipe.ExecutionContext

// Tracing toggles for GetObject
traceReceive bool
traceSend bool

// Server configuration from CLI flags (see serverConfig)
metricsCsv string

configuredDataTableStore recipe.DataTableStore
Expand Down Expand Up @@ -146,7 +140,6 @@ type server struct {
recipeWorkspaceCleanup func()
}

// serverConfig holds CLI-driven configuration applied to the server at startup.
type serverConfig struct {
logFile string
traceRpcMessages bool
Expand Down Expand Up @@ -249,7 +242,6 @@ func newServer(cfg serverConfig) *server {
return s
}

// closeMetrics flushes and closes the metrics CSV writer if open. Idempotent.
func (s *server) closeMetrics() {
s.metricsMu.Lock()
defer s.metricsMu.Unlock()
Expand Down Expand Up @@ -358,9 +350,7 @@ func main() {
}
}

// readMessage reads a Content-Length framed JSON-RPC message from stdin.
func (s *server) readMessage() (*jsonRPCRequest, error) {
// Read Content-Length header
headerLine, err := s.reader.ReadString('\n')
if err != nil {
return nil, err
Expand All @@ -375,12 +365,10 @@ func (s *server) readMessage() (*jsonRPCRequest, error) {
return nil, fmt.Errorf("invalid content length: %s", lengthStr)
}

// Read empty separator line
if _, err := s.reader.ReadString('\n'); err != nil {
return nil, err
}

// Read content body
body := make([]byte, contentLength)
if _, err := io.ReadFull(s.reader, body); err != nil {
return nil, err
Expand All @@ -393,7 +381,6 @@ func (s *server) readMessage() (*jsonRPCRequest, error) {
return &req, nil
}

// writeMessage writes a Content-Length framed JSON-RPC message to stdout.
func (s *server) writeMessage(resp *jsonRPCResponse) error {
body, err := json.Marshal(resp)
if err != nil {
Expand Down Expand Up @@ -476,7 +463,6 @@ func (s *server) handleRequest(req *jsonRPCRequest) *jsonRPCResponse {
}
}

// handleGetLanguages returns the supported language types.
func (s *server) handleGetLanguages() []string {
return []string{
"org.openrewrite.golang.tree.Go$CompilationUnit",
Expand Down Expand Up @@ -511,13 +497,11 @@ type parseInput struct {
}

func (p *parseInput) UnmarshalJSON(data []byte) error {
// Try bare string first (Java PathInput serializes as @JsonValue string)
var s string
if err := json.Unmarshal(data, &s); err == nil {
p.Path = s
return nil
}
// Otherwise unmarshal as a structured object
type alias parseInput
var a alias
if err := json.Unmarshal(data, &a); err != nil {
Expand All @@ -527,8 +511,6 @@ func (p *parseInput) UnmarshalJSON(data []byte) error {
return nil
}

// handleParse parses Go source files and returns their IDs.
//
// When req.Module + req.GoModContent are set, the handler builds a
// ProjectImporter from the parsed go.mod (requires) plus every .go input
// in the batch (siblings) and uses it for type attribution. Inputs in the
Expand Down Expand Up @@ -692,7 +674,6 @@ func (s *server) handleParse(params json.RawMessage) (any, *rpcError) {
goModByIdx[r.idx] = gm
}

// Emit results in input order.
ids := make([]string, 0, len(req.Inputs))
for _, r := range resolvedInputs {
if cu, ok := cuByIdx[r.idx]; ok && cu != nil {
Expand Down Expand Up @@ -721,13 +702,11 @@ func (s *server) handleParse(params json.RawMessage) (any, *rpcError) {
return ids, nil
}

// getObjectRequest is the parameter type for GetObject.
type getObjectRequest struct {
ID string `json:"id"`
SourceFileType string `json:"sourceFileType"`
}

// handleGetObject serializes a local object for transfer to Java.
func (s *server) handleGetObject(params json.RawMessage) (any, *rpcError) {
var req getObjectRequest
if err := json.Unmarshal(params, &req); err != nil {
Expand All @@ -747,7 +726,6 @@ func (s *server) handleGetObject(params json.RawMessage) (any, *rpcError) {
// between the reverse direction (Java→Go) and forward direction (Go→Java).
localRefs := make(map[uintptr]int)

// Collect all batches into a single result
var result []rpc.RpcObjectData
q := rpc.NewSendQueue(s.batchSize, func(batch []rpc.RpcObjectData) {
result = append(result, batch...)
Expand All @@ -762,34 +740,29 @@ func (s *server) handleGetObject(params json.RawMessage) (any, *rpcError) {
q.Put(rpc.RpcObjectData{State: rpc.EndOfObject})
q.Flush()

// Update remote tracking
s.remoteObjects[req.ID] = obj

return result, nil
}

// printRequest is the parameter type for Print.
type printRequest struct {
TreeID string `json:"treeId"`
SourcePath string `json:"sourcePath"`
SourceFileType string `json:"sourceFileType"`
MarkerPrinter *string `json:"markerPrinter"`
}

// handlePrint retrieves a tree from Java and prints it to source.
func (s *server) handlePrint(params json.RawMessage) (any, *rpcError) {
var req printRequest
if err := json.Unmarshal(params, &req); err != nil {
return nil, &rpcError{Code: -32602, Message: fmt.Sprintf("Invalid params: %v", err)}
}

// Get the object from Java via bidirectional RPC
obj := s.getObjectFromJava(req.TreeID, req.SourceFileType)
if obj == nil {
return "", nil
}

// Map markerPrinter from the request to the Go MarkerPrinter
mp := mapMarkerPrinter(req.MarkerPrinter)

if cu, ok := obj.(*golang.CompilationUnit); ok {
Expand All @@ -811,7 +784,6 @@ func (s *server) handlePrint(params json.RawMessage) (any, *rpcError) {
return "", &rpcError{Code: -32603, Message: "Object is not a Tree"}
}

// mapMarkerPrinter maps the RPC marker printer string to the Go MarkerPrinter.
func mapMarkerPrinter(mp *string) printer.MarkerPrinter {
if mp == nil {
return nil
Expand Down Expand Up @@ -843,7 +815,6 @@ func (s *server) getObjectFromJava(id string, sourceFileType string) any {
before = s.localObjects[id]
}

// fetchBatch sends a GetObject request to Java and reads one batch of RpcObjectData.
fetchBatch := func() []rpc.RpcObjectData {
reqParams := getObjectRequest{ID: id, SourceFileType: sourceFileType}
paramsJSON, _ := json.Marshal(reqParams)
Expand Down Expand Up @@ -1023,7 +994,6 @@ func (s *server) handleInstallRecipes(params json.RawMessage) (any, *rpcError) {
}, nil
}

// handleReset clears all cached state.
func (s *server) handleReset() bool {
s.localObjects = make(map[string]any)
s.remoteObjects = make(map[string]any)
Expand Down Expand Up @@ -1210,7 +1180,6 @@ func parseOrderedColumns(raw json.RawMessage) ([]recipe.ColumnValue, error) {
return cols, nil
}

// marketplaceRow matches Java's GetMarketplaceResponse.Row.
type marketplaceRow struct {
Descriptor marketplaceDescriptor `json:"descriptor"`
CategoryPaths [][]marketplaceCategory `json:"categoryPaths"`
Expand All @@ -1219,7 +1188,6 @@ type marketplaceRow struct {
PackageName *string `json:"packageName"`
}

// marketplaceDescriptor matches Java's RecipeDescriptor (minimal fields).
type marketplaceDescriptor struct {
Name string `json:"name"`
DisplayName string `json:"displayName"`
Expand Down Expand Up @@ -1248,7 +1216,6 @@ type marketplaceOption struct {
Valid []any `json:"valid"`
}

// marketplaceCategory matches Java's CategoryDescriptor.
type marketplaceCategory struct {
DisplayName string `json:"displayName"`
PackageName string `json:"packageName"`
Expand Down Expand Up @@ -1463,7 +1430,6 @@ func nonNil(s []string) []string {
return s
}

// prepareRecipeRequest is the parameter type for PrepareRecipe.
type prepareRecipeRequest struct {
ID string `json:"id"`
Options map[string]any `json:"options"`
Expand Down Expand Up @@ -1652,7 +1618,6 @@ func (s *server) prepareInstance(instance recipe.Recipe, name string) (prepareRe
// operands (a list of nested wire entries). Returns ok=false when the
// condition can't be serialized (e.g. an opaque local TreeVisitor with
// no recipe identity) — the caller leaves the wrapper intact so the
// gate runs Go-side as a fallback.
func preconditionWireEntry(condition preconditions.CheckArg) (map[string]any, bool) {
switch c := condition.(type) {
case *preconditions.RecipeRef:
Expand All @@ -1676,7 +1641,6 @@ func preconditionWireEntry(condition preconditions.CheckArg) (map[string]any, bo
}
}

// visitRequest is the parameter type for Visit.
type visitRequest struct {
Visitor string `json:"visitor"`
TreeID string `json:"treeId"`
Expand All @@ -1685,12 +1649,10 @@ type visitRequest struct {
Cursor []string `json:"cursor"`
}

// visitResponse is the response type for Visit.
type visitResponse struct {
Modified bool `json:"modified"`
}

// handleVisit applies a prepared recipe's visitor to a tree.
func (s *server) handleVisit(params json.RawMessage) (any, *rpcError) {
var req visitRequest
if err := json.Unmarshal(params, &req); err != nil {
Expand Down Expand Up @@ -1797,13 +1759,11 @@ func (s *server) handleVisit(params json.RawMessage) (any, *rpcError) {
return &visitResponse{Modified: modified}, nil
}

// generateRequest is the parameter type for Generate.
type generateRequest struct {
ID string `json:"id"`
PID *string `json:"p"`
}

// generateResponse is the response type for Generate.
type generateResponse struct {
IDs []string `json:"ids"`
SourceFileTypes []string `json:"sourceFileTypes"`
Expand Down Expand Up @@ -2032,13 +1992,11 @@ func sourceFileTypeFor(t java.Tree) string {
return ""
}

// traceGetObjectRequest is the parameter type for TraceGetObject.
type traceGetObjectRequest struct {
Receive bool `json:"receive"`
Send bool `json:"send"`
}

// handleTraceGetObject toggles tracing for GetObject calls.
func (s *server) handleTraceGetObject(params json.RawMessage) (any, *rpcError) {
var req traceGetObjectRequest
if err := json.Unmarshal(params, &req); err != nil {
Expand All @@ -2052,14 +2010,12 @@ func (s *server) handleTraceGetObject(params json.RawMessage) (any, *rpcError) {
return true, nil
}

// parseProjectRequest is the parameter type for ParseProject.
type parseProjectRequest struct {
ProjectPath string `json:"projectPath"`
Exclusions []string `json:"exclusions"`
RelativeTo *string `json:"relativeTo"`
}

// parseProjectResponseItem describes a parsed source file.
type parseProjectResponseItem struct {
ID string `json:"id"`
SourceFileType string `json:"sourceFileType"`
Expand Down
Loading
Loading