Add stylua.disableVersionCheck (#475)

JohnnyMorganz · Jun 25, 2022 · 8073ac6 · 8073ac6
1 parent e59603b
commit 8073ac6
Show file tree

Hide file tree

Showing 3 changed files with 42 additions and 29 deletions.
diff --git a/stylua-vscode/CHANGELOG.md b/stylua-vscode/CHANGELOG.md
@@ -11,6 +11,10 @@ To view the changelog of the StyLua binary, see [here](https://github.com/Johnny
 
 ## [Unreleased]
 
+### Added
+
+- Added `stylua.disableVersionCheck` to configure whether we call out to GitHub to check for newer versions. Useful if you do not want network requests
+
 ## [1.3.2] - 2022-03-07
 
 ### Changed

diff --git a/stylua-vscode/package.json b/stylua-vscode/package.json
@@ -78,6 +78,11 @@
           ],
           "default": null,
           "description": "Specifies the path of StyLua. If not specified, will automatically download one from the GitHub releases."
+        },
+        "stylua.disableVersionCheck": {
+          "type": "boolean",
+          "default": false,
+          "description": "Disable checking the version of stylua for newer versions. Useful if you do not want network requests"
         }
       }
     }

diff --git a/stylua-vscode/src/download.ts b/stylua-vscode/src/download.ts
@@ -27,36 +27,40 @@ export class StyluaDownloader {
         return;
       }
 
-      try {
-        const currentVersion = (
-          await executeStylua(path, ["--version"])
-        )?.trim();
-        const desiredVersion = util.getDesiredVersion();
-        const release = await this.github.getRelease(desiredVersion);
-        if (
-          currentVersion !==
-          `stylua ${
-            release.tagName.startsWith("v")
-              ? release.tagName.substr(1)
-              : release.tagName
-          }`
-        ) {
-          this.openUpdatePrompt(release);
-        }
-      } catch (err) {
-        vscode.window.showWarningMessage(
-          `Error checking the selected StyLua version, falling back to the currently installed version:\n${err}`
-        );
-        if (!this.github.authenticated) {
-          const option = await vscode.window.showInformationMessage(
-            "Authenticating with GitHub can fix rate limits.",
-            "Authenticate with GitHub"
+      if (
+        !vscode.workspace.getConfiguration("stylua").get("disableVersionCheck")
+      ) {
+        try {
+          const currentVersion = (
+            await executeStylua(path, ["--version"])
+          )?.trim();
+          const desiredVersion = util.getDesiredVersion();
+          const release = await this.github.getRelease(desiredVersion);
+          if (
+            currentVersion !==
+            `stylua ${
+              release.tagName.startsWith("v")
+                ? release.tagName.substr(1)
+                : release.tagName
+            }`
+          ) {
+            this.openUpdatePrompt(release);
+          }
+        } catch (err) {
+          vscode.window.showWarningMessage(
+            `Error checking the selected StyLua version, falling back to the currently installed version:\n${err}`
           );
-          switch (option) {
-            case "Authenticate with GitHub":
-              if (await this.github.authenticate()) {
-                return this.ensureStyluaExists();
-              }
+          if (!this.github.authenticated) {
+            const option = await vscode.window.showInformationMessage(
+              "Authenticating with GitHub can fix rate limits.",
+              "Authenticate with GitHub"
+            );
+            switch (option) {
+              case "Authenticate with GitHub":
+                if (await this.github.authenticate()) {
+                  return this.ensureStyluaExists();
+                }
+            }
           }
         }
       }