Rename --path to --lsp-path and require repo absolute path

  - Rename CLI flag from --path to --lsp-path to prevent confusion
  with other path configurations
  - Add validation in ruby-lsp executable to require absolute paths
   to repo root for --lsp-path option
  - Do not allow serverPath to directly be an executable
  - Remove incorrect path expansion in SetupBundler (LSP path and
  project path are unrelated)
  - Simplify VS Code extension to pass serverPath directly without
  validation or fs usage
  - Remove duplicate validation between executable and SetupBundler
  - Update package.json to specify absolute path requirement and
  remove default value
  - Remove manual restart instruction from documentation (server
  auto-restarts on config changes)
  - Fix potential runtime error when serverPath is undefined by
  using truthy check

Author: jconley88

exe/ruby-lsp

@@ -30,10 +30,10 @@ parser = OptionParser.new do |opts|
   end
 
   opts.on(
-    "--path [PATH]",
+    "--lsp-path [PATH]",
     "Launch the Ruby LSP using a local PATH rather than the release version",
   ) do |path|
-    options[:path] = path
+    options[:lsp_path] = path
   end
 
   opts.on("--doctor", "Run troubleshooting steps") do
@@ -61,8 +61,13 @@ rescue OptionParser::InvalidOption => e
   exit(1)
 end
 
-if options[:branch] && options[:path]
-  warn('Invalid options: --branch and --path cannot both be set.')
+if options[:branch] && options[:lsp_path]
+  warn('Invalid options: --branch and --lsp-path cannot both be set.')
+  exit(1)
+end
+
+if options[:lsp_path] && !File.absolute_path?(options[:lsp_path])
+  warn('Invalid option: --lsp-path must be an absolute path.')
   exit(1)
 end
 

jekyll/contributing.markdown

@@ -62,7 +62,7 @@ not be available if the execution is currently suspended at a breakpoint.
 
 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.
+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.
 
 ```jsonc
 {

lib/ruby_lsp/setup_bundler.rb

@@ -35,13 +35,8 @@ def stdout
     def initialize(project_path, **options)
       @project_path = project_path
       @branch = options[:branch] #: String?
-      @path = options[:path] #: String?
+      @lsp_path = options[:lsp_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
@@ -171,13 +166,8 @@ def write_custom_gemfile
 
       unless @dependencies["ruby-lsp"]
         ruby_lsp_entry = +'gem "ruby-lsp", require: false, group: :development'
-        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
+        ruby_lsp_entry << ", github: \"Shopify/ruby-lsp\", branch: \"#{@branch}\"" if @branch
+        ruby_lsp_entry << ", path: \"#{@lsp_path}\"" if @lsp_path
         parts << ruby_lsp_entry
       end
 

test/setup_bundler_test.rb

@@ -282,35 +282,24 @@ def test_creates_composed_bundle_with_specified_branch
 
   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"))
+      local_path = File.join(dir, "local-ruby-lsp")
+      FileUtils.mkdir_p(File.join(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)
+          run_script(File.realpath(dir), lsp_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(%r{ruby-lsp.*path: "#{Regexp.escape(local_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|

vscode/package.json

@@ -468,9 +468,8 @@
           "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": ""
+          "description": "Absolute path to a local ruby-lsp repository. Only supported if not using bundleGemfile",
+          "type": "string"
         },
         "rubyLsp.pullDiagnosticsOn": {
           "description": "When to pull diagnostics from the server (on change, save or both). Selecting 'save' may significantly improve performance on large files",

vscode/src/client.ts

@@ -1,5 +1,4 @@
 import path from "path";
-import fs from "fs";
 import os from "os";
 import { performance as Perf } from "perf_hooks";
 
@@ -121,45 +120,21 @@ function getLspExecutables(workspaceFolder: vscode.WorkspaceFolder, env: NodeJS.
       options: executableOptions,
     };
   } else {
-    const args = [];
-    const workspacePath = workspaceFolder.uri.fsPath;
-    let command: string;
-
-    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";
-    }
+    const basePath = serverPath || workspaceFolder.uri.fsPath;
+    const command =
+      path.basename(basePath) === "ruby-lsp" && os.platform() !== "win32"
+        ? path.join(basePath, "exe", "ruby-lsp")
+        : "ruby-lsp";
 
+    const args = [];
     if (branch.length > 0) {
       args.push("--branch", branch);
     }
 
+    if (serverPath) {
+      args.push("--lsp-path", serverPath);
+    }
+
     if (featureEnabled("launcher")) {
       args.push("--use-launcher");
     }