WIP: Initial API design

[ono-max]

Source code change summary

• The following files were extracted from ruby-lsp without any modifications
  • src/ruby/**
  • src/workspaceChannel.ts
• src/ruby.ts was extracted from ruby-lsp, and modified to adapt to the API.

Extension Settings

{
    "extensionDependencies": [
        "shopify.ruby-environments"
    ],
    "dependencies": {
        "@shopify/ruby-environments": "..."
    },
}

API

API Specification: https://github.com/Shopify/ruby-environments/blob/6254b3c216921a28737ebbe748238f4ba89b6782/rubyEnvironmentsApi/src/index.ts

Here is the example:

// Import the API
import { RubyEnvironments } from '@shopify/ruby-environments';

const rubyEnvApi: RubyEnvironmentsApi = await RubyEnvironmentsApi.getApi();

const rubyEnv = await rubyEnvApi.getEnvironment(vscode.workspace.workspaceFolders[0]);

This API is inspired by the following projects:

• https://github.com/microsoft/vscode-python
• https://github.com/microsoft/vscode-wasm

How to test this code

1. Install both VS Code extension and NPM module as follows:

• VS Code Extension: https://www.npmjs.com/package/sandbox-ruby-environments
• NPM module https://marketplace.visualstudio.com/items?itemName=NaotoOno.sandbox-ruby-environments

2. Modify package.json in your testing VS Code extension as follows:

{
    "extensionDependencies": [
        "shopify.ruby-environments"
    ],
    "dependencies": {
        "@shopify/ruby-environments": "..."
    },
}

3. Add the following lines to your testing VS Code extension.

import { RubyEnvironments } from '@shopify/ruby-environments';
const rubyEnvApi: RubyEnvironmentsApi = await RubyEnvironmentsApi.getApi();
const rubyEnv = await rubyEnvApi.getEnvironment(vscode.workspace.workspaceFolders[0]!);
console.log(rubyEnv);

[ono-max]

I have signed the CLA!

[rafaelfranca]

I don't like this API. I'd prefer to use closer to the one used in the python environments extension

https://github.com/microsoft/vscode-python/blob/cbcf5e17341c7e0f5c71c16c3262852f643d48b8/src/client/pythonEnvironments/api.ts

Something like:

import { RubyEnvironments } from '@shopify/ruby-environments';
api = new RubyEnvironments(vscode.workspace.workspaceFolders[0]!);
await api.activate();
const rubyEnv = await api.getEnvironment();
console.log(rubyEnv);