feat(vscode): remove unnecessary logger code (#685)

Author: claneo

packages/vscode/README.md

@@ -15,10 +15,10 @@ The extension activates automatically when your workspace contains Rstest config
 
 ## Configuration
 
-| Setting                      | Type     | Default                          | Description                                                                     |
-| ---------------------------- | -------- | -------------------------------- | ------------------------------------------------------------------------------- |
-| `rstest.testFileGlobPattern` | string[] | `["**/*.test.*", "**/*.spec.*"]` | Glob pattern(s) used to discover test files in the workspace.                   |
-| `rstest.logLevel`            | string   | `default`                        | Controls Output channel verbosity; set to `debug` for extra diagnostic logging. |
+| Setting                      | Type     | Default                          | Description                                                                                                                                                                                                                                                           |
+| ---------------------------- | -------- | -------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `rstest.testFileGlobPattern` | string[] | `["**/*.test.*", "**/*.spec.*"]` | Glob pattern(s) used to discover test files in the workspace.                                                                                                                                                                                                         |
+| `rstest.rstestPackagePath`   | string   | `undefined`                      | The path to a `package.json` file of a Rstest executable (it's usually inside `node_modules`) in case the extension cannot find it. It will be used to resolve Rstest API paths. This should be used as a last resort fix. Supports `${workspaceFolder}` placeholder. |
 
 ## How it works
 

packages/vscode/package.json

@@ -39,16 +39,6 @@
             "**/*.spec.*"
           ]
         },
-        "rstest.logLevel": {
-          "markdownDescription": "Controls how much diagnostic output the Rstest extension emits to the Output view.",
-          "scope": "window",
-          "type": "string",
-          "enum": [
-            "default",
-            "debug"
-          ],
-          "default": "default"
-        },
         "rstest.rstestPackagePath": {
           "markdownDescription": "The path to a `package.json` file of a Rstest executable (it's usually inside `node_modules`) in case the extension cannot find it. It will be used to resolve Rstest API paths. This should be used as a last resort fix. Supports `${workspaceFolder}` placeholder.",
           "scope": "resource",

packages/vscode/src/config.ts

@@ -1,23 +1,18 @@
 import vscode from 'vscode';
 
-export type LogLevel = 'default' | 'debug';
-
 // Centralized configuration types for the extension.
 // Add new keys here to extend configuration in a type-safe way.
 export type ExtensionConfig = {
   // Glob patterns that determine which files are considered tests.
   // Must be an array of strings.
   testFileGlobPattern: string[];
-  // Controls verbosity of extension logging routed to the Output channel.
-  logLevel: LogLevel;
   // The path to a package.json file of a Rstest executable.
   // Used as a last resort if the extension cannot auto-detect @rstest/core.
   rstestPackagePath?: string;
 };
 
 export const defaultConfig: ExtensionConfig = {
   testFileGlobPattern: ['**/*.test.*', '**/*.spec.*'],
-  logLevel: 'default',
 };
 
 // Type-safe getter for a single config value with priority:
@@ -42,11 +37,6 @@ export function getConfigValue<K extends keyof ExtensionConfig>(
     return (isStringArray(v) ? v : defaultConfig[key]) as ExtensionConfig[K];
   }
 
-  if (key === 'logLevel') {
-    const v = value as unknown;
-    return (isLogLevel(v) ? v : defaultConfig[key]) as ExtensionConfig[K];
-  }
-
   if (key === 'rstestPackagePath') {
     const v = value as unknown;
     return (
@@ -61,15 +51,10 @@ function isStringArray(v: unknown): v is string[] {
   return Array.isArray(v) && v.every((x) => typeof x === 'string');
 }
 
-function isLogLevel(v: unknown): v is LogLevel {
-  return v === 'default' || v === 'debug';
-}
-
 // Convenience to get a full, normalized config object at the given scope.
 export function getConfig(folder?: vscode.WorkspaceFolder): ExtensionConfig {
   return {
     testFileGlobPattern: getConfigValue('testFileGlobPattern', folder),
-    logLevel: getConfigValue('logLevel', folder),
     rstestPackagePath: getConfigValue('rstestPackagePath', folder),
   } satisfies ExtensionConfig;
 }

packages/vscode/src/extension.ts

@@ -35,7 +35,7 @@ class Rstest {
   constructor(context: vscode.ExtensionContext) {
     this.context = context;
     this.ctrl = vscode.tests.createTestController('rstest', 'Rstest');
-    context.subscriptions.push(this.ctrl, logger);
+    context.subscriptions.push(this.ctrl);
 
     this.fileChangedEmitter = new vscode.EventEmitter<vscode.Uri>();
     this.watchingTests = new Map<

packages/vscode/src/logger.ts

@@ -1,69 +1,39 @@
-import { inspect } from 'node:util';
+import { formatWithOptions } from 'node:util';
 import vscode from 'vscode';
-import { getConfigValue, type LogLevel } from './config';
 
 function formatValues(values: unknown[]): string {
-  return values
-    .map((value) =>
-      typeof value === 'string'
-        ? value
-        : inspect(value, { depth: 4, colors: false }),
-    )
-    .join(' ');
+  return formatWithOptions({ depth: 4 }, ...values);
 }
 
 export class Logger implements vscode.Disposable {
-  private readonly channel: vscode.OutputChannel;
-  private readonly disposables: vscode.Disposable[] = [];
-  private level: LogLevel;
+  readonly #channel: vscode.LogOutputChannel;
 
   constructor(private readonly name = 'Rstest') {
-    this.channel = vscode.window.createOutputChannel(this.name);
-    this.level = this.readLevel();
-    this.disposables.push(
-      vscode.workspace.onDidChangeConfiguration((event) => {
-        if (event.affectsConfiguration('rstest.logLevel')) {
-          this.level = this.readLevel();
-        }
-      }),
-    );
+    this.#channel = vscode.window.createOutputChannel(this.name, { log: true });
   }
 
-  public debug(...values: unknown[]) {
-    if (this.level !== 'debug') {
-      return;
-    }
+  public trace(...values: unknown[]) {
+    this.#channel.trace(formatValues(values));
+  }
 
-    this.write('DEBUG', values);
+  public debug(...values: unknown[]) {
+    this.#channel.debug(formatValues(values));
   }
 
   public info(...values: unknown[]) {
-    this.write('INFO', values);
+    this.#channel.info(formatValues(values));
   }
 
   public warn(...values: unknown[]) {
-    this.write('WARN', values);
+    this.#channel.warn(formatValues(values));
   }
 
   public error(...values: unknown[]) {
-    this.write('ERROR', values);
+    this.#channel.error(formatValues(values));
   }
 
   public dispose() {
-    this.disposables.forEach((disposable) => {
-      disposable.dispose();
-    });
-    this.channel.dispose();
-  }
-
-  private readLevel(): LogLevel {
-    return getConfigValue('logLevel');
-  }
-
-  private write(tag: string, values: unknown[]) {
-    const timestamp = new Date().toISOString();
-    const message = formatValues(values);
-    this.channel.appendLine(`[${timestamp}] [${tag}] ${message}`);
+    this.#channel.dispose();
   }
 }
 

packages/vscode/tests/fixtures/.vscode/settings.json

@@ -1,3 +1 @@
-{
-  "rstest.logLevel": "default"
-}
+{}

packages/vscode/tests/suite/config.test.ts

@@ -2,7 +2,7 @@ import * as assert from 'node:assert';
 import * as fs from 'node:fs';
 import * as path from 'node:path';
 import * as vscode from 'vscode';
-import { delay, waitForConfigValue } from './helpers';
+import { delay } from './helpers';
 
 suite('Configuration Integration', () => {
   function clearController(ctrl: vscode.TestController) {
@@ -125,35 +125,4 @@ suite('Configuration Integration', () => {
       }
     }
   });
-
-  test('respects rstest.logLevel', async () => {
-    const config = vscode.workspace.getConfiguration('rstest');
-    const prev = config.get('logLevel');
-
-    try {
-      await config.update(
-        'logLevel',
-        'debug',
-        vscode.ConfigurationTarget.Workspace,
-      );
-      await delay(500);
-
-      let logLevel = config.get('logLevel');
-
-      logLevel = await waitForConfigValue({
-        initialValue: logLevel,
-        read: () => vscode.workspace.getConfiguration('rstest').get('logLevel'),
-        expected: 'debug',
-      });
-
-      assert.strictEqual(logLevel, 'debug');
-    } finally {
-      await config.update(
-        'logLevel',
-        (prev as any) ?? undefined,
-        vscode.ConfigurationTarget.Workspace,
-      );
-      await delay(100);
-    }
-  });
 });