Skip to content

Commit

Permalink
feat(completion): quote labels when necessary (#136)
Browse files Browse the repository at this point in the history 
* test(completion): quote labels

* feat(completion): quote labels when necessary

* fix: use upstream logic to validate identifier

* style
  • Loading branch information
@Duologic
Duologic authored Mar 11, 2024
1 parent feba4a4 commit 948a231
Show file tree
Hide file tree
Showing 3 changed files with 162 additions and 8 deletions.
86 changes: 78 additions & 8 deletions pkg/server/completion.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ func (s *Server) Completion(_ context.Context, params *protocol.CompletionParams

vm := s.getVM(doc.item.URI.SpanURI().Filename())

items := s.completionFromStack(line, searchStack, vm)
items := s.completionFromStack(line, searchStack, vm, params.Position)
return &protocol.CompletionList{IsIncomplete: false, Items: items}, nil
}

Expand All @@ -57,7 +57,7 @@ func getCompletionLine(fileContent string, position protocol.Position) string {
return line
}

func (s *Server) completionFromStack(line string, stack *nodestack.NodeStack, vm *jsonnet.VM) []protocol.CompletionItem {
func (s *Server) completionFromStack(line string, stack *nodestack.NodeStack, vm *jsonnet.VM, position protocol.Position) []protocol.CompletionItem {
lineWords := strings.Split(line, " ")
lastWord := lineWords[len(lineWords)-1]
lastWord = strings.TrimRight(lastWord, ",;") // Ignore trailing commas and semicolons, they can present when someone is modifying an existing line
Expand All @@ -76,7 +76,7 @@ func (s *Server) completionFromStack(line string, stack *nodestack.NodeStack, vm
continue
}

items = append(items, createCompletionItem(label, label, protocol.VariableCompletion, bind.Body))
items = append(items, createCompletionItem(label, "", protocol.VariableCompletion, bind.Body, position))
}
}
}
Expand All @@ -90,7 +90,7 @@ func (s *Server) completionFromStack(line string, stack *nodestack.NodeStack, vm
}

completionPrefix := strings.Join(indexes[:len(indexes)-1], ".")
return createCompletionItemsFromRanges(ranges, completionPrefix, line)
return createCompletionItemsFromRanges(ranges, completionPrefix, line, position)
}

func (s *Server) completionStdLib(line string) []protocol.CompletionItem {
Expand Down Expand Up @@ -132,7 +132,7 @@ func (s *Server) completionStdLib(line string) []protocol.CompletionItem {
return items
}

func createCompletionItemsFromRanges(ranges []processing.ObjectRange, completionPrefix, currentLine string) []protocol.CompletionItem {
func createCompletionItemsFromRanges(ranges []processing.ObjectRange, completionPrefix, currentLine string, position protocol.Position) []protocol.CompletionItem {
var items []protocol.CompletionItem
labels := make(map[string]bool)

Expand All @@ -152,7 +152,7 @@ func createCompletionItemsFromRanges(ranges []processing.ObjectRange, completion
continue
}

items = append(items, createCompletionItem(label, completionPrefix+"."+label, protocol.FieldCompletion, field.Node))
items = append(items, createCompletionItem(label, completionPrefix, protocol.FieldCompletion, field.Node, position))
labels[label] = true
}

Expand All @@ -163,8 +163,19 @@ func createCompletionItemsFromRanges(ranges []processing.ObjectRange, completion
return items
}

func createCompletionItem(label, detail string, kind protocol.CompletionItemKind, body ast.Node) protocol.CompletionItem {
func createCompletionItem(label, prefix string, kind protocol.CompletionItemKind, body ast.Node, position protocol.Position) protocol.CompletionItem {
mustNotQuoteLabel := IsValidIdentifier(label)

insertText := label
detail := label
if prefix != "" {
detail = prefix + "." + insertText
}
if !mustNotQuoteLabel {
insertText = "['" + label + "']"
detail = prefix + insertText
}

if asFunc, ok := body.(*ast.Function); ok {
kind = protocol.FunctionCompletion
params := []string{}
Expand All @@ -176,7 +187,7 @@ func createCompletionItem(label, detail string, kind protocol.CompletionItemKind
insertText += paramsString
}

return protocol.CompletionItem{
item := protocol.CompletionItem{
Label: label,
Detail: detail,
Kind: kind,
Expand All @@ -185,8 +196,67 @@ func createCompletionItem(label, detail string, kind protocol.CompletionItemKind
},
InsertText: insertText,
}

// Remove leading `.` character when quoting label
if !mustNotQuoteLabel {
item.TextEdit = &protocol.TextEdit{
Range: protocol.Range{
Start: protocol.Position{
Line: position.Line,
Character: position.Character - 1,
},
End: protocol.Position{
Line: position.Line,
Character: position.Character,
},
},
NewText: insertText,
}
}

return item
}

// Start - Copied from go-jsonnet/internal/parser/lexer.go

func isUpper(r rune) bool {
return r >= 'A' && r <= 'Z'
}
func isLower(r rune) bool {
return r >= 'a' && r <= 'z'
}
func isNumber(r rune) bool {
return r >= '0' && r <= '9'
}
func isIdentifierFirst(r rune) bool {
return isUpper(r) || isLower(r) || r == '_'
}
func isIdentifier(r rune) bool {
return isIdentifierFirst(r) || isNumber(r)
}
func IsValidIdentifier(str string) bool {
if len(str) == 0 {
return false
}
for i, r := range str {
if i == 0 {
if !isIdentifierFirst(r) {
return false
}
} else {
if !isIdentifier(r) {
return false
}
}
}
// Ignore tokens for now, we should ask upstream to make the formatter a public package
// so we can use go-jsonnet/internal/formatter/pretty_field_names.go directly.
// return getTokenKindFromID(str) == tokenIdentifier
return true
}

// End - Copied from go-jsonnet/internal/parser/lexer.go

func typeToString(t ast.Node) string {
switch t.(type) {
case *ast.Array:
Expand Down
77 changes: 77 additions & 0 deletions pkg/server/completion_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -586,6 +586,83 @@ func TestCompletion(t *testing.T) {
},
},
},
{
name: "quote label",
filename: "testdata/quote_label.jsonnet",
replaceString: "lib",
replaceByString: "lib.",
expected: protocol.CompletionList{
IsIncomplete: false,
Items: []protocol.CompletionItem{
{
Label: "1num",
Kind: protocol.FieldCompletion,
Detail: "lib['1num']",
InsertText: "['1num']",
LabelDetails: protocol.CompletionItemLabelDetails{
Description: "string",
},
TextEdit: &protocol.TextEdit{
Range: protocol.Range{
Start: protocol.Position{
Line: 0,
Character: 9,
},
End: protocol.Position{
Line: 0,
Character: 10,
},
},
NewText: "['1num']",
},
},
{
Label: "abc#func",
Kind: protocol.FunctionCompletion,
Detail: "lib['abc#func'](param)",
InsertText: "['abc#func'](param)",
LabelDetails: protocol.CompletionItemLabelDetails{
Description: "function",
},
TextEdit: &protocol.TextEdit{
Range: protocol.Range{
Start: protocol.Position{
Line: 0,
Character: 9,
},
End: protocol.Position{
Line: 0,
Character: 10,
},
},
NewText: "['abc#func'](param)",
},
},
{
Label: "abc#var",
Kind: protocol.FieldCompletion,
Detail: "lib['abc#var']",
InsertText: "['abc#var']",
LabelDetails: protocol.CompletionItemLabelDetails{
Description: "string",
},
TextEdit: &protocol.TextEdit{
Range: protocol.Range{
Start: protocol.Position{
Line: 0,
Character: 9,
},
End: protocol.Position{
Line: 0,
Character: 10,
},
},
NewText: "['abc#var']",
},
},
},
},
},
}
for _, tc := range testCases {
t.Run(tc.name, func(t *testing.T) {
Expand Down
7 changes: 7 additions & 0 deletions pkg/server/testdata/quote_label.jsonnet
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
local lib = {
'1num': 'val',
'abc#func'(param=1): param,
'abc#var': 'val',
};

lib

0 comments on commit 948a231

Please sign in to comment.