Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@vscode/test-web

Package Overview
Dependencies
Maintainers
0
Versions
59
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@vscode/test-web

  • 0.0.64
  • Source
  • npm
  • Socket score

Version published
Weekly downloads
29K
increased by28.18%
Maintainers
0
Weekly downloads
 
Created
Source

@vscode/test-web

This module helps testing VS Code web extensions locally.

Test Status Badge npm Package NPM Downloads

See the web extensions guide to learn about web extensions.

The node module runs a local web server that serves VS Code in the browser including the extension under development. Additionally the extension tests are automatically run.

The node module provides a command line as well as an API.

Usage

Via command line:

Test a web extension in a browser:

vscode-test-web --browserType=chromium --extensionDevelopmentPath=$extensionLocation

Run web extension tests:

vscode-test-web --browserType=chromium --extensionDevelopmentPath=$extensionLocation --extensionTestsPath=$extensionLocation/dist/web/test/suite/index.js

Open VS Code in the Browser on a folder with test data from the local disk:

vscode-test-web --browserType=chromium --extensionDevelopmentPath=$extensionLocation $testDataLocation

VS Code for the Web will open on a virtual workspace (scheme vscode-test-web), backed by a file system provider that gets the file/folder data from the local disk. Changes to the file system are kept in memory and are not written back to disk.

Open VS Code in the Browser with external network access:

vscode-test-web --browserType=chromium --browserOption=--disable-web-security extensionDevelopmentPath=$extensionLocation

This allows the extension being tested to make network requests to external hosts.

Via API:

async function go() {
  try {
    // The folder containing the Extension Manifest package.json
    const extensionDevelopmentPath = path.resolve(__dirname, '../../../');

    // The path to module with the test runner and tests
    const extensionTestsPath = path.resolve(__dirname, './suite/index');

    // Start a web server that serves VSCode in a browser, run the tests
    await runTests({
		browserType: 'chromium',
		extensionDevelopmentPath
		extensionTestsPath
	});
  } catch (err) {
    console.error('Failed to run tests');
    process.exit(1);
  }
}

go()

CLI options:

OptionArgument Description
--browserThe browser to launch: chromium (default), firefox, webkit or none.
--browserOptionCommand line argument to use when launching the browser instance. Argument can be provided multiple times.
--extensionDevelopmentPathA path pointing to an extension under development to include.
--extensionTestsPathA path to a test module to run.
--qualityinsiders (default), or stable. Ignored when sourcesPath is provided.
--commitcommitHash The servion of the server to use. Defaults to latest build version of the given quality. Ignored when sourcesPath is provided.
--sourcesPathIf set, runs the server from VS Code sources located at the given path. Make sure the sources and extensions are compiled (npm run compile and npm run compile-web).
--headlessIf set, hides the browser. Defaults to true when an extensionTestsPath is provided, otherwise false.
--permissionPermission granted to the opened browser: e.g. clipboard-read, clipboard-write. See full list of options. Argument can be provided multiple times.
--coiIf set, enables cross origin isolation. Defaults to false.
--folder-uriURI of the workspace to open VS Code on. Ignored when folderPath is provided.
--extensionPathA path pointing to a folder containing additional extensions to include. Argument can be provided multiple times.
--extensionIdThe id of an extension include. The format is ${publisher}.${name}. Append @prerelease to use the prerelease version.
--hostThe host name the server is opened on. Defaults to localhost.
--portThe port the server is opened on. Defaults to 3000.
--open-devtoolsIf set, opens the dev tools in the browser.
--verboseIf set, prints out more information when running the server.
--printServerLogIf set, prints the server access log.
--testRunnerDataDirIf set, the temporary folder for storing the VS Code builds used for running the tests
folderPathA local folder to open VS Code on. The folder content will be available as a virtual file system and opened as workspace.

Corresponding options are available in the API.

Development

  • npm i && npm run install-extensions

  • Make necessary changes in src

  • npm run compile (or npm run watch)

  • run npm run sample to launch VS Code Browser with the sample extension bundled in this repo.

  • run npm run sample-tests to launch VS Code Browser running the extension tests of the sample extension bundled in this repo.

License

MIT

Contributing

This 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.

FAQs

Package last updated on 19 Nov 2024

Did you know?

Socket

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.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc