Deprecate stylua.releaseVersion

JohnnyMorganz · Dec 30, 2023 · fcab9a9 · fcab9a9
1 parent bb0c505
commit fcab9a9
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 1 deletion.
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]
 
+### Deprecated
+
+- `stylua.releaseVersion` is deprecated (as it required continual updates of available versions). Prefer `stylua.targetReleaseVersion` and the `Stylua: Select Version` command
+
 ### Added
 
 - Added configuration option `stylua.configPath` to provide a direct path to a `stylua.toml` file. Note: this will override any workspace config lookup

diff --git a/stylua-vscode/package.json b/stylua-vscode/package.json
@@ -79,7 +79,8 @@
           "enumDescriptions": [
             "The most recent version released. This will always keep you up to date."
           ],
-          "markdownDescription": "The release version to install. This is overridden by `#stylua.targetReleaseVersion#`."
+          "markdownDescription": "The release version to install. This is overridden by `#stylua.targetReleaseVersion#`.",
+          "markdownDeprecationMessage": "Use `#stylua.targetReleaseVersion#` instead, and the `Stylua: Select Version` command."
         },
         "stylua.targetReleaseVersion": {
           "type": "string",

diff --git a/stylua-vscode/src/util.ts b/stylua-vscode/src/util.ts
@@ -59,6 +59,7 @@ export const getDesiredVersion = (): string => {
   const config = vscode.workspace.getConfiguration("stylua");
   const targetVersion = config.get<string>("targetReleaseVersion", "").trim();
   if (targetVersion.length === 0) {
+    // TODO: Backwards compatibility to support deprecated setting `stylua.releaseVersion`
     return config.get<string>("releaseVersion", "latest");
   }
   return targetVersion;