Merge pull request #142 from docker/volume-snippet-path-compose-completions

Include a path as a snippet for named volumes

Author: rcjsuen

internal/compose/completion.go

@@ -82,7 +82,11 @@ func Completion(ctx context.Context, params *protocol.CompletionParams, doc docu
 		return &protocol.CompletionList{Items: dependencies}, nil
 	}
 
-	items := namedDependencyCompletionItems(file, path, "configs", "configs", params, protocol.UInteger(len(wordPrefix)))
+	items := volumeDependencyCompletionItems(file, path, params, protocol.UInteger(len(wordPrefix)))
+	if len(items) > 0 {
+		return &protocol.CompletionList{Items: items}, nil
+	}
+	items = namedDependencyCompletionItems(file, path, "configs", "configs", params, protocol.UInteger(len(wordPrefix)))
 	if len(items) == 0 {
 		items = namedDependencyCompletionItems(file, path, "secrets", "secrets", params, protocol.UInteger(len(wordPrefix)))
 	}
@@ -201,7 +205,6 @@ func dependencyCompletionItems(file *ast.File, path []*ast.MappingValueNode, par
 	dependency := map[string]string{
 		"depends_on": "services",
 		"networks":   "networks",
-		"volumes":    "volumes",
 	}
 	for serviceAttribute, dependencyType := range dependency {
 		items := namedDependencyCompletionItems(file, path, serviceAttribute, dependencyType, params, prefixLength)
@@ -212,6 +215,19 @@ func dependencyCompletionItems(file *ast.File, path []*ast.MappingValueNode, par
 	return nil
 }
 
+func volumeDependencyCompletionItems(file *ast.File, path []*ast.MappingValueNode, params *protocol.CompletionParams, prefixLength protocol.UInteger) []protocol.CompletionItem {
+	items := namedDependencyCompletionItems(file, path, "volumes", "volumes", params, prefixLength)
+	for i := range items {
+		edit := items[i].TextEdit.(protocol.TextEdit)
+		items[i].TextEdit = protocol.TextEdit{
+			NewText: fmt.Sprintf("%v:${1:/container/path}", edit.NewText),
+			Range:   edit.Range,
+		}
+		items[i].InsertTextFormat = types.CreateInsertTextFormatPointer(protocol.InsertTextFormatSnippet)
+	}
+	return items
+}
+
 func namedDependencyCompletionItems(file *ast.File, path []*ast.MappingValueNode, serviceAttribute, dependencyType string, params *protocol.CompletionParams, prefixLength protocol.UInteger) []protocol.CompletionItem {
 	if len(path) == 3 && path[2].Key.GetToken().Value == serviceAttribute {
 		items := []protocol.CompletionItem{}

internal/compose/completion_test.go

@@ -2071,8 +2071,9 @@ volumes:
 			list: &protocol.CompletionList{
 				Items: []protocol.CompletionItem{
 					{
-						Label:    "test2",
-						TextEdit: textEdit("test2", 5, 8, 0),
+						Label:            "test2",
+						TextEdit:         textEdit("test2:${1:/container/path}", 5, 8, 0),
+						InsertTextFormat: types.CreateInsertTextFormatPointer(protocol.InsertTextFormatSnippet),
 					},
 				},
 			},
@@ -2094,8 +2095,9 @@ volumes:
 			list: &protocol.CompletionList{
 				Items: []protocol.CompletionItem{
 					{
-						Label:    "test2",
-						TextEdit: textEdit("test2", 6, 8, 0),
+						Label:            "test2",
+						TextEdit:         textEdit("test2:${1:/container/path}", 6, 8, 0),
+						InsertTextFormat: types.CreateInsertTextFormatPointer(protocol.InsertTextFormatSnippet),
 					},
 				},
 			},
@@ -2115,8 +2117,9 @@ volumes:
 			list: &protocol.CompletionList{
 				Items: []protocol.CompletionItem{
 					{
-						Label:    "test2",
-						TextEdit: textEdit("test2", 5, 9, 1),
+						Label:            "test2",
+						TextEdit:         textEdit("test2:${1:/container/path}", 5, 9, 1),
+						InsertTextFormat: types.CreateInsertTextFormatPointer(protocol.InsertTextFormatSnippet),
 					},
 				},
 			},
@@ -2136,8 +2139,9 @@ volumes:
 			list: &protocol.CompletionList{
 				Items: []protocol.CompletionItem{
 					{
-						Label:    "test2",
-						TextEdit: textEdit("test2", 5, 6, 0),
+						Label:            "test2",
+						TextEdit:         textEdit("test2:${1:/container/path}", 5, 6, 0),
+						InsertTextFormat: types.CreateInsertTextFormatPointer(protocol.InsertTextFormatSnippet),
 					},
 				},
 			},