rust: add symbol support and move generated code (#44)

* add symbol support and move generated code for rust

* proto: add Macro

* optional: always get some documentation to add

* fix: handle namespace

Author: tjdevries

bindings/go/scip/scip.pb.go

@@ -160,6 +160,8 @@ func (s *symbolParser) parseDescriptor() (*Descriptor, error) {
 			return &Descriptor{Name: name, Suffix: Descriptor_Type}, nil
 		case ':':
 			return &Descriptor{Name: name, Suffix: Descriptor_Meta}, nil
+		case '!':
+			return &Descriptor{Name: name, Suffix: Descriptor_Macro}, nil
 		default:
 		}
 	}

bindings/go/scip/symbol.go

@@ -1,6 +1,8 @@
 package scip
 
-import "strings"
+import (
+	"strings"
+)
 
 // SymbolFormatter configures how to format an SCIP symbol.
 // Excluding parts of the symbol can be helpful for testing purposes. For example, snapshot tests may hardcode
@@ -81,6 +83,9 @@ func (f *SymbolFormatter) FormatSymbol(symbol *Symbol) string {
 		case Descriptor_Meta:
 			descriptor.WriteString(desc.Name)
 			descriptor.WriteRune(':')
+		case Descriptor_Macro:
+			descriptor.WriteString(desc.Name)
+			descriptor.WriteRune('!')
 		case Descriptor_Local:
 			descriptor.WriteString(desc.Name)
 		}

bindings/go/scip/symbol_formatter.go

@@ -59,6 +59,17 @@ func TestParseSymbol(t *testing.T) {
 				},
 			},
 		},
+		{
+			Symbol: "rust-analyzer cargo std 1.0.0 macros/println!",
+			Expected: &Symbol{
+				Scheme:  "rust-analyzer",
+				Package: &Package{Manager: "cargo", Name: "std", Version: "1.0.0"},
+				Descriptors: []*Descriptor{
+					{Name: "macros", Suffix: Descriptor_Package},
+					{Name: "println", Suffix: Descriptor_Macro},
+				},
+			},
+		},
 	}
 	for _, test := range tests {
 		t.Run(test.Symbol, func(t *testing.T) {

bindings/go/scip/symbol_test.go

@@ -106,6 +106,9 @@ func FormatSnapshot(
 			if info, ok := symtab[occ.Symbol]; ok && isDefinition {
 				prefix := "\n" + commentSyntax + strings.Repeat(" ", int(pos.Start.Character))
 				for _, documentation := range info.Documentation {
+					// At least get the first line of documentation if there is leading whitespace
+					documentation = strings.TrimSpace(documentation)
+
 					b.WriteString(prefix)
 					b.WriteString("documentation ")
 					truncatedDocumentation := documentation

bindings/go/scip/testutil/format.go

@@ -13,6 +13,9 @@ rust-version = "1.60.0"
 # Keep in sync with dev/proto-generate.sh
 protobuf = "=3.1.0"
 
+[dev-dependencies]
+pretty_assertions = "1.2.1"
+
 [lib]
-name = "rust"
-path = "src/scip.rs"
+name = "scip"
+path = "src/mod.rs"

bindings/rust/Cargo.lock

@@ -0,0 +1,3 @@
+// @generated
+
+pub mod scip;