generator-code 1.8.6 → 1.10.0

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

@@ -3,9 +3,11 @@
 src/**
 out/**
 node_modules/**
+dist/test/**
 .gitignore
 vsc-extension-quickstart.md
 webpack.config.js
+esbuild.js
 .yarnrc
 **/tsconfig.json
 **/.eslintrc.json

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

@@ -0,0 +1,51 @@
+{
+  "name": <%- JSON.stringify(name) %>,
+  "displayName": <%- JSON.stringify(displayName) %>,
+  "description": <%- JSON.stringify(description) %>,
+  "version": "0.0.1",
+  "engines": {
+    "vscode": <%- JSON.stringify(vsCodeEngine) %>
+  },
+  "categories": [
+    "Other"
+  ],
+  "activationEvents": [],
+  "browser": "./dist/web/extension.js",
+  "contributes": {
+    "commands": [
+      {
+        "command": <%- JSON.stringify(`${name}.helloWorld`) %>,
+        "title": "Hello World"
+      }
+    ]
+  },
+  "scripts": {
+    "test": "vscode-test-web --browserType=chromium --extensionDevelopmentPath=. --extensionTestsPath=dist/web/test/suite/extensionTests.js",
+    "pretest": "<%= pkgManager %> run compile-web",
+    "vscode:prepublish": "<%= pkgManager %> run package-web",
+    "compile-web": "<%= pkgManager %> run check-types && <%= pkgManager %> run lint && node esbuild.js",
+    "watch-web": "npm-run-all -p watch-web:*",
+    "watch-web:esbuild": "node esbuild.js --watch",
+    "watch-web:tsc": "tsc --noEmit --watch --project tsconfig.json",
+    "package-web": "<%= pkgManager %> run check-types && <%= pkgManager %> run lint && node esbuild.js --production",
+    "check-types": "tsc --noEmit",
+    "lint": "eslint src --ext ts",
+    "run-in-browser": "vscode-test-web --browserType=chromium --extensionDevelopmentPath=. ."
+  },
+  "devDependencies": {
+    <%- dep("@types/vscode") %>,
+    <%- dep("@types/mocha") %>,
+    <%- dep("@types/assert") %>,
+    <%- dep("eslint") %>,
+    <%- dep("@typescript-eslint/eslint-plugin") %>,
+    <%- dep("@typescript-eslint/parser") %>,
+    <%- dep("mocha") %>,
+    <%- dep("typescript") %>,
+    <%- dep("@vscode/test-web") %>,
+    <%- dep("esbuild") %>,
+    <%- dep("glob") %>,
+    <%- dep("npm-run-all") %>,
+    <%- dep("@esbuild-plugins/node-globals-polyfill") %>,
+    <%- dep("assert") %>
+  }
+}

package/generators/app/templates/ext-command-web/esbuild.js

@@ -0,0 +1,100 @@
+const esbuild = require('esbuild');
+const glob = require('glob');
+const path = require('path');
+const polyfill = require('@esbuild-plugins/node-globals-polyfill');
+
+const production = process.argv.includes('--production');
+const watch = process.argv.includes('--watch');
+
+/**
+ * This plugin hooks into the build process to print errors in a format that the problem matcher in
+ * Visual Studio Code can understand.
+ * @type {import('esbuild').Plugin}
+ */
+const esbuildProblemMatcherPlugin = {
+	name: 'esbuild-problem-matcher',
+
+	setup(build) {
+		build.onStart(() => {
+			console.log('[watch] build started');
+		});
+		build.onEnd((result) => {
+			result.errors.forEach(({ text, location }) => {
+				console.error(`✘ [ERROR] ${text}`);
+				console.error(`    ${location.file}:${location.line}:${location.column}:`);
+			});
+			console.log('[watch] build finished');
+		});
+	},
+};
+
+
+/**
+ * For web extension, all tests, including the test runner, need to be bundled into
+ * a single module that has a exported `run` function .
+ * This plugin bundles implements a virtual file extensionTests.ts that bundles all these together.
+ * @type {import('esbuild').Plugin}
+ */
+const testBundlePlugin = {
+	name: 'testBundlePlugin',
+	setup(build) {
+		build.onResolve({ filter: /[\/\\]extensionTests\.ts$/ }, args => {
+			if (args.kind === 'entry-point') {
+				return { path: path.resolve(args.path) };
+			}
+		});
+		build.onLoad({ filter: /[\/\\]extensionTests\.ts$/ }, async args => {
+			const testsRoot = path.join(__dirname, 'src/web/test/suite');
+			const files = await glob.glob('*.test.{ts,tsx}', { cwd: testsRoot, posix: true });
+			return {
+				contents:
+					`export { run } from './mochaTestRunner.ts';` +
+					files.map(f => `import('./${f}');`).join(''),
+				watchDirs: files.map(f => path.dirname(path.resolve(testsRoot, f))),
+				watchFiles: files.map(f => path.resolve(testsRoot, f))
+			};
+		});
+	}
+};
+
+async function main() {
+	const ctx = await esbuild.context({
+		entryPoints: [
+			'src/web/extension.ts',
+			'src/web/test/suite/extensionTests.ts'
+		],
+		bundle: true,
+		format: 'cjs',
+		minify: production,
+		sourcemap: !production,
+		sourcesContent: false,
+		platform: 'browser',
+		outdir: 'dist/web',
+		external: ['vscode'],
+		logLevel: 'silent',
+		// Node.js global to browser globalThis
+		define: {
+			global: 'globalThis',
+		},
+
+		plugins: [
+			polyfill.NodeGlobalsPolyfillPlugin({
+				process: true,
+				buffer: true,
+			}),
+			testBundlePlugin,
+			esbuildProblemMatcherPlugin, /* add to the end of plugins array */
+		],
+	});
+	if (watch) {
+		await ctx.watch();
+	} else {
+		await ctx.rebuild();
+		await ctx.dispose();
+	}
+}
+
+main().catch(e => {
+	console.error(e);
+	process.exit(1);
+});

package/generators/app/templates/ext-command-web/src/web/test/suite/esbuild-mochaTestRunner.ts

@@ -0,0 +1,26 @@
+// Imports mocha for the browser, defining the `mocha` global.
+import 'mocha/mocha';
+
+mocha.setup({
+	ui: 'tdd',
+	reporter: undefined
+});
+
+export function run(): Promise<void> {
+
+	return new Promise((c, e) => {
+		try {
+			// Run the mocha test
+			mocha.run(failures => {
+				if (failures > 0) {
+					e(new Error(`${failures} tests failed.`));
+				} else {
+					c();
+				}
+			});
+		} catch (err) {
+			console.error(err);
+			e(err);
+		}
+	});
+}

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

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

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

@@ -0,0 +1,38 @@
+// A launch configuration that compiles the extension and then opens it inside a new window
+// Use IntelliSense to learn about possible attributes.
+// Hover to view descriptions of existing attributes.
+// For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+{
+	"version": "0.2.0",
+	"configurations": [
+		{
+			"name": "Run Web Extension ",
+			"type": "extensionHost",
+			"debugWebWorkerHost": true,
+			"request": "launch",
+			"args": [
+				"--extensionDevelopmentPath=${workspaceFolder}",
+				"--extensionDevelopmentKind=web"
+			],
+			"outFiles": [
+				"${workspaceFolder}/dist/web/**/*.js"
+			],
+			"preLaunchTask": "${defaultBuildTask}"
+		},
+		{
+			"name": "Extension Tests",
+			"type": "extensionHost",
+			"debugWebWorkerHost": true,
+			"request": "launch",
+			"args": [
+				"--extensionDevelopmentPath=${workspaceFolder}",
+				"--extensionDevelopmentKind=web",
+				"--extensionTestsPath=${workspaceFolder}/dist/web/test/suite/extensionTests"
+			],
+			"outFiles": [
+				"${workspaceFolder}/dist/web/**/*.js"
+			],
+			"preLaunchTask": "${defaultBuildTask}"
+		}
+	]
+}

package/generators/app/templates/ext-command-web/vscode-esbuild/tasks.json

@@ -0,0 +1,57 @@
+// See https://go.microsoft.com/fwlink/?LinkId=733558
+// for the documentation about the tasks.json format
+{
+	"version": "2.0.0",
+	"tasks": [
+		{
+			"label": "watch-web",
+			"dependsOn": [
+				"npm: watch-web:tsc",
+				"npm: watch-web:esbuild"
+			],
+			"presentation": {
+				"reveal": "never"
+			},
+			"group": {
+				"kind": "build",
+				"isDefault": true
+			},
+			"runOptions": {
+				"runOn": "folderOpen"
+			}
+		},
+		{
+			"type": "npm",
+			"script": "watch-web:esbuild",
+			"group": "build",
+			"problemMatcher": "$esbuild-watch",
+			"isBackground": true,
+			"label": "npm: watch-web:esbuild",
+			"presentation": {
+				"group": "watch",
+				"reveal": "never"
+			}
+		},
+		{
+			"type": "npm",
+			"script": "watch-web:tsc",
+			"group": "build",
+			"problemMatcher": "$tsc-watch",
+			"isBackground": true,
+			"label": "npm: watch-web:tsc",
+			"presentation": {
+				"group": "watch",
+				"reveal": "never"
+			}
+		},
+		{
+			"label": "compile",
+			"type": "npm",
+			"script": "compile-web",
+			"problemMatcher": [
+				"$tsc",
+				"$esbuild"
+			]
+		}
+	]
+}

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

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

package/generators/app/templates/ext-command-web/{vscode → vscode-webpack}/launch.json

@@ -7,7 +7,7 @@
 	"configurations": [
 		{
 			"name": "Run Web Extension ",
-			"type": "pwa-extensionHost",
+			"type": "extensionHost",
 			"debugWebWorkerHost": true,
 			"request": "launch",
 			"args": [
@@ -17,7 +17,7 @@
 			"outFiles": [
 				"${workspaceFolder}/dist/web/**/*.js"
 			],
-			"preLaunchTask": "npm: watch-web"
+			"preLaunchTask": "${defaultBuildTask}"
 		},
 		{
 			"name": "Extension Tests",
@@ -32,7 +32,7 @@
 			"outFiles": [
 				"${workspaceFolder}/dist/web/**/*.js"
 			],
-			"preLaunchTask": "npm: watch-web"
+			"preLaunchTask": "${defaultBuildTask}"
 		}
 	]
 }

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

@@ -0,0 +1,11 @@
+// Place your settings in this file to overwrite default and user settings.
+{
+	"files.exclude": {
+		"out": false // set this to true to hide the "out" folder with the compiled JS files
+	},
+	"search.exclude": {
+		"out": true // set this to false to include "out" folder in search results
+	},
+	// Turn off tsc task auto detection since we have the necessary tasks as npm scripts
+	"typescript.tsc.autoDetect": "off"
+}

package/generators/app/templates/ext-extensionpack/vscode/launch.json

@@ -4,14 +4,14 @@
 // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
 {
 	"version": "0.2.0",
-    "configurations": [
-        {
-            "name": "Extension",
-            "type": "extensionHost",
-            "request": "launch",
-            "args": [
-                "--extensionDevelopmentPath=${workspaceFolder}"
-            ]
-        }
-    ]
-}
+	"configurations": [
+		{
+			"name": "Extension",
+			"type": "extensionHost",
+			"request": "launch",
+			"args": [
+				"--extensionDevelopmentPath=${workspaceFolder}"
+			]
+		}
+	]
+}

package/generators/app/templates/ext-keymap/vscode/launch.json

@@ -4,14 +4,14 @@
 // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
 {
 	"version": "0.2.0",
-    "configurations": [
-        {
-            "name": "Extension",
-            "type": "extensionHost",
-            "request": "launch",
-            "args": [
-                "--extensionDevelopmentPath=${workspaceFolder}"
-            ]
-        }
-    ]
-}
+	"configurations": [
+		{
+			"name": "Extension",
+			"type": "extensionHost",
+			"request": "launch",
+			"args": [
+				"--extensionDevelopmentPath=${workspaceFolder}"
+			]
+		}
+	]
+}

package/generators/app/templates/ext-language/vscode/launch.json

@@ -4,14 +4,14 @@
 // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
 {
 	"version": "0.2.0",
-    "configurations": [
-        {
-            "name": "Extension",
-            "type": "extensionHost",
-            "request": "launch",
-            "args": [
-                "--extensionDevelopmentPath=${workspaceFolder}"
-            ]
-        }
-    ]
-}
+	"configurations": [
+		{
+			"name": "Extension",
+			"type": "extensionHost",
+			"request": "launch",
+			"args": [
+				"--extensionDevelopmentPath=${workspaceFolder}"
+			]
+		}
+	]
+}

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

@@ -3,35 +3,35 @@
 // Hover to view descriptions of existing attributes.
 // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
 {
-  "version": "0.2.0",
-  "configurations": [
-    {
-      "name": "Run Extension",
-      "type": "pwa-extensionHost",
-      "request": "launch",
-      "args": [
-        "--extensionDevelopmentPath=${workspaceFolder}",
-        "${workspaceFolder}/example"
-      ],
-      "outFiles": [
-        "${workspaceFolder}/out/**/*.js"
-      ],
-      "debugWebviews": true,
-      "trace": true,
-      "preLaunchTask": "npm: watch"
-    },
-    {
-      "name": "Run Extension (no server)",
-      "type": "extensionHost",
-      "request": "launch",
-      "args": [
-        "--extensionDevelopmentPath=${workspaceFolder}"
-      ],
-      "outFiles": [
-        "${workspaceFolder}/out/**/*.js"
-      ],
-      "debugWebviews": true,
-      "preLaunchTask": "npm: watch"
-    }
-  ]
+	"version": "0.2.0",
+	"configurations": [
+		{
+			"name": "Run Extension",
+			"type": "pwa-extensionHost",
+			"request": "launch",
+			"args": [
+				"--extensionDevelopmentPath=${workspaceFolder}",
+				"${workspaceFolder}/example"
+			],
+			"outFiles": [
+				"${workspaceFolder}/out/**/*.js"
+			],
+			"debugWebviews": true,
+			"trace": true,
+			"preLaunchTask": "npm: watch"
+		},
+		{
+			"name": "Run Extension (no server)",
+			"type": "extensionHost",
+			"request": "launch",
+			"args": [
+				"--extensionDevelopmentPath=${workspaceFolder}"
+			],
+			"outFiles": [
+				"${workspaceFolder}/out/**/*.js"
+			],
+			"debugWebviews": true,
+			"preLaunchTask": "npm: watch"
+		}
+	]
 }

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

@@ -1,11 +1,11 @@
 // Place your settings in this file to overwrite default and user settings.
 {
-  "files.exclude": {
-    "out": false // set this to true to hide the "out" folder with the compiled JS files
-  },
-  "search.exclude": {
-    "out": true // set this to false to include "out" folder in search results
-  },
-  // Turn off tsc task auto detection since we have the necessary tasks as npm scripts
-  "typescript.tsc.autoDetect": "off"
+	"files.exclude": {
+		"out": false // set this to true to hide the "out" folder with the compiled JS files
+	},
+	"search.exclude": {
+		"out": true // set this to false to include "out" folder in search results
+	},
+	// Turn off tsc task auto detection since we have the necessary tasks as npm scripts
+	"typescript.tsc.autoDetect": "off"
 }

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

@@ -1,36 +1,36 @@
 // See https://go.microsoft.com/fwlink/?LinkId=733558
 // for the documentation about the tasks.json format
 {
-  "version": "2.0.0",
-  "tasks": [
-    {
-      "type": "npm",
-      "script": "dev",
-      "problemMatcher": ["$tsc-watch", "$ts-checker-webpack-watch"],
-      "isBackground": true,
-      "presentation": {
-        "reveal": "never"
-      },
-      "group": {
-        "kind": "build",
-        "isDefault": true
-      }
-    },
-    {
-      "type": "npm",
-      "script": "watch",
-      "problemMatcher": ["$tsc-watch", "$ts-checker-webpack-watch"],
-      "isBackground": true,
-      "presentation": {
-        "reveal": "never"
-      },
-      "group": "build"
-    },
-    {
-      "type": "npm",
-      "script": "compile",
-      "problemMatcher": ["$tsc", "$ts-checker-webpack"],
-      "group": "build"
-    }
-  ]
+	"version": "2.0.0",
+	"tasks": [
+		{
+			"type": "npm",
+			"script": "dev",
+			"problemMatcher": ["$tsc-watch", "$ts-checker-webpack-watch"],
+			"isBackground": true,
+			"presentation": {
+				"reveal": "never"
+			},
+			"group": {
+			"kind": "build",
+			"isDefault": true
+			}
+		},
+		{
+			"type": "npm",
+			"script": "watch",
+			"problemMatcher": ["$tsc-watch", "$ts-checker-webpack-watch"],
+			"isBackground": true,
+			"presentation": {
+				"reveal": "never"
+			},
+			"group": "build"
+		},
+		{
+			"type": "npm",
+			"script": "compile",
+			"problemMatcher": ["$tsc", "$ts-checker-webpack"],
+			"group": "build"
+		}
+	]
 }

package/generators/app/templates/ext-snippets/vscode/launch.json

@@ -4,14 +4,14 @@
 // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
 {
 	"version": "0.2.0",
-    "configurations": [
-        {
-            "name": "Extension",
-            "type": "extensionHost",
-            "request": "launch",
-            "args": [
-                "--extensionDevelopmentPath=${workspaceFolder}"
-            ]
-        }
-    ]
-}
+	"configurations": [
+		{
+			"name": "Extension",
+			"type": "extensionHost",
+			"request": "launch",
+			"args": [
+				"--extensionDevelopmentPath=${workspaceFolder}"
+			]
+		}
+	]
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "generator-code",
-  "version": "1.8.6",
+  "version": "1.10.0",
   "description": "Yeoman generator for Visual Studio Code extensions.",
   "keywords": [
     "yeoman-generator",
@@ -39,14 +39,14 @@
     "fast-plist": "^0.1.3",
     "request-light": "^0.7.0",
     "which": "^4.0.0",
-    "yeoman-generator": "^6.0.1",
+    "yeoman-generator": "^7.2.0",
     "yosay": "^3.0.0"
   },
   "devDependencies": {
     "@types/mocha": "^10.0.6",
     "@types/node": "^16.18.82",
     "mocha": "^10.4.0",
-    "yeoman-environment": "^3.19.3",
-    "yeoman-test": "^8.2.0"
+    "yeoman-environment": "^4.4.0",
+    "yeoman-test": "^8.3.0"
   }
 }

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

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