
Security News
Deno 2.2 Improves Dependency Management and Expands Node.js Compatibility
Deno 2.2 enhances Node.js compatibility, improves dependency management, adds OpenTelemetry support, and expands linting and task automation for developers.
@vscode/test-electron
Advanced tools

@vscode/test-electron is a package designed to help developers test their Visual Studio Code extensions in an Electron environment. It provides tools to run and debug extensions, ensuring they work correctly within the VS Code editor.
Running Extension Tests
This feature allows developers to run tests for their VS Code extensions. The code sample demonstrates how to set up and execute tests using the `runTests` function, specifying paths to the extension and the test suite.
const { runTests } = require('@vscode/test-electron');
async function main() {
try {
const extensionDevelopmentPath = path.resolve(__dirname, '../my-extension');
const extensionTestsPath = path.resolve(__dirname, './suite/index');
await runTests({
extensionDevelopmentPath,
extensionTestsPath
});
} catch (err) {
console.error('Failed to run tests');
process.exit(1);
}
}
main();
Debugging Extensions
This feature provides the ability to debug extensions by downloading a specific version of VS Code and running tests with debugging options. The code sample shows how to download VS Code, resolve the CLI path, and run tests with additional launch arguments for debugging.
const { downloadAndUnzipVSCode, resolveCliPathFromVSCodeExecutablePath, runTests } = require('@vscode/test-electron');
async function main() {
const vscodeExecutablePath = await downloadAndUnzipVSCode('stable');
const cliPath = resolveCliPathFromVSCodeExecutablePath(vscodeExecutablePath);
// Run tests with additional debugging options
await runTests({
vscodeExecutablePath,
extensionDevelopmentPath: path.resolve(__dirname, '../my-extension'),
extensionTestsPath: path.resolve(__dirname, './suite/index'),
launchArgs: ['--disable-extensions']
});
}
main();
vscode-test is another package for testing VS Code extensions. It offers similar functionalities to @vscode/test-electron, such as running and debugging extension tests. However, @vscode/test-electron is more focused on Electron environments, providing more specific tools for testing within the Electron-based VS Code.
vscode-extension-tester is a framework for testing VS Code extensions using Selenium WebDriver. It provides a different approach compared to @vscode/test-electron by focusing on UI testing and automation, whereas @vscode/test-electron is more about running and debugging tests in an Electron environment.
This module helps you test VS Code extensions. Note that new extensions may want to use the VS Code Test CLI, which leverages this module, for a richer editing and execution experience.
Supported:
See ./sample for a runnable sample, with Azure DevOps Pipelines and Github ACtions configuration.
import { runTests, runVSCodeCommand, downloadAndUnzipVSCode } from '@vscode/test-electron';
async function go() {
try {
const extensionDevelopmentPath = path.resolve(__dirname, '../../../');
const extensionTestsPath = path.resolve(__dirname, './suite');
/**
* Basic usage
*/
await runTests({
extensionDevelopmentPath,
extensionTestsPath,
});
const extensionTestsPath2 = path.resolve(__dirname, './suite2');
const testWorkspace = path.resolve(__dirname, '../../../test-fixtures/fixture1');
/**
* Running another test suite on a specific workspace
*/
await runTests({
extensionDevelopmentPath,
extensionTestsPath: extensionTestsPath2,
launchArgs: [testWorkspace],
});
/**
* Use 1.36.1 release for testing
*/
await runTests({
version: '1.36.1',
extensionDevelopmentPath,
extensionTestsPath,
launchArgs: [testWorkspace],
});
/**
* Use Insiders release for testing
*/
await runTests({
version: 'insiders',
extensionDevelopmentPath,
extensionTestsPath,
launchArgs: [testWorkspace],
});
/**
* Noop, since 1.36.1 already downloaded to .vscode-test/vscode-1.36.1
*/
await downloadAndUnzipVSCode('1.36.1');
/**
* Manually download VS Code 1.35.0 release for testing.
*/
const vscodeExecutablePath = await downloadAndUnzipVSCode('1.35.0');
await runTests({
vscodeExecutablePath,
extensionDevelopmentPath,
extensionTestsPath,
launchArgs: [testWorkspace],
});
/**
* Install Python extension
*/
await runVSCodeCommand(['--install-extension', 'ms-python.python'], { version: '1.35.0' });
/**
* - Add additional launch flags for VS Code
* - Pass custom environment variables to test runner
*/
await runTests({
vscodeExecutablePath,
extensionDevelopmentPath,
extensionTestsPath,
launchArgs: [
testWorkspace,
// This disables all extensions except the one being tested
'--disable-extensions',
],
// Custom environment variables for extension test script
extensionTestsEnv: { foo: 'bar' },
});
/**
* Use win64 instead of win32 for testing Windows
*/
if (process.platform === 'win32') {
await runTests({
extensionDevelopmentPath,
extensionTestsPath,
version: '1.40.0',
platform: 'win32-x64-archive',
});
}
} catch (err) {
console.error('Failed to run tests');
process.exit(1);
}
}
go();
yarn install
lib
yarn compile
(or yarn watch
)sample
, run yarn install
, yarn compile
and yarn test
to make sure integration test can run successfullyThis project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.
When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.
2.4.1 | 2024-07-05
TestRunFailedError
on failure instead of a string.FAQs

The npm package @vscode/test-electron receives a total of 155,164 weekly downloads. As such, @vscode/test-electron popularity was classified as popular.
We found that @vscode/test-electron demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 7 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Deno 2.2 enhances Node.js compatibility, improves dependency management, adds OpenTelemetry support, and expands linting and task automation for developers.
Security News
React's CRA deprecation announcement sparked community criticism over framework recommendations, leading to quick updates acknowledging build tools like Vite as valid alternatives.
Security News
Ransomware payment rates hit an all-time low in 2024 as law enforcement crackdowns, stronger defenses, and shifting policies make attacks riskier and less profitable.