more jsdoc typing (#484)

Author: aeschli

generators/app/generate-colortheme.js

@@ -9,13 +9,27 @@ import * as fs from 'fs';
 import * as plistParser from 'fast-plist';
 import request from 'request-light';
 
+/**
+ * @typedef {{
+*   themeContent: Object,
+*   themeName: string,
+*   themeBase: string,
+*   themeFileName: string,
+*   tmThemeFileName: string,
+*   tmThemeContent: string,
+* } & import('./index.js').ExtensionConfig} ExtensionConfig
+*/
+
+/**
+ * @type {import('./index.js').ExtensionGenerator}
+ */
 export default {
     id: 'ext-colortheme',
     aliases: ['colortheme'],
     name: 'New Color Theme',
     /**
      * @param {Generator} generator
-     * @param {Object} extensionConfig
+     * @param {ExtensionConfig} extensionConfig
      */
     prompting: async (generator, extensionConfig) => {
 
@@ -63,7 +77,7 @@ export default {
     },
     /**
      * @param {Generator} generator
-     * @param {Object} extensionConfig
+     * @param {ExtensionConfig} extensionConfig
      */
     writing: (generator, extensionConfig) => {
         if (extensionConfig.tmThemeFileName) {
@@ -92,7 +106,7 @@ export default {
 
 /**
  * @param {Generator} generator
- * @param {Object} extensionConfig
+ * @param {ExtensionConfig} extensionConfig
  */
 async function askForThemeInfo(generator, extensionConfig) {
     if (generator.options['quick']) {
@@ -132,7 +146,12 @@ async function askForThemeInfo(generator, extensionConfig) {
         await convertTheme(null, extensionConfig, false, generator);
     }
 }
-
+/**
+ * @param {string} location
+ * @param {ExtensionConfig} extensionConfig
+ * @param {boolean} inline
+ * @param {Generator} generator
+ */
 function convertTheme(location, extensionConfig, inline, generator) {
     if (!location) {
         extensionConfig.tmThemeFileName = '';
@@ -187,6 +206,12 @@ function convertTheme(location, extensionConfig, inline, generator) {
     }
 }
 
+/**
+ * @param {ExtensionConfig} extensionConfig
+ * @param {string} tmThemeFileName
+ * @param {string} body
+ * @param {Generator} generator
+ */
 function processContent(extensionConfig, tmThemeFileName, body, generator) {
     const themeNameMatch = body.match(/<key>name<\/key>\s*<string>([^<]*)/);
     const themeName = themeNameMatch ? themeNameMatch[1] : '';
@@ -235,6 +260,11 @@ const mappings = {
     "ansiBrightCyan": ["terminal.ansiBrightCyan"], "ansiBrightWhite": ["terminal.ansiBrightWhite"]
 };
 
+/**
+ * @param {string} content
+ * @param {string} tmThemeFileName
+ * @param {Generator} generator
+ */
 function migrate(content, tmThemeFileName, generator) {
     let result = {};
     let theme;

generators/app/generate-command-js.js

@@ -4,13 +4,23 @@
 import Generator from 'yeoman-generator';
 import * as prompts from './prompts.js';
 
+
+/**
+ * @typedef {{
+*   checkJavaScript: boolean
+* } & import('./index.js').ExtensionConfig} ExtensionConfig
+*/
+
+/**
+ * @type {import('./index.js').ExtensionGenerator}
+ */
 export default {
     id: 'ext-command-js',
     aliases: ['js', 'command-js'],
     name: 'New Extension (JavaScript)',
     /**
      * @param {Generator} generator
-     * @param {Object} extensionConfig
+     * @param {ExtensionConfig} extensionConfig
      */
     prompting: async (generator, extensionConfig) => {
         await prompts.askForExtensionDisplayName(generator, extensionConfig);
@@ -33,7 +43,7 @@ export default {
 
     /**
      * @param {Generator} generator
-     * @param {Object} extensionConfig
+     * @param {ExtensionConfig} extensionConfig
      */
     writing: (generator, extensionConfig) => {
         generator.fs.copy(generator.templatePath('vscode'), generator.destinationPath('.vscode'));

generators/app/generate-command-ts.js

@@ -5,16 +5,24 @@ import Generator from 'yeoman-generator';
 import { Chalk } from 'chalk';
 import * as prompts from './prompts.js';
 
+/**
+ * @typedef {import('./index.js').ExtensionConfig} ExtensionConfig
+ */
+
+
 const chalk = new Chalk();
 
+/**
+ * @type {import('./index.js').ExtensionGenerator}
+ */
 export default {
     id: 'ext-command-ts',
     aliases: ['ts', 'command-ts'],
     name: 'New Extension (TypeScript)',
     insidersName: 'New Extension with Proposed API (TypeScript)',
     /**
      * @param {Generator} generator
-     * @param {Object} extensionConfig
+     * @param {ExtensionConfig} extensionConfig
      */
     prompting: async (generator, extensionConfig) => {
         await prompts.askForExtensionDisplayName(generator, extensionConfig);
@@ -27,7 +35,7 @@ export default {
     },
     /**
      * @param {Generator} generator
-     * @param {Object} extensionConfig
+     * @param {ExtensionConfig} extensionConfig
      */
     writing: (generator, extensionConfig) => {
         const bundler = extensionConfig.bundler;
@@ -70,12 +78,15 @@ export default {
 
     /**
      * @param {Generator} generator
-     * @param {Object} extensionConfig
+     * @param {ExtensionConfig} extensionConfig
      */
     endMessage: (generator, extensionConfig) => {
-        if (extensionConfig.webpack) {
+        if (extensionConfig.bundler === 'webpack') {
             generator.log(chalk.yellow(`To run the extension you need to install the recommended extension 'amodio.tsl-problem-matcher'.`));
             generator.log('');
+        } else if (extensionConfig.bundler === 'esbuild') {
+            generator.log(chalk.yellow(`To run the extension you need to install the recommended extension 'connor4312.esbuild-problem-matchers'.`));
+            generator.log('');
         }
     }
 }

generators/app/generate-command-web.js

@@ -5,15 +5,21 @@ import Generator from 'yeoman-generator';
 import { Chalk } from 'chalk';
 import * as prompts from './prompts.js';
 
+/**
+ * @typedef {import('./index.js').ExtensionConfig} ExtensionConfig
+ */
 const chalk = new Chalk();
 
+/**
+ * @type {import('./index.js').ExtensionGenerator}
+ */
 export default {
     id: 'ext-command-web',
     aliases: ['web', 'command-web'],
     name: 'New Web Extension (TypeScript)',
     /**
      * @param {Generator} generator
-     * @param {Object} extensionConfig
+     * @param {ExtensionConfig} extensionConfig
      */
     prompting: async (generator, extensionConfig) => {
         await prompts.askForExtensionDisplayName(generator, extensionConfig);
@@ -26,7 +32,7 @@ export default {
     },
     /**
      * @param {Generator} generator
-     * @param {Object} extensionConfig
+     * @param {ExtensionConfig} extensionConfig
      */
     writing: (generator, extensionConfig) => {
         const bundler = extensionConfig.bundler;
@@ -72,10 +78,15 @@ export default {
     },
     /**
      * @param {Generator} generator
-     * @param {Object} extensionConfig
+     * @param {ExtensionConfig} 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('');
+        if (extensionConfig.bundler === 'webpack') {
+            generator.log(chalk.yellow(`To run the extension you need to install the recommended extension 'amodio.tsl-problem-matcher'.`));
+            generator.log('');
+        } else if (extensionConfig.bundler === 'esbuild') {
+            generator.log(chalk.yellow(`To run the extension you need to install the recommended extension 'connor4312.esbuild-problem-matchers'.`));
+            generator.log('');
+        }
     }
 }

generators/app/generate-extensionpack.js

@@ -5,13 +5,24 @@ import Generator from 'yeoman-generator';
 import * as prompts from './prompts.js';
 import * as childProcess from 'child_process';
 
+
+/**
+ * @typedef {{
+*   extensionList: string[],
+*   isCustomization: boolean
+* } & import('./index.js').ExtensionConfig} ExtensionConfig
+*/
+
+/**
+ * @type {import('./index.js').ExtensionGenerator}
+ */
 export default {
     id: 'ext-extensionpack',
     aliases: ['extensionpack'],
     name: 'New Extension Pack',
     /**
      * @param {Generator} generator
-     * @param {Object} extensionConfig
+     * @param {ExtensionConfig} extensionConfig
      */
     prompting: async (generator, extensionConfig) => {
 
@@ -25,7 +36,7 @@ export default {
     },
     /**
      * @param {Generator} generator
-     * @param {Object} extensionConfig
+     * @param {ExtensionConfig} extensionConfig
      */
     writing: (generator, extensionConfig) => {
         generator.fs.copy(generator.templatePath('vscode'), generator.destinationPath('.vscode'));
@@ -40,7 +51,10 @@ export default {
         }
     }
 }
-
+/**
+ * @param {Generator} generator
+ * @param {ExtensionConfig} extensionConfig
+ */
 function askForExtensionPackInfo(generator, extensionConfig) {
     extensionConfig.isCustomization = true;
     const defaultExtensionList = ['publisher.extensionName'];
@@ -51,7 +65,7 @@ function askForExtensionPackInfo(generator, extensionConfig) {
                 'code --list-extensions',
                 (error, stdout, stderr) => {
                     if (error) {
-                        generator.env.error(error);
+                        generator.log.error(error);
                     } else {
                         let out = stdout.trim();
                         if (out.length > 0) {

generators/app/generate-keymap.js

@@ -4,13 +4,20 @@
 import Generator from 'yeoman-generator';
 import * as prompts from './prompts.js';
 
+/**
+ * @typedef { import('./index.js').ExtensionConfig} ExtensionConfig
+*/
+
+/**
+ * @type {import('./index.js').ExtensionGenerator}
+ */
 export default {
     id: 'ext-keymap',
     aliases: ['keymap'],
     name: 'New Keymap',
     /**
      * @param {Generator} generator
-     * @param {Object} extensionConfig
+     * @param {ExtensionConfig} extensionConfig
      */
     prompting: async (generator, extensionConfig) => {
         await prompts.askForExtensionDisplayName(generator, extensionConfig);
@@ -21,7 +28,7 @@ export default {
     },
     /**
      * @param {Generator} generator
-     * @param {Object} extensionConfig
+     * @param {ExtensionConfig} extensionConfig
      */
     writing: (generator, extensionConfig) => {
         generator.fs.copy(generator.templatePath('vscode'), generator.destinationPath('.vscode'));