WIP: Initial API design

Author: ono-max

.ruby-version

@@ -0,0 +1 @@
+3.4.5

.vscodeignore

@@ -12,3 +12,5 @@ vsc-extension-quickstart.md
 **/*.map
 **/*.ts
 **/.vscode-test.*
+
+rubyEnvironmentsApi/**

README.md

@@ -13,6 +13,28 @@ TODO: this extension is getting extracted from the Ruby LSP.
 
 TODO
 
+```
+{
+    "extensionDependencies": [
+        "shopify.ruby-environments"
+    ],
+    "dependencies": {
+        "@shopify/ruby-environments": "..."
+    },
+}
+```
+
 ## API
 
 TODO
+
+```
+// Import the API
+import { RubyEnvironments } from '@shopify/ruby-environments';
+
+// Load the RubyEnvironments API
+const rubyEnvApi: RubyEnvironmentsApi = await RubyEnvironmentsApi.getApi();
+
+// Retrieve the resolved Ruby environment.
+const rubyEnv = await rubyEnvApi.getEnvironment(vscode.workspace.workspaceFolders[0]);
+```

activation.rb

@@ -0,0 +1,7 @@
+# Using .map.compact just so that it doesn't crash immediately on Ruby 2.6
+env = ENV.map do |k, v|
+  utf_8_value = v.dup.force_encoding(Encoding::UTF_8)
+  "#{k}RUBY_LSP_VS#{utf_8_value}" if utf_8_value.valid_encoding?
+end.compact
+env.unshift(RUBY_VERSION, Gem.path.join(","), !!defined?(RubyVM::YJIT))
+STDERR.print("RUBY_LSP_ACTIVATION_SEPARATOR#{env.join("RUBY_LSP_FS")}RUBY_LSP_ACTIVATION_SEPARATOR")

chruby_activation.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+# Typically, GEM_HOME points to $HOME/.gem/ruby/version_without_patch. For example, for Ruby 3.2.2, it would be
+# $HOME/.gem/ruby/3.2.0. However, chruby overrides GEM_HOME to use the patch part of the version, resulting in
+# $HOME/.gem/ruby/3.2.2. In our activation script, we check if a directory using the patch exists and then prefer
+# that over the default one.
+user_dir = Gem.user_dir
+paths = Gem.path
+default_dir = Gem.default_dir
+
+if paths.length > 2
+  paths.delete(default_dir)
+  paths.delete(user_dir)
+  first_path = paths[0]
+  user_dir = first_path if first_path && Dir.exist?(first_path)
+end
+
+newer_gem_home = File.join(File.dirname(user_dir), ARGV.first)
+gems = Dir.exist?(newer_gem_home) ? newer_gem_home : user_dir
+STDERR.print(
+  [
+    default_dir,
+    gems,
+    !!defined?(RubyVM::YJIT),
+    RUBY_VERSION
+  ].join("RUBY_LSP_ACTIVATION_SEPARATOR")
+)

eslint.config.mjs

@@ -32,10 +32,16 @@ export default tseslint.config(
       "**/dist/",
       ".vscode-test.mjs",
       "esbuild.js",
+      "rubyEnvironmentsApi"
     ],
   },
   {
     rules: {
+      "@typescript-eslint/no-explicit-any": "off",
+      "@typescript-eslint/no-unsafe-assignment": "off",
+      "@typescript-eslint/no-unsafe-argument": "off",
+      "@typescript-eslint/no-unsafe-member-access": "off",
+      "@typescript-eslint/no-unsafe-return": "off",
       "@typescript-eslint/no-unused-vars": [
         "error",
         {

package.json

@@ -36,20 +36,25 @@
     "test": "vscode-test"
   },
   "devDependencies": {
+    "@eslint/js": "^9.32.0",
     "@types/mocha": "^10.0.10",
     "@types/node": "20.x",
+    "@types/sinon": "^17.0.4",
     "@types/vscode": "^1.102.0",
-    "@eslint/js": "^9.32.0",
-    "eslint": "^9.30.1",
-    "typescript-eslint": "^8.38.0",
-    "eslint-plugin-prettier": "^5.5.3",
-    "prettier": "^3.6.2",
     "@vscode/test-cli": "^0.0.11",
     "@vscode/test-electron": "^2.5.2",
     "@vscode/vsce": "^3.6.0",
     "esbuild": "^0.25.3",
+    "eslint": "^9.30.1",
+    "eslint-plugin-prettier": "^5.5.3",
     "npm-run-all": "^4.1.5",
     "ovsx": "^0.10.5",
-    "typescript": "^5.8.3"
+    "prettier": "^3.6.2",
+    "sinon": "^21.0.0",
+    "typescript": "^5.8.3",
+    "typescript-eslint": "^8.38.0"
+  },
+  "dependencies": {
+    "glob": "^11.0.3"
   }
 }

rubyEnvironmentsApi/.npmignore

@@ -0,0 +1,3 @@
+node_modules
+src
+tsconfig.json

rubyEnvironmentsApi/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022-present, Shopify Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

rubyEnvironmentsApi/README.md

@@ -0,0 +1,29 @@
+# Ruby environments
+
+This npm module provides a TypeScript API for interacting with Ruby environments VS Code extension.
+
+## Extension Settings
+
+```
+{
+    "extensionDependencies": [
+        "shopify.ruby-environments"
+    ],
+    "dependencies": {
+        "@shopify/ruby-environments": "..."
+    },
+}
+```
+
+## API
+
+```
+// Import the API
+import { RubyEnvironments } from '@shopify/ruby-environments';
+
+// Load the RubyEnvironments API
+const rubyEnvApi: RubyEnvironmentsApi = await RubyEnvironmentsApi.getApi();
+
+// Retrieve the resolved Ruby environment.
+const rubyEnv = await rubyEnvApi.getEnvironment(vscode.workspace.workspaceFolders[0]);
+```