generator-code 1.6.1 → 1.6.5

package/generators/app/{generate-command-ts .js → generate-command-ts.js}

@@ -2,6 +2,7 @@
  * Copyright (C) Microsoft Corporation. All rights reserved.
  *--------------------------------------------------------*/
 
+const chalk = require("chalk");
 const prompts = require("./prompts");
 
 module.exports = {
@@ -33,11 +34,13 @@ module.exports = {
             generator.fs.copyTpl(generator.templatePath('vscode-webpack/tsconfig.json'), generator.destinationPath('tsconfig.json'), extensionConfig);
             generator.fs.copyTpl(generator.templatePath('vscode-webpack/vscodeignore'), generator.destinationPath('.vscodeignore'), extensionConfig);
             generator.fs.copyTpl(generator.templatePath('vscode-webpack/webpack.config.js'), generator.destinationPath('webpack.config.js'), extensionConfig);
+            generator.fs.copyTpl(generator.templatePath('vscode-webpack/vsc-extension-quickstart.md'), generator.destinationPath('vsc-extension-quickstart.md'), extensionConfig);
         } else {
             generator.fs.copy(generator.templatePath('vscode'), generator.destinationPath('.vscode'));
             generator.fs.copyTpl(generator.templatePath('package.json'), generator.destinationPath('package.json'), extensionConfig);
             generator.fs.copyTpl(generator.templatePath('tsconfig.json'), generator.destinationPath('tsconfig.json'), extensionConfig);
             generator.fs.copyTpl(generator.templatePath('vscodeignore'), generator.destinationPath('.vscodeignore'), extensionConfig);
+            generator.fs.copyTpl(generator.templatePath('vsc-extension-quickstart.md'), generator.destinationPath('vsc-extension-quickstart.md'), extensionConfig);
         }
 
         if (extensionConfig.gitInit) {
@@ -45,7 +48,6 @@ module.exports = {
         }
         generator.fs.copyTpl(generator.templatePath('README.md'), generator.destinationPath('README.md'), extensionConfig);
         generator.fs.copyTpl(generator.templatePath('CHANGELOG.md'), generator.destinationPath('CHANGELOG.md'), extensionConfig);
-        generator.fs.copyTpl(generator.templatePath('vsc-extension-quickstart.md'), generator.destinationPath('vsc-extension-quickstart.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('.eslintrc.json'), generator.destinationPath('.eslintrc.json'));
@@ -56,5 +58,16 @@ module.exports = {
 
         extensionConfig.installDependencies = true;
         extensionConfig.proposedAPI = extensionConfig.insiders;
+    },
+
+    /**
+     * @param {import('yeoman-generator')} generator
+     * @param {Object} extensionConfig
+     */
+    endMessage: (generator, extensionConfig) => {
+        if (extensionConfig.webpack) {
+            generator.log(chalk.yellow(`To run the extension you need to install the recommended extension 'amodio.tsl-problem-matcher'.`));
+            generator.log('');
+        }
     }
 }

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

@@ -2,6 +2,7 @@
  * Copyright (C) Microsoft Corporation. All rights reserved.
  *--------------------------------------------------------*/
 
+const chalk = require("chalk");
 const prompts = require("./prompts");
 
 module.exports = {
@@ -44,7 +45,19 @@ module.exports = {
 
         generator.fs.copy(generator.templatePath('.eslintrc.json'), generator.destinationPath('.eslintrc.json'));
 
+        if (extensionConfig.pkgManager === 'yarn') {
+            generator.fs.copyTpl(generator.templatePath('.yarnrc'), generator.destinationPath('.yarnrc'), extensionConfig);
+        }
+
         extensionConfig.installDependencies = true;
         extensionConfig.proposedAPI = false;
+    },
+    /**
+     * @param {import('yeoman-generator')} generator
+     * @param {Object} extensionConfig
+     */
+    endMessage: (generator, extensionConfig) => {
+        generator.log(chalk.yellow(`To run the extension you need to install the recommended extension 'amodio.tsl-problem-matcher'.`));
+        generator.log('');
     }
 }

package/generators/app/index.js

@@ -8,10 +8,11 @@ const yosay = require('yosay');
 
 const path = require('path');
 const env = require('./env');
+const witch = require('which');
 
 const colortheme = require('./generate-colortheme');
 const commandjs = require('./generate-command-js');
-const commandts = require('./generate-command-ts ');
+const commandts = require('./generate-command-ts');
 const commandweb = require('./generate-command-web');
 const extensionpack = require('./generate-extensionpack');
 const keymap = require('./generate-keymap');
@@ -161,7 +162,7 @@ module.exports = class extends Generator {
     }
 
     // End
-    end() {
+    async end() {
         if (this.abort) {
             return;
         }
@@ -195,6 +196,8 @@ module.exports = class extends Generator {
         this.log('Your extension ' + this.extensionConfig.name + ' has been created!');
         this.log('');
 
+        const [codeStableLocation, codeInsidersLocation] = await Promise.all([witch('code').catch(() => undefined), witch('code-insiders').catch(() => undefined)]);
+
         if (!this.extensionConfig.insiders && !this.options['open'] && !this.options['openInInsiders'] && !this.options['quick']) {
             const cdLocation = this.options['destination'] || this.extensionConfig.name;
 
@@ -203,7 +206,11 @@ module.exports = class extends Generator {
             if (cdLocation !== '.') {
                 this.log('     cd ' + cdLocation);
             }
-            this.log('     code-insiders .');
+            if (!this.extensionConfig.insiders) {
+                this.log('     code .');
+            } else {
+                this.log('     code-insiders .');
+            }
             this.log('');
         }
         this.log('Open vsc-extension-quickstart.md inside the new extension for further instructions');
@@ -217,12 +224,43 @@ module.exports = class extends Generator {
         this.log('For more information, also visit http://code.visualstudio.com and follow us @code.');
         this.log('\r\n');
 
-        if (this.options['open']) {
-            this.log(`Opening ${this.destinationPath()} in Visual Studio Code...`);
-            this.spawnCommand('code', [this.destinationPath()]);
-        } else if (this.extensionConfig.insiders || this.options['openInInsiders'] || this.options['quick']) {
-            this.log(`Opening ${this.destinationPath()} with Visual Studio Code Insiders...`);
-            this.spawnCommand('code-insiders', [this.destinationPath()]);
+        if (this.options["open"]) {
+            if (codeStableLocation) {
+                this.log(`Opening ${this.destinationPath()} in Visual Studio Code...`);
+                this.spawnCommand(codeStableLocation, [this.destinationPath()]);
+            } else {
+                this.log(`'code' command not found.`);
+            }
+        } else if (this.options["openInInsiders"]) {
+            if (codeInsidersLocation) {
+                this.log(`Opening ${this.destinationPath()} with Visual Studio Code Insiders...`);
+                this.spawnCommand(codeInsidersLocation, [this.destinationPath()]);
+            } else {
+                this.log(`'code-insiders' command not found.`);
+            }
+        } else if (codeInsidersLocation || codeStableLocation) {
+            if (this.options["quick"]) {
+                this.spawnCommand(codeInsidersLocation || codeStableLocation, [this.destinationPath()]);
+            } else {
+                const choices = [];
+                if (codeInsidersLocation) {
+                    choices.push({ name: "Open with `code-insiders`", value: codeInsidersLocation });
+                }
+                if (codeStableLocation) {
+                    choices.push({ name: "Open with `code`", value: codeStableLocation });
+                }
+                choices.push({ name: "Skip", value: 'skip' });
+
+                const answer = await this.prompt({
+                    type: "list",
+                    name: "openWith",
+                    message: "Do you want to open the new folder with Visual Studio Code?",
+                    choices
+                });
+                if (answer && answer.openWith && answer.openWith !== 'skip') {
+                    this.spawnCommand(answer.openWith, [this.destinationPath()]);
+                }
+            }
         }
     }
 }

package/generators/app/package.json

@@ -3,17 +3,17 @@
         "@types/glob": "^7.1.4",
         "@types/mocha": "^9.0.0",
         "@types/node": "14.x",
-        "@typescript-eslint/eslint-plugin": "^4.31.1",
-        "@typescript-eslint/parser": "^4.31.1",
-        "eslint": "^7.32.0",
+        "@typescript-eslint/eslint-plugin": "^5.1.0",
+        "@typescript-eslint/parser": "^5.1.0",
+        "eslint": "^8.1.0",
         "glob": "^7.1.7",
-        "mocha": "^9.1.1",
-        "typescript": "^4.4.3",
+        "mocha": "^9.1.3",
+        "typescript": "^4.4.4",
         "@vscode/test-electron": "^1.6.2",
-        "@vscode/test-web": "^0.0.12",
+        "@vscode/test-web": "^0.0.15",
         "@types/webpack-env": "^1.16.2",
         "@types/vscode-notebook-renderer": "^1.57.8",
-        "concurrently": "^`5.3.0",
+        "concurrently": "^5.3.0",
         "css-loader": "^4.2.0",
         "fork-ts-checker-webpack-plugin": "^5.0.14",
         "style-loader": "^1.2.1",
@@ -21,6 +21,7 @@
         "vscode-dts": "^0.3.1",
         "vscode-notebook-error-overlay": "^1.0.1",
         "webpack": "^5.52.1",
+        "util": "^0.12.4",
         "webpack-cli": "^4.8.0",
         "webpack-dev-server": "^3.11.2",
         "assert": "^2.0.0",

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

@@ -13,7 +13,7 @@
         <%- JSON.stringify(`onCommand:${name}.helloWorld`) %>
 	],
 	"main": "./out/extension.js",<% if (insiders) { %>
-	"enableProposedApi": true,<% } %>
+	"enabledApiProposals": [],<% } %>
 	"contributes": {
 		"commands": [
 			{

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

@@ -13,7 +13,7 @@
         <%- JSON.stringify(`onCommand:${name}.helloWorld`) %>
 	],
 	"main": "./dist/extension.js",<% if (insiders) { %>
-	"enableProposedApi": true,<% } %>
+	"enabledApiProposals": [],<% } %>
 	"contributes": {
 		"commands": [
 			{
@@ -27,8 +27,9 @@
 		"compile": "webpack",
 		"watch": "webpack --watch",
 		"package": "webpack --mode production --devtool hidden-source-map",
-		"test-compile": "tsc -p . --outDir out",
-		"pretest": "<%= pkgManager %> run test-compile && <%= pkgManager %> run compile && <%= pkgManager %> run lint",
+		"compile-tests": "tsc -p . --outDir out",
+		"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) { %>,
 		"update-proposed-api": "vscode-dts dev"<% } %>

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

@@ -5,6 +5,7 @@
 		"lib": [
 			"ES2020"
 		],
+		"sourceMap": true,
 		"rootDir": "src",
 		"strict": true   /* enable all strict type-checking options */
 		/* Additional Checks */

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

@@ -0,0 +1,47 @@
+# Welcome to your VS Code Extension
+
+## What's in the folder
+
+* This folder contains all of the files necessary for your extension.
+* `package.json` - this is the manifest file in which you declare your extension and command.
+  * The sample plugin registers a command and defines its title and command name. With this information VS Code can show the command in the command palette. It doesn’t yet need to load the plugin.
+* `src/extension.ts` - this is the main file where you will provide the implementation of your command.
+  * The file exports one function, `activate`, which is called the very first time your extension is activated (in this case by executing the command). Inside the `activate` function we call `registerCommand`.
+  * We pass the function containing the implementation of the command as the second parameter to `registerCommand`.
+
+## Setup
+
+* install the recommended extensions (amodio.tsl-problem-matcher and dbaeumer.vscode-eslint)
+
+
+## Get up and running straight away
+
+* Press `F5` to open a new window with your extension loaded.
+* Run your command from the command palette by pressing (`Ctrl+Shift+P` or `Cmd+Shift+P` on Mac) and typing `Hello World`.
+* Set breakpoints in your code inside `src/extension.ts` to debug your extension.
+* Find output from your extension in the debug console.
+
+## Make changes
+
+* You can relaunch the extension from the debug toolbar after changing code in `src/extension.ts`.
+* You can also reload (`Ctrl+R` or `Cmd+R` on Mac) the VS Code window with your extension to load your changes.
+
+
+## Explore the API
+
+* You can open the full set of our API when you open the file `node_modules/@types/vscode/index.d.ts`.
+
+## 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.
+  * 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.
+
+## Go further
+
+* Reduce the extension size and improve the startup time by [bundling your extension](https://code.visualstudio.com/api/working-with-extensions/bundling-extension).
+* [Publish your extension](https://code.visualstudio.com/api/working-with-extensions/publishing-extension) on the VSCode extension marketplace.
+* Automate builds by setting up [Continuous Integration](https://code.visualstudio.com/api/working-with-extensions/continuous-integration).

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

@@ -1,8 +1,5 @@
 {
-	// See http://go.microsoft.com/fwlink/?LinkId=827846
-	// for the documentation about the extensions.json format
-	"recommendations": [
-		"dbaeumer.vscode-eslint",
-		"eamodio.tsl-problem-matcher"
-	]
+  // 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-ts/vscode-webpack/vscode/launch.json

@@ -26,9 +26,10 @@
 				"--extensionTestsPath=${workspaceFolder}/out/test/suite/index"
 			],
 			"outFiles": [
-				"${workspaceFolder}/out/test/**/*.js"
+				"${workspaceFolder}/out/**/*.js",
+				"${workspaceFolder}/dist/**/*.js"
 			],
-			"preLaunchTask": "npm: test-watch"
+			"preLaunchTask": "tasks: watch-tests"
 		}
 	]
 }

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

@@ -7,12 +7,13 @@
 			"type": "npm",
 			"script": "watch",
 			"problemMatcher": [
-                "$ts-webpack-watch",
-                "$tslint-webpack-watch"
+				"$ts-webpack-watch",
+				"$tslint-webpack-watch"
 			],
 			"isBackground": true,
 			"presentation": {
-				"reveal": "never"
+				"reveal": "never",
+				"group": "watchers"
 			},
 			"group": {
 				"kind": "build",
@@ -21,13 +22,22 @@
 		},
 		{
 			"type": "npm",
-			"script": "test-watch",
+			"script": "watch-tests",
 			"problemMatcher": "$tsc-watch",
 			"isBackground": true,
 			"presentation": {
-				"reveal": "never"
+				"reveal": "never",
+				"group": "watchers"
 			},
 			"group": "build"
+		},
+		{
+			"label": "tasks: watch-tests",
+			"dependsOn": [
+				"npm: watch",
+				"npm: watch-tests"
+			],
+			"problemMatcher": []
 		}
 	]
 }

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

@@ -5,6 +5,7 @@ node_modules/**
 src/**
 .gitignore
 .yarnrc
+webpack.config.js
 vsc-extension-quickstart.md
 **/tsconfig.json
 **/.eslintrc.json

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

@@ -21,7 +21,7 @@ const extensionConfig = {
   },
   externals: {
     vscode: 'commonjs vscode' // the vscode-module is created on-the-fly and must be excluded. Add other modules that cannot be webpack'ed, 📖 -> https://webpack.js.org/configuration/externals/
-    // modules added here also need to be added in the .vsceignore file
+    // modules added here also need to be added in the .vscodeignore file
   },
   resolve: {
     // support reading TypeScript and JavaScript files, 📖 -> https://github.com/TypeStrong/ts-loader
@@ -40,6 +40,9 @@ const extensionConfig = {
       }
     ]
   },
-  devtool: 'nosources-source-map'
+  devtool: 'nosources-source-map',
+  infrastructureLogging: {
+    level: "log", // enables logging required for problem matchers
+  },
 };
 module.exports = [ extensionConfig ];

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

@@ -0,0 +1 @@
+--ignore-engines true

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

@@ -3,13 +3,13 @@
 ## What's in the folder
 
 * This folder contains all of the files necessary for your web extension.
-* `package.json` - this is the manifest file in which you declare your extension and command.
-* `src/web/extension.ts` - this is the main file for the browser
-* `webpack.config.js` - the webpack config file for the web main
+* `package.json` * this is the manifest file in which you declare your extension and command.
+* `src/web/extension.ts` * this is the main file for the browser
+* `webpack.config.js` * the webpack config file for the web main
 
 ## Setup
 
-* install the recommended extensions (eamodio.tsl-problem-matcher and dbaeumer.vscode-eslint)
+* install the recommended extensions (amodio.tsl-problem-matcher and dbaeumer.vscode-eslint)
 
 ## Get up and running the Web Extension
 
@@ -23,7 +23,6 @@
 * You can relaunch the extension from the debug toolbar after changing code in `src/web/extension.ts`.
 * You can also reload (`Ctrl+R` or `Cmd+R` on Mac) the VS Code window with your extension to load your changes.
 
-
 ## Explore the API
 
 * You can open the full set of our API when you open the file `node_modules/@types/vscode/index.d.ts`.
@@ -38,6 +37,7 @@
   * You can create folders inside the `test` folder to structure your tests any way you want.
 
 ## Go further
- * Check out the [Web Extension Guide](https://code.visualstudio.com/api/extension-guides/web-extensions)
- * [Publish your extension](https://code.visualstudio.com/api/working-with-extensions/publishing-extension) on the VSCode extension marketplace.
- * Automate builds by setting up [Continuous Integration](https://code.visualstudio.com/api/working-with-extensions/continuous-integration).
+
+* Check out the [Web Extension Guide](https://code.visualstudio.com/api/extension-guides/web-extensions)
+* [Publish your extension](https://code.visualstudio.com/api/working-with-extensions/publishing-extension) on the VSCode extension marketplace.
+* Automate builds by setting up [Continuous Integration](https://code.visualstudio.com/api/working-with-extensions/continuous-integration).

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

@@ -1,8 +1,5 @@
 {
-	// See http://go.microsoft.com/fwlink/?LinkId=827846
-	// for the documentation about the extensions.json format
-	"recommendations": [
-		"dbaeumer.vscode-eslint",
-		"eamodio.tsl-problem-matcher"
-	]
+  // 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/vscodeignore

@@ -3,9 +3,10 @@
 src/**
 out/**
 node_modules/**
-build/**
 .gitignore
 vsc-extension-quickstart.md
+webpack.config.js
+.yarnrc
 **/tsconfig.json
 **/.eslintrc.json
 **/*.map

package/generators/app/templates/ext-command-web/webpack.config.js

@@ -23,7 +23,8 @@ const webExtensionConfig = {
 	output: {
 		filename: '[name].js',
 		path: path.join(__dirname, './dist/web'),
-		libraryTarget: 'commonjs'
+		libraryTarget: 'commonjs',
+		devtoolModuleFilenameTemplate: '../../[resource-path]'
 	},
 	resolve: {
 		mainFields: ['browser', 'module', 'main'], // look for `browser` entry point in imported node modules
@@ -58,7 +59,10 @@ const webExtensionConfig = {
 	performance: {
 		hints: false
 	},
-	devtool: 'nosources-source-map' // create a source map that points to the original source file
+	devtool: 'nosources-source-map', // create a source map that points to the original source file
+	infrastructureLogging: {
+		level: "log", // enables logging required for problem matchers
+	},
 };
 
 module.exports = [ webExtensionConfig ];

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

@@ -52,6 +52,7 @@
     <%- dep("typescript") %>,
     <%- dep("vscode-notebook-error-overlay") %>,
     <%- dep("@vscode/test-electron") %>,
+    <%- dep("util") %>,
     <%- dep("webpack") %>,
     <%- dep("webpack-cli") %>
   }

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

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

package/generators/app/templates/ext-notebook-renderer/webpack.config.js

@@ -14,8 +14,12 @@ const makeConfig = (argv, { entry, out, target, library = 'commonjs' }) => ({
         libraryTarget: library,
         chunkFormat: library,
     },
+    externals: {
+        vscode: 'commonjs vscode',
+    },
     resolve: {
         extensions: ['.ts', '.tsx', '.js', '.jsx', '.css'],
+        fallback: { "util": require.resolve("util/") }
     },
     experiments: {
         outputModule: true,
@@ -66,6 +70,9 @@ const makeConfig = (argv, { entry, out, target, library = 'commonjs' }) => ({
             scriptUrl: 'import.meta.url',
         }),
     ],
+    infrastructureLogging: {
+        level: "log", // enables logging required for problem matchers
+    },
 });
 
 module.exports = (env, argv) => [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "generator-code",
-  "version": "1.6.1",
+  "version": "1.6.5",
   "description": "Yeoman generator for Visual Studio Code Extensions",
   "keywords": [
     "yeoman-generator",
@@ -36,18 +36,20 @@
   "dependencies": {
     "chalk": "^4.1.2",
     "fast-plist": "^0.1.2",
-    "request-light": "^0.5.4",
+    "request-light": "^0.5.5",
     "sanitize-filename": "^1.6.3",
+    "which": "^2.0.2",
     "yeoman-generator": "^5.4.2",
     "yosay": "^2.0.2"
   },
   "devDependencies": {
     "@types/mocha": "^9.0.0",
-    "@types/node": "^15.12.0",
-    "@types/yeoman-generator": "^5.2.2",
-    "@types/yeoman-test": "^4.0.2",
-    "mocha": "^9.1.0",
+    "@types/node": "^16.11.6",
+    "@types/yeoman-generator": "^5.2.7",
+    "@types/yeoman-test": "^4.0.3",
+    "mocha": "^9.1.3",
     "yeoman-test": "^6.2.0",
-    "yeoman-environment": "^3.6.0"
+    "yeoman-environment": "^3.8.1",
+    "json-schema": ">=0.4.0"
   }
 }