add completions_with_replace flag (#1458)

README.md

@@ -87,6 +87,7 @@ The following options are currently available.
 | `build_runner_path` | `?[]const u8` | `null` | Path to the `build_runner.zig` file provided by zls. null is equivalent to `${executable_directory}/build_runner.zig` |
 | `global_cache_path` | `?[]const u8` | `null` | Path to a directory that will be used as zig's cache. null is equivalent to `${KnownFolders.Cache}/zls` |
 | `build_runner_global_cache_path` | `?[]const u8` | `null` | Path to a directory that will be used as the global cache path when executing a projects build.zig. null is equivalent to the path shown by `zig env` |
+| `completions_with_replace` | `bool` | `true` | Completions confirm behavior. If 'true', replace the text after the cursor |
 <!-- DO NOT EDIT -->
 
 ### Per-build Configuration Options

schema.json

@@ -163,6 +163,11 @@
             "description": "Path to a directory that will be used as the global cache path when executing a projects build.zig. null is equivalent to the path shown by `zig env`",
             "type": "string",
             "default": "null"
+        },
+        "completions_with_replace": {
+            "description": "Completions confirm behavior. If 'true', replace the text after the cursor",
+            "type": "boolean",
+            "default": "true"
         }
     }
 }

src/Config.zig

@@ -101,4 +101,7 @@ global_cache_path: ?[]const u8 = null,
 /// Path to a directory that will be used as the global cache path when executing a projects build.zig. null is equivalent to the path shown by `zig env`
 build_runner_global_cache_path: ?[]const u8 = null,
 
+/// Completions confirm behavior. If 'true', replace the text after the cursor
+completions_with_replace: bool = true,
+
 // DO NOT EDIT

src/config_gen/config.json

@@ -190,6 +190,12 @@
             "description": "Path to a directory that will be used as the global cache path when executing a projects build.zig. null is equivalent to the path shown by `zig env`",
             "type": "?[]const u8",
             "default": "null"
+        },
+        {
+            "name": "completions_with_replace",
+            "description": "Completions confirm behavior. If 'true', replace the text after the cursor",
+            "type": "bool",
+            "default": "true"
         }
     ]
-}
+}

src/features/completions.zig

@@ -1455,33 +1455,35 @@ pub fn completionAtIndex(server: *Server, analyser: *Analyser, arena: std.mem.Al
 
     const completions = maybe_completions orelse return null;
 
-    // The cursor is in the middle of a word or before a @, so we can replace
-    // the remaining identifier with the completion instead of just inserting.
-    // TODO Identify function call/struct init and replace the whole thing.
-    const lookahead_context = try Analyser.getPositionContext(arena, handle.text, source_index, true);
-    if (server.client_capabilities.supports_apply_edits and
-        pos_context != .import_string_literal and
-        pos_context != .cinclude_string_literal and
-        pos_context != .embedfile_string_literal and
-        pos_context.loc() != null and
-        lookahead_context.loc() != null and
-        pos_context.loc().?.end != lookahead_context.loc().?.end)
-    {
-        var end = lookahead_context.loc().?.end;
-        while (end < handle.text.len and (std.ascii.isAlphanumeric(handle.text[end]) or handle.text[end] == '"')) {
-            end += 1;
-        }
+    if (server.config.completions_with_replace) {
+        // The cursor is in the middle of a word or before a @, so we can replace
+        // the remaining identifier with the completion instead of just inserting.
+        // TODO Identify function call/struct init and replace the whole thing.
+        const lookahead_context = try Analyser.getPositionContext(arena, handle.text, source_index, true);
+        if (server.client_capabilities.supports_apply_edits and
+            pos_context != .import_string_literal and
+            pos_context != .cinclude_string_literal and
+            pos_context != .embedfile_string_literal and
+            pos_context.loc() != null and
+            lookahead_context.loc() != null and
+            pos_context.loc().?.end != lookahead_context.loc().?.end)
+        {
+            var end = lookahead_context.loc().?.end;
+            while (end < handle.text.len and (std.ascii.isAlphanumeric(handle.text[end]) or handle.text[end] == '"')) {
+                end += 1;
+            }
 
-        const replaceLoc = offsets.Loc{ .start = lookahead_context.loc().?.start, .end = end };
-        const replaceRange = offsets.locToRange(handle.text, replaceLoc, server.offset_encoding);
+            const replaceLoc = offsets.Loc{ .start = lookahead_context.loc().?.start, .end = end };
+            const replaceRange = offsets.locToRange(handle.text, replaceLoc, server.offset_encoding);
 
-        for (completions) |*item| {
-            item.textEdit = .{
-                .TextEdit = .{
-                    .newText = item.insertText orelse item.label,
-                    .range = replaceRange,
-                },
-            };
+            for (completions) |*item| {
+                item.textEdit = .{
+                    .TextEdit = .{
+                        .newText = item.insertText orelse item.label,
+                        .range = replaceRange,
+                    },
+                };
+            }
         }
     }