Add VS Code rubyLsp.serverPath configuration for local server development...

Also add --path option to the ruby-lsp executable itself

Author: jconley88

exe/ruby-lsp

@@ -29,6 +29,13 @@ parser = OptionParser.new do |opts|
     options[:branch] = branch
   end
 
+  opts.on(
+    "--path [PATH]",
+    "Launch the Ruby LSP using a local PATH rather than the release version",
+  ) do |path|
+    options[:path] = path
+  end
+
   opts.on("--doctor", "Run troubleshooting steps") do
     options[:doctor] = true
   end
@@ -54,6 +61,11 @@ rescue OptionParser::InvalidOption => e
   exit(1)
 end
 
+if options[:branch] && options[:path]
+  warn('Invalid options: --branch and --path cannot both be set.')
+  exit(1)
+end
+
 # When we're running without bundler, then we need to make sure the composed bundle is fully configured and re-execute
 # using `BUNDLE_GEMFILE=.ruby-lsp/Gemfile bundle exec ruby-lsp` so that we have access to the gems that are a part of
 # the application's bundle

jekyll/contributing.markdown

@@ -58,6 +58,20 @@ with a debugger. Note that the debug mode applies only until the editor is close
 Caveat: since you are debugging the language server instance that is currently running in your own editor, features will
 not be available if the execution is currently suspended at a breakpoint.
 
+#### Configuring the server version
+
+When developing the Ruby LSP server, you may want to test your changes in your own Ruby projects to ensure they work correctly in real-world scenarios.
+
+The running server, even in debug mode, will default to the installed release version*. You can use the `rubyLsp.serverPath` configuration setting in the target workspace to start your local copy instead. Make sure to restart the language server after making changes to pick up your updates.
+
+```jsonc
+{
+  "rubyLsp.serverPath": "/path/to/your/ruby-lsp-clone"
+}
+```
+
+*Note: There are some exceptions to this. Most notably, when the ruby-lsp repository is opened in VS Code with the extension active, it will run the server contained within the repository.
+
 #### Understanding Prism ASTs
 
 The Ruby LSP uses Prism to parse and understand Ruby code. When working on a feature, it's very common to need to

lib/ruby_lsp/setup_bundler.rb

@@ -35,7 +35,13 @@ def stdout
     def initialize(project_path, **options)
       @project_path = project_path
       @branch = options[:branch] #: String?
+      @path = options[:path] #: String?
       @launcher = options[:launcher] #: bool?
+
+      if @branch && !@branch.empty? && @path && !@path.empty?
+        raise ArgumentError, "Branch and path options are mutually exclusive. Please specify only one."
+      end
+
       patch_thor_to_print_progress_to_stderr! if @launcher
 
       # Regular bundle paths
@@ -165,7 +171,13 @@ def write_custom_gemfile
 
       unless @dependencies["ruby-lsp"]
         ruby_lsp_entry = +'gem "ruby-lsp", require: false, group: :development'
-        ruby_lsp_entry << ", github: \"Shopify/ruby-lsp\", branch: \"#{@branch}\"" if @branch
+        if @branch && !@branch.empty?
+          ruby_lsp_entry << ", github: \"Shopify/ruby-lsp\", branch: \"#{@branch}\""
+        end
+        if @path && !@path.empty?
+          absolute_path = File.expand_path(@path, @project_path)
+          ruby_lsp_entry << ", path: \"#{absolute_path}\""
+        end
         parts << ruby_lsp_entry
       end
 

test/setup_bundler_test.rb

@@ -280,6 +280,38 @@ def test_creates_composed_bundle_with_specified_branch
     end
   end
 
+  def test_creates_composed_bundle_with_specified_path
+    Dir.mktmpdir do |dir|
+      local_path = "local-ruby-lsp"
+      FileUtils.mkdir_p(File.join(dir, local_path, "lib"))
+      
+      Dir.chdir(dir) do
+        bundle_gemfile = Pathname.new(".ruby-lsp").expand_path(Dir.pwd) + "Gemfile"
+        Bundler.with_unbundled_env do
+          stub_bundle_with_env(bundle_env(dir, bundle_gemfile.to_s))
+          run_script(File.realpath(dir), path: local_path)
+        end
+  
+        assert_path_exists(".ruby-lsp")
+        assert_path_exists(".ruby-lsp/Gemfile")
+        expected_absolute_path = File.expand_path(local_path, File.realpath(dir))
+        assert_match(%r{ruby-lsp.*path: "#{Regexp.escape(expected_absolute_path)}"}, File.read(".ruby-lsp/Gemfile"))
+        assert_match("debug", File.read(".ruby-lsp/Gemfile"))
+      end
+    end
+  end  
+
+  def test_raises_error_when_both_branch_and_path_are_specified
+    Dir.mktmpdir do |dir|
+      Dir.chdir(dir) do
+        error = assert_raises(ArgumentError) do
+          RubyLsp::SetupBundler.new(dir, branch: "test-branch", path: "local-path")
+        end
+        assert_equal("Branch and path options are mutually exclusive. Please specify only one.", error.message)
+      end
+    end
+  end
+
   def test_returns_bundle_app_config_if_there_is_local_config
     Dir.mktmpdir do |dir|
       Dir.chdir(dir) do

vscode/package.json

@@ -467,6 +467,11 @@
           "type": "string",
           "default": ""
         },
+        "rubyLsp.serverPath": {
+          "description": "Absolute or workspace-relative path to a local ruby-lsp repository or its ruby-lsp executable. Only supported if not using bundleGemfile",
+          "type": "string",
+          "default": ""
+        },
         "rubyLsp.pullDiagnosticsOn": {
           "description": "When to pull diagnostics from the server (on change, save or both). Selecting 'save' may significantly improve performance on large files",
           "type": "string",

vscode/src/client.ts

@@ -1,4 +1,5 @@
 import path from "path";
+import fs from "fs";
 import os from "os";
 import { performance as Perf } from "perf_hooks";
 
@@ -85,6 +86,7 @@ function getLspExecutables(workspaceFolder: vscode.WorkspaceFolder, env: NodeJS.
   const customBundleGemfile: string = config.get("bundleGemfile")!;
   const useBundlerCompose: boolean = config.get("useBundlerCompose")!;
   const bypassTypechecker: boolean = config.get("bypassTypechecker")!;
+  const serverPath: string = config.get("serverPath")!;
 
   const executableOptions: ExecutableOptions = {
     cwd: workspaceFolder.uri.fsPath,
@@ -119,13 +121,40 @@ function getLspExecutables(workspaceFolder: vscode.WorkspaceFolder, env: NodeJS.
       options: executableOptions,
     };
   } else {
+    const args = [];
     const workspacePath = workspaceFolder.uri.fsPath;
-    const command =
-      path.basename(workspacePath) === "ruby-lsp" && os.platform() !== "win32"
-        ? path.join(workspacePath, "exe", "ruby-lsp")
-        : "ruby-lsp";
+    let command: string;
 
-    const args = [];
+    if (serverPath.length > 0 && branch.length > 0) {
+      throw new Error(
+        'Invalid configuration: "rubyLsp.serverPath" and "rubyLsp.branch" cannot both be set. Please unset one of them.',
+      );
+    }
+
+    if (serverPath.length > 0) {
+      const absoluteServerPath = path.isAbsolute(serverPath) ? serverPath : path.resolve(workspacePath, serverPath);
+      const exists = fs.existsSync(absoluteServerPath);
+
+      if (exists) {
+        args.push("--path", absoluteServerPath);
+        const stat = fs.statSync(absoluteServerPath);
+
+        if (stat.isDirectory()) {
+          command = os.platform() !== "win32" ? path.join(absoluteServerPath, "exe", "ruby-lsp") : "ruby-lsp";
+        } else {
+          command = absoluteServerPath;
+        }
+      } else {
+        throw new Error(
+          `The configured rubyLsp.serverPath "${serverPath}" does not exist at "${absoluteServerPath}". `,
+        );
+      }
+    } else {
+      command =
+        path.basename(workspacePath) === "ruby-lsp" && os.platform() !== "win32"
+          ? path.join(workspacePath, "exe", "ruby-lsp")
+          : "ruby-lsp";
+    }
 
     if (branch.length > 0) {
       args.push("--branch", branch);