fix: error logging (#8)

Author: harrydowning

CHANGELOG.md

@@ -6,6 +6,16 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/), and this
 
 ## [Unreleased]
 
+## [0.1.2] - 2024-03-09
+
+### Fixed
+
+- Output channel error logging
+
+### Changed
+
+- Shields in `README.md`
+
 ## [0.1.1] - 2024-03-08
 
 ### Added
@@ -39,7 +49,8 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/), and this
 
 - Swap Tsconfig extension with command `swap-tsconfig` and settings `swap-tsconfig.exclude` and `swap-tsconfig.include`
 
-[unreleased]: https://github.com/harrydowning/swap-tsconfig/compare/v0.1.1...HEAD
+[unreleased]: https://github.com/harrydowning/swap-tsconfig/compare/v0.1.2...HEAD
+[0.1.2]: https://github.com/harrydowning/swap-tsconfig/compare/v0.1.1...v0.1.2
 [0.1.1]: https://github.com/harrydowning/swap-tsconfig/compare/v0.1.0...v0.1.1
 [0.1.0]: https://github.com/harrydowning/swap-tsconfig/compare/v0.0.1...v0.1.0
 [0.0.1]: https://github.com/harrydowning/swap-tsconfig/releases/tag/v0.0.1

README.md

@@ -1,9 +1,7 @@
-<h1 align="center">
-  <img src="https://raw.githubusercontent.com/harrydowning/swap-tsconfig/main/assets/banner.png" alt="Swap Tsconfig">
-</h1>
-
 <div align="center">
 
+# ![Swap Tsconfig](https://raw.githubusercontent.com/harrydowning/swap-tsconfig/main/assets/banner.png)
+
 ![GitHub License](https://img.shields.io/github/license/harrydowning/swap-tsconfig?style=for-the-badge)
 ![Visual Studio Marketplace Version](https://img.shields.io/visual-studio-marketplace/v/harrydowning.swap-tsconfig?style=for-the-badge)
 ![Visual Studio Marketplace Downloads](https://img.shields.io/visual-studio-marketplace/d/harrydowning.swap-tsconfig?style=for-the-badge)

__mocks__/vscode.ts

@@ -3,6 +3,10 @@ export const window = {
   showInformationMessage: jest.fn(),
   showWorkspaceFolderPick: jest.fn(),
   showQuickPick: jest.fn(),
+  createOutputChannel: jest.fn(() => ({
+    error: jest.fn(),
+    show: jest.fn(),
+  })),
 };
 
 export const workspace = {

package.json

@@ -1,7 +1,7 @@
 {
   "name": "swap-tsconfig",
   "displayName": "Swap Tsconfig",
-  "version": "0.1.1",
+  "version": "0.1.2",
   "description": "Command to swap between multiple Typescript configuration files",
   "categories": [
     "Other"

src/extension.spec.ts

@@ -1,6 +1,7 @@
 import * as vscode from "vscode";
 import { activate, deactivate } from "./extension";
 import { FileSwap } from "./file-swap";
+import { logger } from "./utils";
 
 jest.mock("./file-swap");
 
@@ -18,7 +19,7 @@ describe("extension", () => {
       activate(mockContext);
 
       expect(vscode.commands.registerCommand).toHaveBeenCalledTimes(1);
-      expect(mockContext.subscriptions).toContain(mockDisposable);
+      expect(mockContext.subscriptions).toStrictEqual([mockDisposable, logger]);
 
       const registeredCommand = jest.mocked(vscode.commands.registerCommand)
         .mock.calls[0][1];

src/extension.ts

@@ -1,5 +1,5 @@
 import * as vscode from "vscode";
-import { commandWrapper } from "./utils";
+import { commandWrapper, logger } from "./utils";
 import { FileSwap } from "./file-swap";
 
 const settings = vscode.workspace.getConfiguration("swap-tsconfig");
@@ -15,7 +15,7 @@ export const activate = (context: vscode.ExtensionContext) => {
     commandWrapper(async () => tsconfigFileSwap.swap()),
   );
 
-  context.subscriptions.push(disposable);
+  context.subscriptions.push(disposable, logger);
 };
 
 export const deactivate = () => {

src/utils.spec.ts

@@ -1,6 +1,11 @@
 import * as vscode from "vscode";
 import { FatalExtensionError, NonFatalExtensionError } from "./extension-error";
-import { commandWrapper, getNonNullable, getWorkspaceFolder } from "./utils";
+import {
+  commandWrapper,
+  getNonNullable,
+  getWorkspaceFolder,
+  logger,
+} from "./utils";
 
 describe("utils", () => {
   describe("commandWrapper", () => {
@@ -25,7 +30,6 @@ describe("utils", () => {
 
     it("should show a generic error message and log to console on any other Error", () => {
       const error = new Error();
-      const consoleErrorSpy = jest.spyOn(console, "error");
       commandWrapper(() => {
         throw error;
       })();
@@ -34,8 +38,9 @@ describe("utils", () => {
       expect(vscode.window.showErrorMessage).toHaveBeenCalledWith(
         "An error has occurred.",
       );
-      expect(consoleErrorSpy).toHaveBeenCalledTimes(1);
-      expect(consoleErrorSpy).toHaveBeenCalledWith(error);
+      expect(logger.error).toHaveBeenCalledTimes(1);
+      expect(logger.error).toHaveBeenCalledWith(error);
+      expect(logger.show).toHaveBeenCalledTimes(1);
     });
   });
 

src/utils.ts

@@ -5,6 +5,10 @@ import {
   NonFatalExtensionError,
 } from "./extension-error";
 
+export const logger = vscode.window.createOutputChannel("Swap Tsconfig", {
+  log: true,
+});
+
 export const commandWrapper = (command: () => Promise<void> | void) => {
   return async () => {
     try {
@@ -14,7 +18,8 @@ export const commandWrapper = (command: () => Promise<void> | void) => {
         vscode.window.showErrorMessage(error.message);
       } else if (error instanceof Error) {
         vscode.window.showErrorMessage("An error has occurred.");
-        console.error(error);
+        logger.error(error);
+        logger.show();
       }
     }
   };