settings: prepend options with 'indexing'

Author: radeksimko

docs/SETTINGS.md

@@ -37,7 +37,7 @@ you can just add that folder to the workspace and it will be indexed as usual.
 
 Deprecated in favour of `ignorePaths`
 
-## `ignorePaths` (`[]string`)
+## `indexing.ignorePaths` (`[]string`)
 
 Paths to ignore when indexing the workspace on initialization. This can serve
 as an escape hatch in large workspaces. Key side effect of ignoring a path
@@ -72,7 +72,11 @@ Or if left empty
 This setting should be deprecated once the language server supports multiple workspaces,
 as this arises in VS code because a server instance is started per VS Code workspace.
 
-## `ignoreDirectoryNames` (`[]string`)
+## **DEPRECATED**: `ignoreDirectoryNames` (`[]string`)
+
+Deprecated in favour of `indexing.ignoreDirectoryNames`
+
+## `indexing.ignoreDirectoryNames` (`[]string`)
 
 This allows excluding directories from being indexed upon initialization by passing a list of directory names.
 

internal/langserver/handlers/initialize.go

@@ -186,8 +186,8 @@ func getTelemetryProperties(out *settings.DecodedOptions) map[string]interface{}
 	properties["options.rootModulePaths"] = len(out.Options.XLegacyModulePaths) > 0
 	properties["options.excludeModulePaths"] = len(out.Options.XLegacyExcludeModulePaths) > 0
 	properties["options.commandPrefix"] = len(out.Options.CommandPrefix) > 0
-	properties["options.ignoreDirectoryNames"] = len(out.Options.IgnoreDirectoryNames) > 0
-	properties["options.ignorePaths"] = len(out.Options.IgnorePaths) > 0
+	properties["options.indexing.ignoreDirectoryNames"] = len(out.Options.IgnoreDirectoryNames) > 0
+	properties["options.indexing.ignorePaths"] = len(out.Options.IgnorePaths) > 0
 	properties["options.experimentalFeatures.prefillRequiredFields"] = out.Options.ExperimentalFeatures.PrefillRequiredFields
 	properties["options.experimentalFeatures.validateOnSave"] = out.Options.ExperimentalFeatures.ValidateOnSave
 	properties["options.ignoreSingleFileWarning"] = out.Options.IgnoreSingleFileWarning
@@ -258,7 +258,7 @@ func (svc *service) setupWalker(ctx context.Context, params lsp.InitializeParams
 	if len(options.XLegacyExcludeModulePaths) != 0 {
 		jrpc2.ServerFromContext(ctx).Notify(ctx, "window/showMessage", &lsp.ShowMessageParams{
 			Type: lsp.Warning,
-			Message: fmt.Sprintf("excludeModulePaths (%q) is deprecated (no-op), use ignorePaths instead",
+			Message: fmt.Sprintf("excludeModulePaths (%q) is deprecated (no-op), use indexing.ignorePaths instead",
 				options.XLegacyExcludeModulePaths),
 		})
 	}

internal/langserver/handlers/initialize_test.go

@@ -196,7 +196,7 @@ func TestInitialize_ignoreDirectoryNames(t *testing.T) {
 			"rootUri": %q,
 			"processId": 12345,
 			"initializationOptions": {
-				"ignoreDirectoryNames": [%q]
+				"indexing.ignoreDirectoryNames": [%q]
 			}
 	}`, tmpDir.URI, "ignore")})
 	waitForWalkerPath(t, ss, wc, tmpDir)

internal/settings/settings.go

@@ -17,8 +17,8 @@ type ExperimentalFeatures struct {
 
 type Options struct {
 	CommandPrefix        string   `mapstructure:"commandPrefix"`
-	IgnoreDirectoryNames []string `mapstructure:"ignoreDirectoryNames"`
-	IgnorePaths          []string `mapstructure:"ignorePaths"`
+	IgnoreDirectoryNames []string `mapstructure:"indexing.ignoreDirectoryNames"`
+	IgnorePaths          []string `mapstructure:"indexing.ignorePaths"`
 
 	// ExperimentalFeatures encapsulates experimental features users can opt into.
 	ExperimentalFeatures ExperimentalFeatures `mapstructure:"experimentalFeatures"`

internal/settings/settings_test.go

@@ -23,7 +23,7 @@ func TestDecodeOptions_nil(t *testing.T) {
 
 func TestDecodeOptions_wrongType(t *testing.T) {
 	_, err := DecodeOptions(map[string]interface{}{
-		"ignorePaths": "/random/path",
+		"indexing.ignorePaths": "/random/path",
 	})
 	if err == nil {
 		t.Fatal("expected decoding of wrong type to result in error")
@@ -32,7 +32,7 @@ func TestDecodeOptions_wrongType(t *testing.T) {
 
 func TestDecodeOptions_success(t *testing.T) {
 	out, err := DecodeOptions(map[string]interface{}{
-		"ignorePaths": []string{"/random/path"},
+		"indexing.ignorePaths": []string{"/random/path"},
 	})
 	if err != nil {
 		t.Fatal(err)
@@ -55,7 +55,7 @@ func TestValidate_IgnoreDirectoryNames_error(t *testing.T) {
 
 	for _, table := range tables {
 		out, err := DecodeOptions(map[string]interface{}{
-			"ignoreDirectoryNames": []string{table.input},
+			"indexing.ignoreDirectoryNames": []string{table.input},
 		})
 		if err != nil {
 			t.Fatal(err)
@@ -69,7 +69,7 @@ func TestValidate_IgnoreDirectoryNames_error(t *testing.T) {
 }
 func TestValidate_IgnoreDirectoryNames_success(t *testing.T) {
 	out, err := DecodeOptions(map[string]interface{}{
-		"ignoreDirectoryNames": []string{"directory"},
+		"indexing.ignoreDirectoryNames": []string{"directory"},
 	})
 	if err != nil {
 		t.Fatal(err)