Experimenting with a VSCode extension that requires the act of launching a folder/workspace

Question

Experimenting with a VSCode extension that requires the act of launching a folder/workspace

Currently, I am developing a custom VSCode extension that considers the path of the file being opened within the workspace.

To create a reproducible test scenario, I want to open the test folder itself in VSCode and then proceed to open the test file within it. The code snippet for this action is as follows:

import * as vscode from "vscode";

test("whatever", async function() {
    let workspaceUri = vscode.Uri.file(__dirname);
    // however, the execution halts at this point...
    await vscode.commands.executeCommand("vscode.openFolder", workspaceUri);
    await vscode.workspace.openTextDocument(__filename);
})

The issue arises when attempting this process, leading to the tests prematurely stopping before even testing my actual code. A similar problem is discussed here.

Is there a workaround or method through which I can safely open a workspace and utilize it during tests?

typescript visual-studio-code vscode-extensions

Answer 1

Answer №1

For detailed information on testing extensions, be sure to consult the documentation: Testing-extensions-docs

In your extension's development .vscode/launch.json file, you have the ability to include arguments as outlined in the documentation:

"args": ["file or folder name", "--extensionDevelopmentPath=${workspaceRoot}", "--extensionTestsPath=${workspaceRoot}/out/test" ]

You can construct a testing directory structure containing all necessary files within the specified folder mentioned in the configuration, and ensure that these directories/files are added to your .vscodeignore (the default test directory is already present there).

The alternative approach I have been using involves employing a bash script with the following code snippet:

#!/bin/bash

# $0 = command itself
# $1 = extension-directory(relative path)
# $2 = process-id of code to kill

[ -z "$1" ] && { echo "path argument not provided"; exit 1; }
[ -z "$2" ] || { xkill -id $2; }

cd $1
vsce package
file=$(find . -name "*.vsix")
code --install-extension $file
code &
echo $!

All that remains is opening a folder in the launched code instance and executing required commands. Establishing a suitable testing environment appears to offer more advantages in the long run, particularly if it is anticipated that numerous tests will need to be conducted.

Answer 2

For detailed information on testing extensions, be sure to consult the documentation: Testing-extensions-docs

In your extension's development .vscode/launch.json file, you have the ability to include arguments as outlined in the documentation:

"args": ["file or folder name", "--extensionDevelopmentPath=${workspaceRoot}", "--extensionTestsPath=${workspaceRoot}/out/test" ]

You can construct a testing directory structure containing all necessary files within the specified folder mentioned in the configuration, and ensure that these directories/files are added to your .vscodeignore (the default test directory is already present there).

The alternative approach I have been using involves employing a bash script with the following code snippet:

#!/bin/bash

# $0 = command itself
# $1 = extension-directory(relative path)
# $2 = process-id of code to kill

[ -z "$1" ] && { echo "path argument not provided"; exit 1; }
[ -z "$2" ] || { xkill -id $2; }

cd $1
vsce package
file=$(find . -name "*.vsix")
code --install-extension $file
code &
echo $!

All that remains is opening a folder in the launched code instance and executing required commands. Establishing a suitable testing environment appears to offer more advantages in the long run, particularly if it is anticipated that numerous tests will need to be conducted.

Answer 3

Answer №2

The solution provided did not suit my needs in the year 2023. I encountered difficulties trying to open a workspace in VS Code by modifying the launch.json.

Instead, I found that using @vscode/test-electron runTests with a launchArgs argument proved to be effective. By specifying a directory as the first argument, it would open as a workspace.

await runTests({extensionDevelopmentPath, 
                extensionTestsPath, 
                launchArgs:[path_to_directory] 
               });

During testing, I utilized a temporary directory created using tmp-promise. Here is an excerpt from my `runTests.ts`:

import * as path from "path";
import { runTests } from "@vscode/test-electron";
import { file, dir } from 'tmp-promise';

async function main() {
  try {
    const extensionDevelopmentPath = path.resolve(__dirname, "../../");
    const extensionTestsPath = path.resolve(__dirname, "./suite/index");

    const {path:tempdir, cleanup} = await dir({unsafeCleanup:true});
    await runTests({extensionDevelopmentPath, 
                    extensionTestsPath, 
                    launchArgs:[tempdir] });
    cleanup();
  } catch (err) {
    console.error("Failed to run tests");
    process.exit(1);
  }
}

main();

For reference and further guidance, consider exploring the sample in the VS Code test repository for an updated example to work with.

Answer 4

The solution provided did not suit my needs in the year 2023. I encountered difficulties trying to open a workspace in VS Code by modifying the launch.json.

Instead, I found that using @vscode/test-electron runTests with a launchArgs argument proved to be effective. By specifying a directory as the first argument, it would open as a workspace.

await runTests({extensionDevelopmentPath, 
                extensionTestsPath, 
                launchArgs:[path_to_directory] 
               });

During testing, I utilized a temporary directory created using tmp-promise. Here is an excerpt from my `runTests.ts`:

import * as path from "path";
import { runTests } from "@vscode/test-electron";
import { file, dir } from 'tmp-promise';

async function main() {
  try {
    const extensionDevelopmentPath = path.resolve(__dirname, "../../");
    const extensionTestsPath = path.resolve(__dirname, "./suite/index");

    const {path:tempdir, cleanup} = await dir({unsafeCleanup:true});
    await runTests({extensionDevelopmentPath, 
                    extensionTestsPath, 
                    launchArgs:[tempdir] });
    cleanup();
  } catch (err) {
    console.error("Failed to run tests");
    process.exit(1);
  }
}

main();

For reference and further guidance, consider exploring the sample in the VS Code test repository for an updated example to work with.

Answer 5

Answer №3

If you want to open a workspace or folder in your VSCode instance, you can utilize VSBrowser.instance.openResources(path);

import { WebDriver, VSBrowser } from 'vscode-extension-tester';
const path = require('path');
...

suite('Unique Test suite ABC', () => {
    const custom_project_path = path.join(__dirname, "custom", "project", "folder");
    
    setup(async () => {
        driver = VSBrowser.instance.driver;
        driver.manage().timeouts().implicitlyWait(1000);
    });

    test("Access a workspace in VSCode instance", async () => {
        await VSBrowser.instance.openResources(path.resolve(custom_project_path));
    });

});

...

Answer 6

If you want to open a workspace or folder in your VSCode instance, you can utilize VSBrowser.instance.openResources(path);

import { WebDriver, VSBrowser } from 'vscode-extension-tester';
const path = require('path');
...

suite('Unique Test suite ABC', () => {
    const custom_project_path = path.join(__dirname, "custom", "project", "folder");
    
    setup(async () => {
        driver = VSBrowser.instance.driver;
        driver.manage().timeouts().implicitlyWait(1000);
    });

    test("Access a workspace in VSCode instance", async () => {
        await VSBrowser.instance.openResources(path.resolve(custom_project_path));
    });

});

...

Experimenting with a VSCode extension that requires the act of launching a folder/workspace

Answer №1

Answer №2

Answer №3

Similar questions

Build an object using a deeply nested JSON structure

Is there a way to access the final child element within a mat-accordion component using Material-UI and Angular 8?

Steps for utilizing Bazel to compile TypeScript

Encountering errors while working with React props in typing

Defining a structure for an entity in which its attributes distinguish between different data types and an array combination

The CastError occurred because the attempt to add a string value to an array failed when converting it to a string

Show a nested JSON object when the specific key is not recognized

Is there a way to implement a pipe function in TypeScript?

Stop webpack from stripping out the crypto module in the nodejs API

What is the best way to eliminate the content of an element using javascript/typescript?

Unable to locate the reference for 'bootstrap'

Error TS2345: The function with arguments of type '(req: any, res: any, ctx: any) => any' cannot be assigned to the parameter of type 'HttpResponseResolver<PathParams<string>'

What causes interface to generate TS2345 error, while type does not?

Find the TypeScript data type of an array that may be empty

Angular's observables were unable to be subscribed to in either the constructor or ngOnInit() functions

Vue composable yields a string value

Can you explain the purpose of FunctionConstructor in typeScript?

Angular 8 combined with Mmenu light JS

Tips for transforming an Observable stream into an Observable Array

Accessing the media player of your system while developing a VSCode extension using a nodejs backend: A comprehensive guide