fix formatting cwd fallback and add test

Author: mshr-h

package-lock.json

@@ -607,6 +607,7 @@
     "@types/glob": "^8.1.0",
     "@types/mocha": "~10.0.6",
     "@types/node": "~22.10.0",
+    "@types/proxyquire": "^1.3.31",
     "@types/vscode": "^1.75.0",
     "@types/which": "^3.0.3",
     "@typescript-eslint/eslint-plugin": "^7.3.1",

package.json

@@ -2,6 +2,7 @@
 import * as vscode from 'vscode';
 import {exec as execNonPromise} from 'child_process';
 import * as util from 'util';
+import * as path from 'path';
 import { Logger } from './logger';
 const exec = util.promisify(execNonPromise);
 
@@ -366,7 +367,11 @@ export class CtagsManager {
     }
 
     // kick off async job for indexing for module.sv
-    let searchPattern = new vscode.RelativePattern(vscode.workspace.workspaceFolders[0], `**/${moduleToFind}.sv`);
+    const wsFolders = vscode.workspace.workspaceFolders;
+    const base = wsFolders && wsFolders.length > 0
+      ? wsFolders[0]
+      : path.dirname(document.uri.fsPath);
+    let searchPattern = new vscode.RelativePattern(base, `**/${moduleToFind}.sv`);
     let files = await vscode.workspace.findFiles(searchPattern);
     if (files.length !== 0) {
       let file = await vscode.workspace.openTextDocument(files[0]);

src/ctags.ts

@@ -19,7 +19,9 @@ export default abstract class BaseLinter {
     if (path.isAbsolute(inputPath)) {
       return inputPath;
     }
-    return path.join(vscode.workspace.workspaceFolders[0].uri.fsPath, inputPath);
+    const wsFolders = vscode.workspace.workspaceFolders;
+    const base = wsFolders && wsFolders.length > 0 ? wsFolders[0].uri.fsPath : '';
+    return path.join(base, inputPath);
   }
 
   public startLint(doc: vscode.TextDocument) {

src/linter/BaseLinter.ts

@@ -72,10 +72,11 @@ export default class IcarusLinter extends BaseLinter {
     let command: string = binPath + ' ' + args.join(' ');
 
     // TODO: We have to apply the the #419 fix?
+    const wsFolders = vscode.workspace.workspaceFolders;
     let cwd: string =
-      this.runAtFileLocation || vscode.workspace.workspaceFolders === undefined
+      this.runAtFileLocation || !wsFolders || wsFolders.length === 0
         ? path.dirname(doc.uri.fsPath)
-        : vscode.workspace.workspaceFolders[0].uri.fsPath;
+        : wsFolders[0].uri.fsPath;
 
     this.logger.info('Execute');
     this.logger.info('  command: ', command);

src/linter/IcarusLinter.ts

@@ -78,11 +78,14 @@ export default class SlangLinter extends BaseLinter {
     args.push(`"${docUri}"`);
     let command: string = binPath + ' ' + args.join(' ');
 
+    const wsFolders = vscode.workspace.workspaceFolders;
     let cwd: string = this.runAtFileLocation
       ? isWindows
         ? cwdWin
         : docFolder
-      : vscode.workspace.workspaceFolders[0].uri.fsPath;
+      : wsFolders && wsFolders.length > 0
+        ? wsFolders[0].uri.fsPath
+        : path.dirname(doc.uri.fsPath);
 
     this.logger.info('[slang] Execute');
     this.logger.info('[slang]   command: ' + command);

src/linter/SlangLinter.ts

@@ -76,11 +76,14 @@ export default class VerilatorLinter extends BaseLinter {
         ? this.convertToWslPath(path.dirname(doc.uri.fsPath))
         : path.dirname(doc.uri.fsPath).replace(/\\/g, '/')
       : path.dirname(doc.uri.fsPath);
+    const wsFolders = vscode.workspace.workspaceFolders;
     let cwd: string = this.runAtFileLocation
       ? isWindows
         ? path.dirname(doc.uri.fsPath.replace(/\\/g, '/'))
         : docFolder
-      : vscode.workspace.workspaceFolders[0].uri.fsPath;
+      : wsFolders && wsFolders.length > 0
+        ? wsFolders[0].uri.fsPath
+        : path.dirname(doc.uri.fsPath);
     let verilator: string = isWindows
       ? this.useWSL
         ? 'wsl verilator'

src/linter/VerilatorLinter.ts

@@ -68,7 +68,12 @@ abstract class FileBasedFormattingEditProvider implements vscode.DocumentFormatt
     let binPath: string = this.config.get('path');
     this.logger.info('Executing command: ' + binPath + ' ' + args.join(' '));
     try {
-      child_process.execFileSync(binPath, args, {cwd: vscode.workspace.workspaceFolders[0].uri.fsPath});
+      const wsFolders = vscode.workspace.workspaceFolders;
+      const cwd =
+        wsFolders && wsFolders.length > 0
+          ? wsFolders[0].uri.fsPath
+          : path.dirname(document.uri.fsPath);
+      child_process.execFileSync(binPath, args, { cwd });
       let formattedText: string = tempFile.readFileSync({ encoding: 'utf-8' });
       let wholeFileRange: vscode.Range = new vscode.Range(
         document.positionAt(0),

src/providers/FormatPrivider.ts

@@ -0,0 +1,44 @@
+import * as assert from 'assert';
+import * as fs from 'fs';
+import * as os from 'os';
+import * as path from 'path';
+import * as proxyquire from 'proxyquire';
+
+suite('Formatting Provider', () => {
+  test('does not crash without workspace', () => {
+    const tmp = path.join(os.tmpdir(), 'fmt.v');
+    fs.writeFileSync(tmp, 'module m; endmodule');
+
+    const vscodeStub = {
+      workspace: {
+        getConfiguration: () => ({ get: () => '/bin/true' }),
+        workspaceFolders: undefined,
+      },
+      Range: class { constructor(public start: any, public end: any) {} },
+      Position: class { constructor(public line: number, public char: number) {} },
+      TextEdit: { replace: (_r: any, _t: any) => ({}) },
+    };
+
+    const providerModule = proxyquire('../../providers/FormatPrivider', {
+      vscode: vscodeStub,
+    });
+
+    const Provider = providerModule.VerilogFormatProvider;
+    const logger: any = {
+      info: () => {},
+      error: () => {},
+      warn: () => {},
+      debug: () => {},
+    };
+    logger.getChild = () => logger;
+    const provider = new Provider(logger);
+    const doc = {
+      uri: { fsPath: tmp },
+      getText: () => fs.readFileSync(tmp, 'utf8'),
+      positionAt: (_o: number) => new vscodeStub.Position(0, 0),
+      languageId: 'verilog',
+    };
+
+    assert.doesNotThrow(() => provider.provideDocumentFormattingEdits(doc as any, {} as any, {} as any));
+  });
+});