Add status bar instead of error notifications (VSC extension) (#826)

* Add option to hide formatting errors * Add status bar item and remove notification setting * Switch to language status item and update on editor change * Update changelog --------- Co-authored-by: JohnnyMorganz <[email protected]>
JohnnyMorganz · Dec 30, 2023 · c3a9d97 · c3a9d97
1 parent a61d983
commit c3a9d97
Show file tree

Hide file tree

Showing 3 changed files with 52 additions and 3 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]
 
+### Changed
+
+- Removed excessive error notifications on formatting failure and replaced with VSCode language status bar item
+
 ## [1.5.0] - 2023-03-11
 
 ### Added

diff --git a/stylua-vscode/package.json b/stylua-vscode/package.json
@@ -42,6 +42,11 @@
         "command": "stylua.authenticate",
         "title": "Authorize StyLua to use GitHub API",
         "category": "StyLua"
+      },
+      {
+        "command": "stylua.showOutputChannel",
+        "title": "Show Output Channel",
+        "category": "StyLua"
       }
     ],
     "configuration": {
@@ -87,7 +92,7 @@
         "stylua.disableVersionCheck": {
           "type": "boolean",
           "default": false,
-          "description": "Disable checking the version of stylua for newer versions. Useful if you do not want network requests"
+          "description": "Disable checking the version of stylua for newer versions. Useful if you do not want network requests."
         },
         "stylua.searchParentDirectories": {
           "type": "boolean",

diff --git a/stylua-vscode/src/extension.ts b/stylua-vscode/src/extension.ts
@@ -24,6 +24,11 @@ const byteOffset = (
 export async function activate(context: vscode.ExtensionContext) {
   console.log("stylua activated");
 
+  const outputChannel = vscode.window.createOutputChannel("StyLua", {
+    log: true,
+  });
+  outputChannel.info("StyLua activated");
+
   const github = new GitHub();
   context.subscriptions.push(github);
 
@@ -48,6 +53,12 @@ export async function activate(context: vscode.ExtensionContext) {
     })
   );
 
+  context.subscriptions.push(
+    vscode.commands.registerCommand("stylua.showOutputChannel", async () => {
+      outputChannel.show();
+    })
+  );
+
   context.subscriptions.push(
     vscode.workspace.onDidChangeConfiguration(async (change) => {
       if (change.affectsConfiguration("stylua")) {
@@ -58,8 +69,22 @@ export async function activate(context: vscode.ExtensionContext) {
     })
   );
 
+  const documentSelector = ["lua", "luau"];
+
+  const languageStatusItem = vscode.languages.createLanguageStatusItem(
+    "stylua",
+    documentSelector
+  );
+  languageStatusItem.name = "StyLua";
+  languageStatusItem.text = "$(check) StyLua";
+  languageStatusItem.detail = "Ready";
+  languageStatusItem.command = {
+    title: "Show Output",
+    command: "stylua.showOutputChannel",
+  };
+
   let disposable = vscode.languages.registerDocumentRangeFormattingEditProvider(
-    ["lua", "luau"],
+    documentSelector,
     {
       async provideDocumentRangeFormattingEdits(
         document: vscode.TextDocument,
@@ -112,16 +137,31 @@ export async function activate(context: vscode.ExtensionContext) {
             fullDocumentRange,
             formattedText
           );
+          languageStatusItem.text = "$(check) StyLua";
+          languageStatusItem.detail = "File formatted successfully";
+          languageStatusItem.severity =
+            vscode.LanguageStatusSeverity.Information;
           return [format];
         } catch (err) {
-          vscode.window.showErrorMessage(`Could not format file: ${err}`);
+          languageStatusItem.text = "StyLua";
+          languageStatusItem.detail = "Failed to format file";
+          languageStatusItem.severity = vscode.LanguageStatusSeverity.Error;
+          outputChannel.error(err as string);
           return [];
         }
       },
     }
   );
 
   context.subscriptions.push(disposable);
+  context.subscriptions.push(languageStatusItem);
+  context.subscriptions.push(
+    vscode.window.onDidChangeActiveTextEditor((editor) => {
+      languageStatusItem.text = "$(check) StyLua";
+      languageStatusItem.detail = "Ready";
+      languageStatusItem.severity = vscode.LanguageStatusSeverity.Information;
+    })
+  );
 }
 
 // this method is called when your extension is deactivated