generator-code 1.7.9 → 1.8.1

package/generators/app/index.js

@@ -3,30 +3,29 @@
  *--------------------------------------------------------*/
 'use strict';
 
-const Generator = require('yeoman-generator');
-const yosay = require('yosay');
-
-const path = require('path');
-const env = require('./env');
-const which = require('which');
-
-const colortheme = require('./generate-colortheme');
-const commandjs = require('./generate-command-js');
-const commandts = require('./generate-command-ts');
-const commandweb = require('./generate-command-web');
-const extensionpack = require('./generate-extensionpack');
-const keymap = require('./generate-keymap');
-const language = require('./generate-language');
-const localization = require('./generate-localization');
-const notebook = require('./generate-notebook-renderer');
-const snippets = require('./generate-snippets');
+import Generator from 'yeoman-generator';
+import yosay from 'yosay';
+import { fileURLToPath } from 'url';
+import * as path from 'path';
+import * as env from './env.js';
+import which from 'which';
+import colortheme from './generate-colortheme.js';
+import commandjs from './generate-command-js.js';
+import commandts from './generate-command-ts.js';
+import commandweb from './generate-command-web.js';
+import extensionpack from './generate-extensionpack.js';
+import keymap from './generate-keymap.js';
+import language from './generate-language.js';
+import localization from './generate-localization.js';
+import notebook from './generate-notebook-renderer.js';
+import snippets from './generate-snippets.js';
 
 const extensionGenerators = [
     commandts, commandjs, colortheme, language, snippets, keymap, extensionpack, localization,
     commandweb, notebook
 ]
 
-module.exports = class extends Generator {
+export default class extends Generator {
 
     constructor(args, opts) {
         super(args, opts);
@@ -126,6 +125,7 @@ module.exports = class extends Generator {
         try {
             await this.extensionGenerator.prompting(this, this.extensionConfig);
         } catch (e) {
+            console.log(e);
             this.abort = true;
         }
 
@@ -143,7 +143,8 @@ module.exports = class extends Generator {
         this.log();
         this.log(`Writing in ${this.destinationPath()}...`);
 
-        this.sourceRoot(path.join(__dirname, './templates/' + this.extensionConfig.type));
+        const currentFilename = fileURLToPath(import.meta.url);
+        this.sourceRoot(path.join(currentFilename, '../templates/' + this.extensionConfig.type));
 
         return this.extensionGenerator.writing(this, this.extensionConfig);
     }
@@ -151,12 +152,15 @@ module.exports = class extends Generator {
     // Installation
     install() {
         if (this.abort) {
+            // @ts-ignore
             this.env.options.skipInstall = true;
             return;
         }
         if (this.extensionConfig.installDependencies) {
+            // @ts-ignore
             this.env.options.nodePackageManager = this.extensionConfig.pkgManager;
         } else {
+            // @ts-ignore
             this.env.options.skipInstall = true;
         }
     }
@@ -185,7 +189,7 @@ module.exports = class extends Generator {
 
         // Git init
         if (this.extensionConfig.gitInit) {
-            this.spawnCommand('git', ['init', '--quiet', '--initial-branch=main']);
+            this.spawnCommand('git', ['init', '--quiet']);
         }
 
         if (this.extensionConfig.proposedAPI) {

package/generators/app/prompts.js

@@ -3,14 +3,16 @@
  * Copyright (C) Microsoft Corporation. All rights reserved.
  *--------------------------------------------------------*/
 
-const validator = require('./validator');
-const path = require('path');
+import Generator from 'yeoman-generator';
+
+import * as validator from './validator.js';
+import * as path from 'path';
 
 /**
-* @param {import('yeoman-generator')} generator
+* @param {Generator} generator
 * @param {Object} extensionConfig
 */
-exports.askForExtensionDisplayName = (generator, extensionConfig) => {
+export function askForExtensionDisplayName(generator, extensionConfig) {
     let extensionDisplayName = generator.options['extensionDisplayName'];
     if (extensionDisplayName) {
         extensionConfig.displayName = extensionDisplayName;
@@ -35,10 +37,10 @@ exports.askForExtensionDisplayName = (generator, extensionConfig) => {
 
 /**
  * Ask for extension id ("name" in package.json)
-* @param {import('yeoman-generator')} generator
+* @param {Generator} generator
 * @param {Object} extensionConfig
 */
-exports.askForExtensionId = (generator, extensionConfig) => {
+export function askForExtensionId(generator, extensionConfig) {
     let extensionName = generator.options['extensionId'];
     if (extensionName) {
         extensionConfig.name = extensionName;
@@ -66,10 +68,10 @@ exports.askForExtensionId = (generator, extensionConfig) => {
 
 /**
  * Ask for extension description
-* @param {import('yeoman-generator')} generator
+* @param {Generator} generator
 * @param {Object} extensionConfig
 */
-exports.askForExtensionDescription = (generator, extensionConfig) => {
+export function askForExtensionDescription(generator, extensionConfig) {
     let extensionDescription = generator.options['extensionDescription'];
     if (extensionDescription) {
         extensionConfig.description = extensionDescription;
@@ -91,10 +93,10 @@ exports.askForExtensionDescription = (generator, extensionConfig) => {
 }
 
 /**
-* @param {import('yeoman-generator')} generator
+* @param {Generator} generator
 * @param {Object} extensionConfig
 */
-exports.askForGit = (generator, extensionConfig) => {
+export function askForGit(generator, extensionConfig) {
     let gitInit = generator.options['gitInit'];
     if (typeof gitInit === 'boolean') {
         extensionConfig.gitInit = Boolean(gitInit);
@@ -116,10 +118,10 @@ exports.askForGit = (generator, extensionConfig) => {
 }
 
 /**
-* @param {import('yeoman-generator')} generator
+* @param {Generator} generator
 * @param {Object} extensionConfig
 */
-exports.askForPackageManager = (generator, extensionConfig) => {
+export function askForPackageManager(generator, extensionConfig) {
     let pkgManager = generator.options['pkgManager'];
     if (pkgManager === 'npm' || pkgManager === 'yarn' || pkgManager === 'pnpm') {
         extensionConfig.pkgManager = pkgManager;
@@ -156,10 +158,10 @@ exports.askForPackageManager = (generator, extensionConfig) => {
 }
 
 /**
-* @param {import('yeoman-generator')} generator
+* @param {Generator} generator
 * @param {Object} extensionConfig
 */
-exports.askForWebpack = (generator, extensionConfig) => {
+export function askForWebpack(generator, extensionConfig) {
     let webpack = generator.options['webpack'];
     if (typeof webpack === 'boolean') {
         extensionConfig.webpack = Boolean(webpack);

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/jsconfig.json

@@ -1,10 +1,10 @@
 {
 	"compilerOptions": {
-		"module": "commonjs",
-		"target": "ES2020",
+		"module": "Node16",
+		"target": "ES2022",
 		"checkJs": <%- JSON.stringify(checkJavaScript) %>,  /* Typecheck .js files. */
 		"lib": [
-			"ES2020"
+			"ES2022"
 		]
 	},
 	"exclude": [

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/.eslintrc.json

@@ -9,7 +9,13 @@
         "@typescript-eslint"
     ],
     "rules": {
-        "@typescript-eslint/naming-convention": "warn",
+        "@typescript-eslint/naming-convention": [
+            "warn",
+            {
+                "selector": "import",
+                "format": [ "camelCase", "PascalCase" ]
+            }
+        ],
         "@typescript-eslint/semi": "warn",
         "curly": "warn",
         "eqeqeq": "warn",
@@ -21,4 +27,4 @@
         "dist",
         "**/*.d.ts"
     ]
-}
+}

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/tsconfig.json

@@ -1,10 +1,10 @@
 {
 	"compilerOptions": {
-		"module": "commonjs",
-		"target": "ES2020",
+		"module": "Node16",
+		"target": "ES2022",
 		"outDir": "out",
 		"lib": [
-			"ES2020"
+			"ES2022"
 		],
 		"sourceMap": true,
 		"rootDir": "src",

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/tsconfig.json

@@ -1,9 +1,9 @@
 {
 	"compilerOptions": {
-		"module": "commonjs",
-		"target": "ES2020",
+		"module": "Node16",
+		"target": "ES2022",
 		"lib": [
-			"ES2020"
+			"ES2022"
 		],
 		"sourceMap": true,
 		"rootDir": "src",

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/tsconfig.json

@@ -1,6 +1,6 @@
 {
 	"compilerOptions": {
-		"module": "commonjs",
+		"module": "Node16",
 		"target": "ES2020",
 		"outDir": "dist",
 		"lib": [

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/src/tsconfig-base.json

@@ -1,12 +1,11 @@
 {
   "compilerOptions": {
-    "module": "commonjs",
-    "target": "ES2019",
+    "module": "Node16",
+    "target": "ES2022",
     "lib": [
-      "ES2019"
+      "ES2022"
     ],
     "types": ["node"],
-    "moduleResolution": "node",
     "sourceMap": true,
     "strict": true   /* enable all strict type-checking options */
     /* Additional Checks */

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}"
     }
   ]
 }