From 2a4b5e50444ab89e76b90ba5bd2ff824c0f13cec Mon Sep 17 00:00:00 2001 From: Andy Waite <13400+andyw8@users.noreply.github.com> Date: Thu, 25 Jul 2024 15:46:05 -0400 Subject: [PATCH 1/3] Add steps for indexing troubleshooting --- TROUBLESHOOTING.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/TROUBLESHOOTING.md b/TROUBLESHOOTING.md index f576aa6e0..c5a5dc8e8 100644 --- a/TROUBLESHOOTING.md +++ b/TROUBLESHOOTING.md @@ -202,6 +202,19 @@ ruby-lsp Is there any extra information given from booting the server manually? Or does it only fail when booting through the extension? +## Indexing ## + +When Ruby LSP starts, it attempts to index your code as well as your dependencies as described in [Configuring code indexing](README.md#configuring-code-indexing). + +In rare cases, Ruby LSP will encounter an error which prevents parsing from completing, meaning Ruby LSP cannot start. + +Firstly, ensure that you are using the latest release of the `ruby-lsp` gem, as the problem may have been already fixed. + +To diagnose the particular file(s) causing a problem, run `ruby-lsp --doctor`. Please log an issue so that we we can address it. If the code is not open source then you can try write a minimal reproduction. + +In the meantime, you can [configure Ruby LSP to ignore a particular gem or file for indexing]([README.md#configuring-code-indexing]). + + ## After troubleshooting If after troubleshooting the Ruby LSP is still not initializing properly, please report an issue From 0fda0c7b2daefb0f517da612e6bd75eae9a17e25 Mon Sep 17 00:00:00 2001 From: Andy Waite Date: Thu, 25 Jul 2024 16:35:40 -0400 Subject: [PATCH 2/3] Update TROUBLESHOOTING.md Co-authored-by: Vinicius Stock --- TROUBLESHOOTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/TROUBLESHOOTING.md b/TROUBLESHOOTING.md index c5a5dc8e8..6272497f8 100644 --- a/TROUBLESHOOTING.md +++ b/TROUBLESHOOTING.md @@ -202,7 +202,7 @@ ruby-lsp Is there any extra information given from booting the server manually? Or does it only fail when booting through the extension? -## Indexing ## +## Indexing When Ruby LSP starts, it attempts to index your code as well as your dependencies as described in [Configuring code indexing](README.md#configuring-code-indexing). From 541098abc11ff31b0d7f2193cf24c6e27dceefc2 Mon Sep 17 00:00:00 2001 From: Andy Waite Date: Thu, 25 Jul 2024 16:36:38 -0400 Subject: [PATCH 3/3] Update TROUBLESHOOTING.md Co-authored-by: Stan Lo --- TROUBLESHOOTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/TROUBLESHOOTING.md b/TROUBLESHOOTING.md index 6272497f8..6586a6d3a 100644 --- a/TROUBLESHOOTING.md +++ b/TROUBLESHOOTING.md @@ -210,7 +210,7 @@ In rare cases, Ruby LSP will encounter an error which prevents parsing from comp Firstly, ensure that you are using the latest release of the `ruby-lsp` gem, as the problem may have been already fixed. -To diagnose the particular file(s) causing a problem, run `ruby-lsp --doctor`. Please log an issue so that we we can address it. If the code is not open source then you can try write a minimal reproduction. +To diagnose the particular file(s) causing a problem, run `ruby-lsp --doctor`. Please log an issue so that we can address it. If the code is not open source then please provide a minimal reproduction. In the meantime, you can [configure Ruby LSP to ignore a particular gem or file for indexing]([README.md#configuring-code-indexing]).