README.md

VS Code Test Config for Azure Visual Studio Code Extensions

Contains default VS Code test configuration for Azure extensions.

Minimal Usage

1. Add the vscode-test dev dependencies. They are optional peer dependencies of this package, which will control the version. As such, use * as the desired version.

       "devDependencies": {
   +        "@vscode/test-cli": "*",
   +        "@vscode/test-electron": "*"
       }

2. Add .vscode-test.mjs to the root of your extension package:

   // Other configurations exist
   export { azExtTestConfig as default } from '@microsoft/vscode-azext-eng/vscode-test';

3. Add the script to package.json:

       "scripts": [
   +        "test": "vscode-test"
       ]

4. (Recommended) Add a launch configuration to .vscode/launch.json:

   {
       "label": "Run Tests",
       "type": "extensionHost",
       "request": "launch",
       "testConfiguration": "${workspaceFolder}/.vscode-test.mjs",
       "env": {
           "DEBUGTELEMETRY": "1",
       },
       "outFiles": [
           "${workspaceFolder}/dist/**/*.{js,mjs,cjs}",
           "${workspaceFolder}/test/**/*.{ts,mts,cts}", // We are using TSX so out files *are* the source files
       ],
       "preLaunchTask": "${defaultBuildTask}",
   },

---

Back to Root