feature(repo): generalize package script, remove redundant webpack.browser configs

package.json now accepts an argument to a subproject directory and will package the .vsix for that subproject.
This means that packages/amazonq can now be packaged into a .vsix with `npm run package`.
However, running this from the root project will only yield the toolkit.vsix for now.

Also, we can reference the browser config by name instead of file, so we don't need a separate config file for CLI usage.

Finally, fix an issue with the packaging script so that we always copy over the CHANGELOG.md, especially for releases.

Author: hayemaxi

.gitignore

@@ -38,10 +38,10 @@ packages/toolkit/src/testFixtures/**/bin
 packages/toolkit/src/testFixtures/**/obj
 
 # Generated by copyFiles.ts
-packages/toolkit/README*
-packages/toolkit/CHANGELOG.md
-packages/toolkit/LICENSE
-packages/toolkit/NOTICE
+packages/*/README*
+packages/*/CHANGELOG.md
+packages/*/LICENSE
+packages/*/NOTICE
 
 # Icons
 packages/toolkit/resources/icons/cloud9/generated/**

package.json

@@ -28,7 +28,7 @@
         "test": "npm run test -w packages/",
         "testE2E": "npm run testE2E -w packages/",
         "testInteg": "npm run testInteg -w packages/",
-        "package": "npm run package -w packages/",
+        "package": "npm run package -w packages/toolkit",
         "newChange": "ts-node ./scripts/newChange.ts",
         "createRelease": "ts-node ./scripts/createRelease.ts",
         "format": "prettier --check plugins && npm run format -w packages/",

packages/amazonq/webpack.browser.config.js

@@ -9,7 +9,7 @@
 
 const baseConfig = require('../webpack.base.config')
 const baseVueConfig = require('../webpack.vue.config')
-const baseBrowserConfig = require('./webpack.browser.config')
+const baseBrowserConfig = require('../webpack.browser.config')
 
 const config = {
     ...baseConfig,
@@ -29,7 +29,11 @@ const vueConfigs = baseVueConfig.configs.map(c => {
     }
 })
 
-// baseBrowserConfigs is set up in another file.
-const browserConfig = { ...baseBrowserConfig }
+const browserConfig = {
+    ...baseBrowserConfig,
+    entry: {
+        'src/extensionWeb': './src/extensionWeb.ts',
+    },
+}
 
 module.exports = [config, ...vueConfigs, browserConfig]

packages/amazonq/webpack.config.js

@@ -4246,7 +4246,7 @@
         "clean": "ts-node ../../scripts/clean.ts dist/ LICENSE NOTICE quickStart* README* CHANGELOG.md",
         "copyFiles": "ts-node ./scripts/build/copyFiles.ts",
         "buildScripts": "npm run generateClients && npm run generatePackage && npm run generateNonCodeFiles && npm run copyFiles",
-        "browserWatch": "npm run clean && npm run buildScripts && webpack --config webpack.browser.config.js --watch",
+        "browserWatch": "npm run clean && npm run buildScripts && webpack --config-name web --watch",
         "browserRun": "npx @vscode/test-web --open-devtools --browserOption=--disable-web-security --waitForDebugger=9222 --extensionDevelopmentPath=. .",
         "compile": "npm run clean && npm run buildScripts && webpack --mode development && npm run copyFiles",
         "watch": "npm run clean && npm run buildScripts && tsc -watch -p ./",
@@ -4257,7 +4257,7 @@
         "format": "prettier --ignore-path ../../.prettierignore --check src scripts",
         "formatfix": "prettier --ignore-path ../../.prettierignore --write src scripts",
         "lint": "ts-node ./scripts/lint/testLint.ts && npm run format",
-        "package": "ts-node ./scripts/build/package.ts",
+        "package": "ts-node ../../scripts/package.ts",
         "install-plugin": "vsce package -o aws-toolkit-vscode-test.vsix && code --install-extension aws-toolkit-vscode-test.vsix",
         "generateClients": "npm run build -w @amzn/codewhisperer-streaming && ts-node ./scripts/build/generateServiceClient.ts ",
         "generatePackage": "ts-node ./scripts/build/generateIcons.ts",

packages/toolkit/package.json

@@ -9,7 +9,7 @@
 
 const baseConfig = require('../webpack.base.config')
 const baseVueConfig = require('../webpack.vue.config')
-const baseBrowserConfig = require('./webpack.browser.config')
+const baseBrowserConfig = require('../webpack.browser.config')
 
 const config = {
     ...baseConfig,
@@ -30,7 +30,12 @@ const vueConfigs = baseVueConfig.configs.map(c => {
     }
 })
 
-// baseBrowserConfigs is set up in another file.
-const browserConfig = { ...baseBrowserConfig }
+const browserConfig = {
+    ...baseBrowserConfig,
+    entry: {
+        'src/extensionWeb': './src/extensionWeb.ts',
+        'src/testBrowser/testRunner': './src/testBrowser/testRunner.ts',
+    },
+}
 
 module.exports = [config, ...vueConfigs, browserConfig]

packages/toolkit/webpack.browser.config.js

@@ -16,15 +16,9 @@
 // 3. restore the original package.json
 //
 
-import type PackageJson from '../../package.json'
 import * as child_process from 'child_process'
 import * as fs from 'fs-extra'
-
-// Importing from `src` isn't great but it does make things simple
-import { betaUrl } from '../../src/dev/config'
-
-const packageJsonFile = './package.json'
-const webpackConfigJsFile = './webpack.base.config.js'
+import * as path from 'path'
 
 function parseArgs() {
     // Invoking this script with argument "foo":
@@ -80,7 +74,15 @@ function isRelease(): boolean {
  * Whether or not this a private beta build
  */
 function isBeta(): boolean {
-    return !!betaUrl
+    try {
+        // This path only exists for packages/toolkit.
+        // As noted before: "Importing from `src` isn't great but it does make things simple"
+        // TODO: Generalize betaUrl for all packages.
+        const betaUrl = require(path.resolve('./src/dev/config')).betaUrl
+        return !!betaUrl
+    } catch {
+        return false
+    }
 }
 
 /**
@@ -103,6 +105,14 @@ function getVersionSuffix(feature: string, debug: boolean): string {
 
 function main() {
     const args = parseArgs()
+    // It is expected that this will package from a packages/{subproject} folder.
+    // There is a base config in packages/
+    const packageJsonFile = './package.json'
+    const webpackConfigJsFile = '../webpack.base.config.js'
+    if (!fs.existsSync(packageJsonFile)) {
+        throw new Error(`package.json not found, cannot package this directory: ${process.cwd()}`)
+    }
+
     let release = true
 
     try {
@@ -113,12 +123,10 @@ function main() {
         }
 
         if (!release || args.debug) {
-            // Create backup files so we can restore the originals later.
+            // Create backup file so we can restore the originals later.
             fs.copyFileSync(packageJsonFile, `${packageJsonFile}.bk`)
-            fs.copyFileSync(webpackConfigJsFile, `${webpackConfigJsFile}.bk`)
-            fs.copyFileSync('../../CHANGELOG.md', 'CHANGELOG.md')
 
-            const packageJson: typeof PackageJson = JSON.parse(fs.readFileSync(packageJsonFile, { encoding: 'utf-8' }))
+            const packageJson = JSON.parse(fs.readFileSync(packageJsonFile, { encoding: 'utf-8' }))
             const versionSuffix = getVersionSuffix(args.feature, args.debug)
             const version = packageJson.version
             if (isBeta()) {
@@ -138,26 +146,34 @@ function main() {
             fs.writeFileSync(packageJsonFile, JSON.stringify(packageJson, undefined, '    '))
 
             if (args.debug) {
+                fs.copyFileSync(webpackConfigJsFile, `${webpackConfigJsFile}.bk`)
                 const webpackConfigJs = fs.readFileSync(webpackConfigJsFile, { encoding: 'utf-8' })
                 fs.writeFileSync(webpackConfigJsFile, webpackConfigJs.replace(/minimize: true/, 'minimize: false'))
             }
         }
+        // Always include CHANGELOG.md until we can have separate changelogs for packages
+        fs.copyFileSync('../../CHANGELOG.md', 'CHANGELOG.md')
 
         child_process.execSync(`vsce package`, { stdio: 'inherit' })
         const packageJson = JSON.parse(fs.readFileSync(packageJsonFile, { encoding: 'utf-8' }))
         console.log(`VSIX Version: ${packageJson.version}`)
 
-        const vsixName = `aws-toolkit-vscode-${packageJson.version}.vsix`
+        // Hoist .vsix to root folder, because the release infra expects it to be there.
+        // TODO: Once we can support releasing multiple artifacts,
+        // let's just keep the .vsix in its respective project folder in packages/
+        const vsixName = `${packageJson.name}-${packageJson.version}.vsix`
         fs.moveSync(vsixName, `../../${vsixName}`, { overwrite: true })
     } catch (e) {
         console.log(e)
         throw Error('package.ts: failed')
     } finally {
+        // Restore the original files.
         if (!release) {
-            // Restore the original files.
             fs.copyFileSync(`${packageJsonFile}.bk`, packageJsonFile)
-            fs.copyFileSync(`${webpackConfigJsFile}.bk`, webpackConfigJsFile)
             fs.unlinkSync(`${packageJsonFile}.bk`)
+        }
+        if (args.debug) {
+            fs.copyFileSync(`${webpackConfigJsFile}.bk`, webpackConfigJsFile)
             fs.unlinkSync(`${webpackConfigJsFile}.bk`)
         }
     }