generator-code 1.8.0 → 1.8.2

package/generators/app/dependencyVersions/package.json

@@ -4,23 +4,25 @@
     "version": "0.0.0",
     "private": true,
     "dependencies": {
-        "@types/mocha": "^10.0.3",
+        "@types/mocha": "^10.0.6",
         "@types/node": "18.x",
-        "@typescript-eslint/eslint-plugin": "^6.9.0",
-        "@typescript-eslint/parser": "^6.9.0",
-        "eslint": "^8.52.0",
+        "@types/assert": "^1.5.10",
+        "@typescript-eslint/eslint-plugin": "^6.15.0",
+        "@typescript-eslint/parser": "^6.15.0",
+        "eslint": "^8.56.0",
         "glob": "^10.3.10",
         "mocha": "^10.2.0",
-        "typescript": "^5.2.2",
-        "@vscode/test-electron": "^2.3.6",
-        "@vscode/test-web": "^0.0.48",
-        "@types/webpack-env": "^1.18.3",
-        "@types/vscode-notebook-renderer": "^1.72.2",
+        "typescript": "^5.3.3",
+        "@vscode/test-cli": "^0.0.4",
+        "@vscode/test-electron": "^2.3.8",
+        "@vscode/test-web": "^0.0.50",
+        "@types/webpack-env": "^1.18.4",
+        "@types/vscode-notebook-renderer": "^1.72.3",
         "concurrently": "^8.2.2",
         "css-loader": "^6.8.1",
-        "fork-ts-checker-webpack-plugin": "^9.0.0",
+        "fork-ts-checker-webpack-plugin": "^9.0.2",
         "style-loader": "^3.3.3",
-        "ts-loader": "^9.5.0",
+        "ts-loader": "^9.5.1",
         "vscode-dts": "^0.3.3",
         "vscode-notebook-error-overlay": "^1.0.1",
         "webpack": "^5.89.0",

package/generators/app/generate-command-js.js

@@ -52,6 +52,7 @@ export default {
 
         generator.fs.copyTpl(generator.templatePath('extension.js'), generator.destinationPath('extension.js'), extensionConfig);
         generator.fs.copyTpl(generator.templatePath('package.json'), generator.destinationPath('package.json'), extensionConfig);
+        generator.fs.copy(generator.templatePath('.vscode-test.mjs'), generator.destinationPath('.vscode-test.mjs'));
         generator.fs.copyTpl(generator.templatePath('.eslintrc.json'), generator.destinationPath('.eslintrc.json'), extensionConfig);
 
         if (extensionConfig.pkgManager === 'yarn') {

package/generators/app/generate-command-ts.js

@@ -52,6 +52,7 @@ export default {
         generator.fs.copyTpl(generator.templatePath('CHANGELOG.md'), generator.destinationPath('CHANGELOG.md'), extensionConfig);
         generator.fs.copyTpl(generator.templatePath('src/extension.ts'), generator.destinationPath('src/extension.ts'), extensionConfig);
         generator.fs.copy(generator.templatePath('src/test'), generator.destinationPath('src/test'));
+        generator.fs.copy(generator.templatePath('.vscode-test.mjs'), generator.destinationPath('.vscode-test.mjs'));
         generator.fs.copy(generator.templatePath('.eslintrc.json'), generator.destinationPath('.eslintrc.json'));
 
         if (extensionConfig.pkgManager === 'yarn') {

package/generators/app/generate-notebook-renderer.js

@@ -35,6 +35,7 @@ export default {
         generator.fs.copy(generator.templatePath('.vscodeignore'), generator.destinationPath('.vscodeignore'));
         generator.fs.copy(generator.templatePath('webpack.config.js'), generator.destinationPath('webpack.config.js'));
         generator.fs.copy(generator.templatePath('.eslintrc.json'), generator.destinationPath('.eslintrc.json'));
+        generator.fs.copy(generator.templatePath('.vscode-test.mjs'), generator.destinationPath('.vscode-test.mjs'));
 
         generator.fs.copyTpl(generator.templatePath('package.json'), generator.destinationPath('package.json'), extensionConfig);
         generator.fs.copyTpl(generator.templatePath('README.md'), generator.destinationPath('README.md'), extensionConfig);

package/generators/app/templates/ext-command-js/.vscode-test.mjs

@@ -0,0 +1,5 @@
+import { defineConfig } from '@vscode/test-cli';
+
+export default defineConfig({
+	files: 'test/**/*.test.js',
+});

package/generators/app/templates/ext-command-js/.vscodeignore

@@ -7,3 +7,4 @@ vsc-extension-quickstart.md
 **/jsconfig.json
 **/*.map
 **/.eslintrc.json
+**/.vscode-test.*

package/generators/app/templates/ext-command-js/package.json

@@ -20,16 +20,15 @@
   "scripts": {
     "lint": "eslint .",
     "pretest": "<%= pkgManager %> run lint",
-    "test": "node ./test/runTest.js"
+    "test": "vscode-test"
   },
   "devDependencies": {
     <%- dep("@types/vscode") %>,
     <%- dep("@types/mocha") %>,
     <%- dep("@types/node") %>,
     <%- dep("eslint") %>,
-    <%- dep("glob") %>,
-    <%- dep("mocha") %>,
     <%- dep("typescript") %>,
+    <%- dep("@vscode/test-cli") %>,
     <%- dep("@vscode/test-electron") %>
   }
 }

package/generators/app/templates/ext-command-js/vsc-extension-quickstart.md

@@ -27,11 +27,11 @@
 
 ## Run tests
 
-* Open the debug viewlet (`Ctrl+Shift+D` or `Cmd+Shift+D` on Mac) and from the launch configuration dropdown pick `Extension Tests`.
-* Press `F5` to run the tests in a new window with your extension loaded.
-* See the output of the test result in the debug console.
-* Make changes to `src/test/suite/extension.test.js` or create new test files inside the `test/suite` folder.
-  * The provided test runner will only consider files matching the name pattern `**.test.ts`.
+* Install the [Extension Test Runner](https://marketplace.visualstudio.com/items?itemName=ms-vscode.extension-test-runner)
+* Open the Testing view from the activity bar and click the Run Test" button, or use the hotkey `Ctrl/Cmd + ; A`
+* See the output of the test result in the Test Results view.
+* Make changes to `test/extension.test.js` or create new test files inside the `test` folder.
+  * The provided test runner will only consider files matching the name pattern `**.test.js`.
   * You can create folders inside the `test` folder to structure your tests any way you want.
 
 ## Go further

package/generators/app/templates/ext-command-js/vscode/extensions.json

@@ -2,6 +2,7 @@
 	// See https://go.microsoft.com/fwlink/?LinkId=733558
 	// for the documentation about the extensions.json format
 	"recommendations": [
-		"dbaeumer.vscode-eslint"
+		"dbaeumer.vscode-eslint",
+        "ms-vscode.extension-test-runner"
 	]
-}
+}

package/generators/app/templates/ext-command-js/vscode/launch.json

@@ -12,15 +12,6 @@
 			"args": [
 				"--extensionDevelopmentPath=${workspaceFolder}"
 			]
-		},
-		{
-			"name": "Extension Tests",
-			"type": "extensionHost",
-			"request": "launch",
-			"args": [
-				"--extensionDevelopmentPath=${workspaceFolder}",
-				"--extensionTestsPath=${workspaceFolder}/test/suite/index"
-			]
 		}
 	]
 }

package/generators/app/templates/ext-command-ts/.vscode-test.mjs

@@ -0,0 +1,5 @@
+import { defineConfig } from '@vscode/test-cli';
+
+export default defineConfig({
+	files: 'out/test/**/*.test.js',
+});

package/generators/app/templates/ext-command-ts/.vscodeignore

@@ -8,3 +8,4 @@ vsc-extension-quickstart.md
 **/.eslintrc.json
 **/*.map
 **/*.ts
+**/.vscode-test.*

package/generators/app/templates/ext-command-ts/package.json

@@ -26,7 +26,7 @@
     "watch": "tsc -watch -p ./",
     "pretest": "<%= pkgManager %> run compile && <%= pkgManager %> run lint",
     "lint": "eslint src --ext ts",
-    "test": "node ./out/test/runTest.js"<% if (insiders) { %>,
+    "test": "vscode-test"<% if (insiders) { %>,
     "update-proposed-api": "vscode-dts dev"<% } %>
   },
   "devDependencies": {
@@ -36,9 +36,8 @@
     <%- dep("@typescript-eslint/eslint-plugin") %>,
     <%- dep("@typescript-eslint/parser") %>,
     <%- dep("eslint") %>,
-    <%- dep("glob") %>,
-    <%- dep("mocha") %>,
     <%- dep("typescript") %>,
+    <%- dep("@vscode/test-cli") %>,
     <%- dep("@vscode/test-electron") %><% if (insiders) { %>,
     <%- dep("vscode-dts") %><% } %>
   }

package/generators/app/templates/ext-command-ts/vsc-extension-quickstart.md

@@ -27,10 +27,11 @@
 
 ## Run tests
 
-* Open the debug viewlet (`Ctrl+Shift+D` or `Cmd+Shift+D` on Mac) and from the launch configuration dropdown pick `Extension Tests`.
-* Press `F5` to run the tests in a new window with your extension loaded.
-* See the output of the test result in the debug console.
-* Make changes to `src/test/suite/extension.test.ts` or create new test files inside the `test/suite` folder.
+* Install the [Extension Test Runner](https://marketplace.visualstudio.com/items?itemName=ms-vscode.extension-test-runner)
+* Run the "watch" task via the **Tasks: Run Task** command. Make sure this is running, or tests might not be discovered.
+* Open the Testing view from the activity bar and click the Run Test" button, or use the hotkey `Ctrl/Cmd + ; A`
+* See the output of the test result in the Test Results view.
+* Make changes to `src/test/extension.test.ts` or create new test files inside the `test` folder.
   * The provided test runner will only consider files matching the name pattern `**.test.ts`.
   * You can create folders inside the `test` folder to structure your tests any way you want.
 

package/generators/app/templates/ext-command-ts/vscode/extensions.json

@@ -2,6 +2,7 @@
 	// See http://go.microsoft.com/fwlink/?LinkId=827846
 	// for the documentation about the extensions.json format
 	"recommendations": [
-		"dbaeumer.vscode-eslint"
+		"dbaeumer.vscode-eslint",
+        "ms-vscode.extension-test-runner"
 	]
 }

package/generators/app/templates/ext-command-ts/vscode/launch.json

@@ -16,19 +16,6 @@
 				"${workspaceFolder}/out/**/*.js"
 			],
 			"preLaunchTask": "${defaultBuildTask}"
-		},
-		{
-			"name": "Extension Tests",
-			"type": "extensionHost",
-			"request": "launch",
-			"args": [
-				"--extensionDevelopmentPath=${workspaceFolder}",
-				"--extensionTestsPath=${workspaceFolder}/out/test/suite/index"
-			],
-			"outFiles": [
-				"${workspaceFolder}/out/test/**/*.js"
-			],
-			"preLaunchTask": "${defaultBuildTask}"
 		}
 	]
 }

package/generators/app/templates/ext-command-ts/vscode-webpack/.vscodeignore

@@ -11,3 +11,4 @@ vsc-extension-quickstart.md
 **/.eslintrc.json
 **/*.map
 **/*.ts
+**/.vscode-test.*

package/generators/app/templates/ext-command-ts/vscode-webpack/package.json

@@ -29,7 +29,7 @@
     "watch-tests": "tsc -p . -w --outDir out",
     "pretest": "<%= pkgManager %> run compile-tests && <%= pkgManager %> run compile && <%= pkgManager %> run lint",
     "lint": "eslint src --ext ts",
-    "test": "node ./out/test/runTest.js"<% if (insiders) { %>,
+    "test": "vscode-test"<% if (insiders) { %>,
     "update-proposed-api": "vscode-dts dev"<% } %>
   },
   "devDependencies": {
@@ -39,12 +39,11 @@
     <%- dep("@typescript-eslint/eslint-plugin") %>,
     <%- dep("@typescript-eslint/parser") %>,
     <%- dep("eslint") %>,
-    <%- dep("glob") %>,
-    <%- dep("mocha") %>,
     <%- dep("typescript") %>,
     <%- dep("ts-loader") %>,
     <%- dep("webpack") %>,
     <%- dep("webpack-cli") %>,
+    <%- dep("@vscode/test-cli") %>,
     <%- dep("@vscode/test-electron") %><% if (insiders) { %>,
     <%- dep("vscode-dts") %><% } %>
   }

package/generators/app/templates/ext-command-ts/vscode-webpack/vsc-extension-quickstart.md

@@ -11,7 +11,7 @@
 
 ## Setup
 
-* install the recommended extensions (amodio.tsl-problem-matcher and dbaeumer.vscode-eslint)
+* install the recommended extensions (amodio.tsl-problem-matcher, ms-vscode.extension-test-runner, and dbaeumer.vscode-eslint)
 
 
 ## Get up and running straight away
@@ -33,10 +33,11 @@
 
 ## Run tests
 
-* Open the debug viewlet (`Ctrl+Shift+D` or `Cmd+Shift+D` on Mac) and from the launch configuration dropdown pick `Extension Tests`.
-* Press `F5` to run the tests in a new window with your extension loaded.
-* See the output of the test result in the debug console.
-* Make changes to `src/test/suite/extension.test.ts` or create new test files inside the `test/suite` folder.
+* Install the [Extension Test Runner](https://marketplace.visualstudio.com/items?itemName=ms-vscode.extension-test-runner)
+* Run the "watch" task via the **Tasks: Run Task** command. Make sure this is running, or tests might not be discovered.
+* Open the Testing view from the activity bar and click the Run Test" button, or use the hotkey `Ctrl/Cmd + ; A`
+* See the output of the test result in the Test Results view.
+* Make changes to `src/test/extension.test.ts` or create new test files inside the `test` folder.
   * The provided test runner will only consider files matching the name pattern `**.test.ts`.
   * You can create folders inside the `test` folder to structure your tests any way you want.
 

package/generators/app/templates/ext-command-ts/vscode-webpack/vscode/extensions.json

@@ -1,5 +1,5 @@
 {
   // See http://go.microsoft.com/fwlink/?LinkId=827846
   // for the documentation about the extensions.json format
-  "recommendations": ["dbaeumer.vscode-eslint", "amodio.tsl-problem-matcher"]
+  "recommendations": ["dbaeumer.vscode-eslint", "amodio.tsl-problem-matcher", "ms-vscode.extension-test-runner"]
 }

package/generators/app/templates/ext-command-ts/vscode-webpack/vscode/launch.json

@@ -16,20 +16,6 @@
 				"${workspaceFolder}/dist/**/*.js"
 			],
 			"preLaunchTask": "${defaultBuildTask}"
-		},
-		{
-			"name": "Extension Tests",
-			"type": "extensionHost",
-			"request": "launch",
-			"args": [
-				"--extensionDevelopmentPath=${workspaceFolder}",
-				"--extensionTestsPath=${workspaceFolder}/out/test/suite/index"
-			],
-			"outFiles": [
-				"${workspaceFolder}/out/**/*.js",
-				"${workspaceFolder}/dist/**/*.js"
-			],
-			"preLaunchTask": "tasks: watch-tests"
 		}
 	]
 }

package/generators/app/templates/ext-command-web/.vscodeignore

@@ -11,3 +11,4 @@ webpack.config.js
 **/.eslintrc.json
 **/*.map
 **/*.ts
+**/.vscode-test.*

package/generators/app/templates/ext-command-web/package.json

@@ -32,6 +32,7 @@
   "devDependencies": {
     <%- dep("@types/vscode") %>,
     <%- dep("@types/mocha") %>,
+    <%- dep("@types/assert") %>,
     <%- dep("eslint") %>,
     <%- dep("@typescript-eslint/eslint-plugin") %>,
     <%- dep("@typescript-eslint/parser") %>,

package/generators/app/templates/ext-command-web/vsc-extension-quickstart.md

@@ -9,7 +9,7 @@
 
 ## Setup
 
-* install the recommended extensions (amodio.tsl-problem-matcher and dbaeumer.vscode-eslint)
+* install the recommended extensions (amodio.tsl-problem-matcher, ms-vscode.extension-test-runner, and dbaeumer.vscode-eslint)
 
 ## Get up and running the Web Extension
 

package/generators/app/templates/ext-notebook-renderer/.vscode-test.mjs

@@ -0,0 +1,5 @@
+import { defineConfig } from '@vscode/test-cli';
+
+export default defineConfig({
+	files: 'out/test/**/*.test.js',
+});

package/generators/app/templates/ext-notebook-renderer/.vscodeignore

@@ -10,3 +10,4 @@ vsc-extension-quickstart.md
 **/*.map
 **/*.ts
 **/*.tsbuildinfo
+**/.vscode-test.*

package/generators/app/templates/ext-notebook-renderer/package.json

@@ -31,7 +31,7 @@
     "lint": "eslint src --ext ts",
     "watch": "webpack --mode development --watch",
     "pretest": "webpack --mode development && <%= pkgManager %> run lint",
-    "test": "node ./out/test/runTest.js"
+    "test": "vscode-test"
   },
   "devDependencies": {
     <%- dep("@types/mocha") %>,
@@ -50,6 +50,7 @@
     <%- dep("ts-loader") %>,
     <%- dep("typescript") %>,
     <%- dep("vscode-notebook-error-overlay") %>,
+    <%- dep("@vscode/test-cli") %>,
     <%- dep("@vscode/test-electron") %>,
     <%- dep("util") %>,
     <%- dep("webpack") %>,

package/generators/app/templates/ext-notebook-renderer/vscode/extensions.json

@@ -1,5 +1,5 @@
 {
   // See http://go.microsoft.com/fwlink/?LinkId=827846
   // for the documentation about the extensions.json format
-  "recommendations": ["dbaeumer.vscode-eslint", "amodio.tsl-problem-matcher"]
+  "recommendations": ["dbaeumer.vscode-eslint", "amodio.tsl-problem-matcher", "ms-vscode.extension-test-runner"]
 }

package/generators/app/templates/ext-notebook-renderer/vscode/launch.json

@@ -32,19 +32,6 @@
       ],
       "debugWebviews": true,
       "preLaunchTask": "npm: watch"
-    },
-    {
-      "name": "Extension Tests",
-      "type": "extensionHost",
-      "request": "launch",
-      "args": [
-        "--extensionDevelopmentPath=${workspaceFolder}",
-        "--extensionTestsPath=${workspaceFolder}/out/test/suite/index"
-      ],
-      "outFiles": [
-        "${workspaceFolder}/out/test/**/*.js"
-      ],
-      "preLaunchTask": "${defaultBuildTask}"
     }
   ]
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "generator-code",
-  "version": "1.8.0",
+  "version": "1.8.2",
   "description": "Yeoman generator for Visual Studio Code extensions.",
   "keywords": [
     "yeoman-generator",
@@ -43,7 +43,7 @@
     "yosay": "^3.0.0"
   },
   "devDependencies": {
-    "@types/mocha": "^10.0.3",
+    "@types/mocha": "^10.0.6",
     "@types/node": "^16.x",
     "mocha": "^10.2.0",
     "yeoman-environment": "^3.19.3",

package/generators/app/templates/ext-command-js/test/runTest.js

@@ -1,23 +0,0 @@
-const path = require('path');
-
-const { runTests } = require('@vscode/test-electron');
-
-async function main() {
-	try {
-		// The folder containing the Extension Manifest package.json
-		// Passed to `--extensionDevelopmentPath`
-		const extensionDevelopmentPath = path.resolve(__dirname, '../');
-
-		// The path to the extension test script
-		// Passed to --extensionTestsPath
-		const extensionTestsPath = path.resolve(__dirname, './suite/index');
-
-		// Download VS Code, unzip it and run the integration test
-		await runTests({ extensionDevelopmentPath, extensionTestsPath });
-	} catch (err) {
-		console.error('Failed to run tests', err);
-		process.exit(1);
-	}
-}
-
-main();

package/generators/app/templates/ext-command-js/test/suite/index.js

@@ -1,36 +0,0 @@
-const path = require('path');
-const Mocha = require('mocha');
-const glob = require('glob');
-
-async function run() {
-	// Create the mocha test
-	const mocha = new Mocha({
-		ui: 'tdd',
-		color: true
-	});
-
-	const testsRoot = path.resolve(__dirname, '..');
-	const files = await glob('**/**.test.js', { cwd: testsRoot });
-
-	// Add files to the test suite
-	files.forEach(f => mocha.addFile(path.resolve(testsRoot, f)));
-
-	try {
-		return new Promise((c, e) => {
-			// Run the mocha test
-			mocha.run(failures => {
-				if (failures > 0) {
-					e(new Error(`${failures} tests failed.`));
-				} else {
-					c();
-				}
-			});
-		});
-	} catch (err) {
-		console.error(err);
-	}
-}
-
-module.exports = {
-	run
-};

package/generators/app/templates/ext-command-ts/src/test/runTest.ts

@@ -1,23 +0,0 @@
-import * as path from 'path';
-
-import { runTests } from '@vscode/test-electron';
-
-async function main() {
-	try {
-		// The folder containing the Extension Manifest package.json
-		// Passed to `--extensionDevelopmentPath`
-		const extensionDevelopmentPath = path.resolve(__dirname, '../../');
-
-		// The path to test runner
-		// Passed to --extensionTestsPath
-		const extensionTestsPath = path.resolve(__dirname, './suite/index');
-
-		// Download VS Code, unzip it and run the integration test
-		await runTests({ extensionDevelopmentPath, extensionTestsPath });
-	} catch (err) {
-		console.error('Failed to run tests', err);
-		process.exit(1);
-	}
-}
-
-main();

package/generators/app/templates/ext-command-ts/src/test/suite/index.ts

@@ -1,32 +0,0 @@
-import * as path from 'path';
-import Mocha from 'mocha';
-import { glob } from 'glob';
-
-export async function run(): Promise<void> {
-	// Create the mocha test
-	const mocha = new Mocha({
-		ui: 'tdd',
-		color: true
-	});
-
-	const testsRoot = path.resolve(__dirname, '..');
-	const files = await glob('**/**.test.js', { cwd: testsRoot });
-
-	// Add files to the test suite
-	files.forEach(f => mocha.addFile(path.resolve(testsRoot, f)));
-
-	try {
-		return new Promise<void>((c, e) => {
-			// Run the mocha test
-			mocha.run(failures => {
-				if (failures > 0) {
-					e(new Error(`${failures} tests failed.`));
-				} else {
-					c();
-				}
-			});
-		});
-	} catch (err) {
-		console.error(err);
-	}
-}

package/generators/app/templates/ext-notebook-renderer/src/test/runTest.ts

@@ -1,23 +0,0 @@
-import * as path from 'path';
-
-import { runTests } from '@vscode/test-electron';
-
-async function main() {
-  try {
-    // The folder containing the Extension Manifest package.json
-    // Passed to `--extensionDevelopmentPath`
-    const extensionDevelopmentPath = path.resolve(__dirname, '../../');
-
-    // The path to test runner
-    // Passed to --extensionTestsPath
-    const extensionTestsPath = path.resolve(__dirname, './suite/index');
-
-    // Download VS Code, unzip it and run the integration test
-    await runTests({ extensionDevelopmentPath, extensionTestsPath });
-  } catch (err) {
-    console.error('Failed to run tests', err);
-    process.exit(1);
-  }
-}
-
-main();

package/generators/app/templates/ext-notebook-renderer/src/test/suite/index.ts

@@ -1,32 +0,0 @@
-import * as path from 'path';
-import Mocha from 'mocha';
-import { glob } from 'glob';
-
-export async function run(): Promise<void> {
-	// Create the mocha test
-	const mocha = new Mocha({
-		ui: 'tdd',
-		color: true
-	});
-
-	const testsRoot = path.resolve(__dirname, '..');
-	const files = await glob('**/**.test.js', { cwd: testsRoot });
-
-	// Add files to the test suite
-	files.forEach(f => mocha.addFile(path.resolve(testsRoot, f)));
-
-	try {
-		return new Promise<void>((c, e) => {
-			// Run the mocha test
-			mocha.run(failures => {
-				if (failures > 0) {
-					e(new Error(`${failures} tests failed.`));
-				} else {
-					c();
-				}
-			});
-		});
-	} catch (err) {
-		console.error(err);
-	}
-}