Merge pull request #1 from rubocop/add_rubocop_yjit_enabled_option

Add `rubocop.yjitEnabled` option to enable YJIT

CHANGELOG.md

@@ -2,8 +2,12 @@
 
 ## master (unreleased)
 
+### New features
+
+- Add `rubocop.yjitEnabled` option to speed up the RuboCop LSP server. (@koic)
+
 ## 0.1.0 (2023-06-23)
 
 ### New features
 
-- Initial release on VS Code Extension Marketplace (@koic)
+- Initial release on VS Code Extension Marketplace. (@koic)

README.md

@@ -131,6 +131,21 @@ Or, in `settings.json`:
 }
 ```
 
+### rubocop.yjitEnabled
+
+This extension supports YJIT, which can speed up the built-in language server in RuboCop.
+The `rubocop.yjitEnabled` option is enabled by default.
+
+![YJIT Enabled](/docs/yjit-enabled.png)
+
+You can disable YJIT by unchecking.
+
+Or, in `settings.json`:
+
+```json
+"rubocop.yjitEnabled": false
+```
+
 ### Changing settings only for a specific project
 
 You may want to apply certain settings to a specific project, which you can do

package.json

@@ -100,6 +100,12 @@
             "type": "string",
             "default": "",
             "markdownDescription": "Absolute path to rubocop executable. Overrides default search order and, if missing, will not run RuboCop via Bundler or a `rubocop` executable on your PATH.\n\nSupports variables `${userHome}`, `${pathSeparator}`, and `${cwd}`."
+          },
+          "rubocop.yjitEnabled": {
+            "order": 4,
+            "type": "boolean",
+            "default": true,
+            "markdownDescription": "Use YJIT to speed up the RuboCop LSP server."
           }
         }
       }

src/extension.ts

@@ -21,6 +21,7 @@ import {
   DidOpenTextDocumentNotification,
   Disposable,
   Executable,
+  ExecutableOptions,
   ExecuteCommandRequest,
   LanguageClient,
   LanguageClientOptions,
@@ -256,9 +257,18 @@ async function buildExecutable(): Promise<Executable | undefined> {
     await displayError('Could not find RuboCop executable', ['Show Output', 'View Settings']);
   } else if (await supportedVersionOfRuboCop(command)) {
     const [exe, ...args] = (command).split(' ');
+    const env = { ...process.env };
+    if (getConfig<boolean>('yjitEnabled') ?? true) {
+      env.RUBY_YJIT_ENABLE = "true";
+    }
+    const options: ExecutableOptions = {
+      env: env
+    };
+
     return {
       command: exe,
-      args: args.concat('--lsp')
+      args: args.concat('--lsp'),
+      options: options
     };
   }
 }