Remove the RubyEnvironment type and use IEnvironment

The environment can vary between platforms. Instead, we'll just whitelist keys to import on the client and pass them transparently through to the server.

Author: wingrunr21

client/src/WorkspaceRubyEnvironment.ts

@@ -5,14 +5,14 @@ import {
 	StaticFeature,
 } from 'vscode-languageclient';
 import { Uri, workspace, WorkspaceFolder } from 'vscode';
-import { loadEnv, RubyEnvironment } from './util/env';
+import { loadEnv, IEnvironment } from './util/env';
 
 interface WorkspaceRubyEnvironmentParams {
 	readonly folders: string[];
 }
 
 interface WorkspaceRubyEnvironmentResult {
-	[key: string]: RubyEnvironment;
+	[key: string]: IEnvironment;
 }
 
 namespace WorkspaceRubyEnvironmentRequest {

client/src/util/env.ts

@@ -92,22 +92,11 @@ const RUBY_ENVIRONMENT_VARIABLES = [
 	'RUBOCOP_OPTS',
 ];
 
-export type RubyEnvironment = {
-	PATH: string;
-	RUBY_VERSION: string;
-	RUBY_ROOT: string;
-	GEM_HOME: string;
-	GEM_PATH: string;
-	GEM_ROOT: string;
-	HOME: string;
-	RUBOCOP_OPTS?: string;
-};
-
 export interface IEnvironment {
 	[key: string]: string;
 }
 
-export function loadEnv(cwd: string): RubyEnvironment {
+export function loadEnv(cwd: string): IEnvironment {
 	const shim: string = getShim();
 	const env: IEnvironment = {};
 	const { stdout, stderr } = execa.sync(shim, [], {
@@ -118,10 +107,11 @@ export function loadEnv(cwd: string): RubyEnvironment {
 
 	for (const line of stdout.split('\n')) {
 		const result: string[] = processExportLine(line);
-		if (RUBY_ENVIRONMENT_VARIABLES.indexOf(result[0]) >= 0) {
-			env[result[0]] = result[1];
+		const name = result[0];
+		if (RUBY_ENVIRONMENT_VARIABLES.indexOf(name) >= 0) {
+			env[name] = result[1];
 		}
 	}
 
-	return env as RubyEnvironment;
+	return env;
 }

server/src/Formatter.ts

@@ -1,7 +1,7 @@
 import { Range, TextDocument, TextDocumentIdentifier, TextEdit } from 'vscode-languageserver';
 import {
 	documentConfigurationCache,
-	RubyEnvironment,
+	IEnvironment,
 	workspaceRubyEnvironmentCache,
 	RubyConfiguration,
 } from './SettingsCache';
@@ -19,7 +19,7 @@ const FORMATTER_MAP = {
 
 function getFormatter(
 	document: TextDocument,
-	env: RubyEnvironment,
+	env: IEnvironment,
 	config: RubyConfiguration,
 	range?: Range
 ): IFormatter {

server/src/Linter.ts

@@ -4,7 +4,7 @@ import { map, mergeMap, switchMap } from 'rxjs/operators';
 import { Diagnostic, TextDocument } from 'vscode-languageserver';
 import {
 	documentConfigurationCache,
-	RubyEnvironment,
+	IEnvironment,
 	workspaceRubyEnvironmentCache,
 	RubyConfiguration,
 	RubyCommandConfiguration,
@@ -27,7 +27,7 @@ export type LintResult = {
 function getLinter(
 	name: string,
 	document: TextDocument,
-	env: RubyEnvironment,
+	env: IEnvironment,
 	config: RubyConfiguration
 ): ILinter {
 	const linter = LINTER_MAP[name];

server/src/Server.ts

@@ -20,7 +20,7 @@ import {
 	documentConfigurationCache,
 	workspaceRubyEnvironmentCache,
 	RubyConfiguration,
-	RubyEnvironment,
+	IEnvironment,
 } from './SettingsCache';
 import DocumentFormattingProvider from './providers/DocumentFormattingProvider';
 
@@ -35,7 +35,7 @@ interface WorkspaceRubyEnvironmentParams {
 }
 
 interface WorkspaceRubyEnvironmentResult {
-	readonly [key: string]: RubyEnvironment;
+	readonly [key: string]: IEnvironment;
 }
 
 namespace WorkspaceRubyEnvironmentRequest {
@@ -78,7 +78,7 @@ export class Server implements ILanguageServer {
 		if (this.calculator.clientCapabilities.workspace.rubyEnvironment) {
 			workspaceRubyEnvironmentCache.fetcher = async (
 				folders: string[]
-			): Promise<RubyEnvironment[]> => {
+			): Promise<IEnvironment[]> => {
 				const result: WorkspaceRubyEnvironmentResult = await this.connection.sendRequest(
 					WorkspaceRubyEnvironmentRequest.type,
 					{
@@ -91,8 +91,8 @@ export class Server implements ILanguageServer {
 		} else {
 			workspaceRubyEnvironmentCache.fetcher = async (
 				folders: string[]
-			): Promise<RubyEnvironment[]> => {
-				return folders.map(_f => process.env as RubyEnvironment);
+			): Promise<IEnvironment[]> => {
+				return folders.map(_f => process.env as IEnvironment);
 			};
 		}
 	}

server/src/SettingsCache.ts

@@ -1,15 +1,8 @@
 import { TextDocument, WorkspaceFolder } from 'vscode-languageserver';
 
-export type RubyEnvironment = {
-	PATH: string;
-	RUBY_VERSION: string;
-	RUBY_ROOT: string;
-	GEM_HOME: string;
-	GEM_PATH: string;
-	GEM_ROOT: string;
-	HOME: string;
-	RUBOCOP_OPTS?: string;
-};
+export interface IEnvironment {
+	[key: string]: string;
+}
 
 export type RubyCommandConfiguration = {
 	command?: string;
@@ -105,4 +98,4 @@ class SettingsCache<P extends WorkspaceFolder | TextDocument, T> {
 }
 
 export const documentConfigurationCache = new SettingsCache<TextDocument, RubyConfiguration>();
-export const workspaceRubyEnvironmentCache = new SettingsCache<WorkspaceFolder, RubyEnvironment>();
+export const workspaceRubyEnvironmentCache = new SettingsCache<WorkspaceFolder, IEnvironment>();

server/src/formatters/BaseFormatter.ts

@@ -9,14 +9,14 @@ import {
 	DIFF_INSERT,
 	DIFF_EQUAL,
 } from 'diff-match-patch';
-import { RubyEnvironment, RubyCommandConfiguration } from '../SettingsCache';
+import { IEnvironment, RubyCommandConfiguration } from '../SettingsCache';
 
 export interface IFormatter {
 	format(): Observable<TextEdit[]>;
 }
 
 export type FormatterConfig = {
-	env: RubyEnvironment;
+	env: IEnvironment;
 	executionRoot: string;
 	config: RubyCommandConfiguration;
 	range?: Range;

server/src/linters/BaseLinter.ts

@@ -2,14 +2,14 @@ import { Diagnostic, TextDocument } from 'vscode-languageserver';
 import { spawn } from 'spawn-rx';
 import { of, Observable, empty } from 'rxjs';
 import { map, catchError } from 'rxjs/operators';
-import { RubyEnvironment, RubyCommandConfiguration } from '../SettingsCache';
+import { IEnvironment, RubyCommandConfiguration } from '../SettingsCache';
 
 export interface ILinter {
 	lint(): Observable<Diagnostic[]>;
 }
 
 export type LinterConfig = {
-	env: RubyEnvironment;
+	env: IEnvironment;
 	executionRoot: string;
 	config: RubyCommandConfiguration;
 };