Merge pull request #423 from tgodzik/add-mirror

Add mirror env variable when set by the user

Author: tgodzik

src/checkServerVersion.ts

@@ -1,6 +1,7 @@
-import { WorkspaceConfiguration } from "./interfaces/WorkspaceConfiguration";
-import { ConfigurationTarget } from "./interfaces/ConfigurationTarget";
 import * as semver from "semver";
+import { ConfigurationTarget } from "./interfaces/ConfigurationTarget";
+import { UserConfiguration } from "./interfaces/UserConfiguration";
+import { WorkspaceConfiguration } from "./interfaces/WorkspaceConfiguration";
 
 interface OnOutdatedParams {
   message: string;
@@ -16,7 +17,7 @@ interface UpdateConfigParams {
   configurationTarget: ConfigurationTarget;
 }
 
-const configSection = "serverVersion";
+const configSection = UserConfiguration.ServerVersion;
 
 interface CheckServerVersionParams {
   config: WorkspaceConfiguration;

src/detectLaunchConfigurationChanges.ts

@@ -1,3 +1,4 @@
+import { UserConfiguration } from "./interfaces/UserConfiguration";
 import { Workspace } from "./interfaces/Workspace";
 
 interface PromptRestartParams {
@@ -13,10 +14,11 @@ export function detectLaunchConfigurationChanges(
 ): void {
   workspace.onDidChangeConfiguration((e) => {
     const promptRestartKeys = [
-      "serverVersion",
-      "serverProperties",
-      "javaHome",
-      "customRepositories",
+      UserConfiguration.ServerVersion,
+      UserConfiguration.ServerProperties,
+      UserConfiguration.JavaHome,
+      UserConfiguration.CustomRepositories,
+      UserConfiguration.CoursierMirror,
       ...additionalRestartKeys,
     ];
     const shouldPromptRestart = promptRestartKeys.some((key) =>

src/getJavaConfig.ts

@@ -5,6 +5,7 @@ export interface JavaConfig {
   javaOptions: string[];
   javaPath: string;
   coursierPath: string;
+  coursierMirrorFilePath: string | undefined;
   extraEnv: {
     [k: string]: string | undefined;
   };
@@ -14,27 +15,31 @@ interface GetJavaConfigOptions {
   workspaceRoot: string | undefined;
   javaHome: string;
   extensionPath: string;
+  coursierMirrorFilePath: string | undefined;
   customRepositories: string[] | undefined;
 }
 
 export function getJavaConfig({
   workspaceRoot,
   javaHome,
   extensionPath,
+  coursierMirrorFilePath,
   customRepositories = [],
 }: GetJavaConfigOptions): JavaConfig {
   const javaOptions = getJavaOptions(workspaceRoot);
   const javaPath = path.join(javaHome, "bin", "java");
   const coursierPath = path.join(extensionPath, "./coursier");
   const extraEnv = {
     COURSIER_REPOSITORIES: customRepositories.join("|"),
+    COURSIER_MIRRORS: coursierMirrorFilePath,
     JAVA_HOME: javaHome,
   };
 
   return {
     javaOptions,
     javaPath,
     coursierPath,
+    coursierMirrorFilePath,
     extraEnv,
   };
 }

src/interfaces/ClientCommands.ts

@@ -2,7 +2,7 @@
  * These are all of the client commands that Metals supports. Note that not support
  * may vary based on the `InitializationSettings` the client sets.
  *
- *  - https://scalameta.org/metals/docs/editors/new-editor.html#metals-client-commands
+ *  - https://scalameta.org/metals/docs/integrations/new-editor#metals-client-commands
  */
 export const ClientCommands = {
   /**

src/interfaces/UserConfiguration.ts

@@ -0,0 +1,28 @@
+/**
+ * These are some of the common user configuration options used in Metals and needed for the editors.
+ *
+ *  - https://scalameta.org/metals/docs/integrations/new-editor#metals-user-configuration
+ */
+export enum UserConfiguration {
+  /**
+   * Metals server version
+   */
+  ServerVersion = "serverVersion",
+  /**
+   * Metals server Java properties
+   */
+  ServerProperties = "serverProperties",
+  /**
+   * Directory containing the Java binary.
+   */
+  JavaHome = "javaHome",
+  /**
+   * Additional repositories that can be used to download dependencies.
+   * https://get-coursier.io/docs/other-repositories
+   */
+  CustomRepositories = "customRepositories",
+  /**
+   * Repository to use instead of maven central for example `https://jcenter.bintray.com`
+   */
+  CoursierMirror = "coursierMirror",
+}