Move build scripts into their own directory

Author: ChrisRegado

.github/workflows/browser-extension-build.yml

@@ -44,7 +44,7 @@ jobs:
       - name: Get version from git tag
         id: get-version
         run: |
-          VERSION=$(node get-version.js)
+          VERSION=$(npm run --silent get-version)
           if [[ -z "$VERSION" ]]; then
             echo "❌ Version extraction failed"
             exit 1

README.md

@@ -197,6 +197,7 @@ We have the following commands:
 * `npm run package-all`: Convenience command to run `npm run build`, `npm run package-chrome`, and `npm run package-firefox`. Intended for use when running locally.
 * `npm run dev-firefox`: Builds the extension and launches a Firefox window that has the extension temporarily installed, to help with testing during development. Intended for use when running locally.
 * `npm run lint-firefox`: Performs some of the same basic validations that the Firefox Add-on Hub enforces. Used to validate the addon before submitting it to Mozilla for signing. Runs both locally and in CI jobs.
+* `npm run get-version`: Tries to determine the target version number of browser extension builds. If the current git SHA is tagged with our semantic versioning scheme (`v1.2.3`), outputs that number without the `v` prefix (`1.2.3`) as the desired version. Otherwise falls back to using the version defined in `package.json`. Intended to be used in CI jobs.
 
 ## Contributing
 

browser-extension/clean.js

@@ -3,14 +3,15 @@
   "version": "0.0.1",
   "description": "Browser extensions for the Stream Deck Google Meet plugin",
   "scripts": {
-    "build": "node build.js",
-    "clean": "node clean.js",
-    "package-chrome": "node package-chrome.js",
+    "build": "node scripts/build.js",
+    "clean": "node scripts/clean.js",
+    "package-chrome": "node scripts/package-chrome.js",
     "package-firefox": "web-ext build --source-dir=build/firefox --artifacts-dir=build --filename=firefox-extension.zip --overwrite-dest",
     "sign-firefox": "web-ext sign --channel=unlisted --source-dir=build/firefox --artifacts-dir=build",
     "package-all": "npm run build && npm run package-chrome && npm run package-firefox",
     "lint-firefox": "web-ext lint --source-dir=build/firefox",
-    "dev-firefox": "npm run build && web-ext run --source-dir=build/firefox --browser-console --start-url https://meet.google.com/"
+    "dev-firefox": "npm run build && web-ext run --source-dir=build/firefox --browser-console --start-url https://meet.google.com/",
+    "get-version": "node scripts/get-version.js"
   },
   "devDependencies": {
     "web-ext": "^8.9.0"

browser-extension/package.json

@@ -0,0 +1,3 @@
+This directory contains scripts used during development or in CI jobs.
+
+Nothing in this directory should be referenced during runtime of the browser extension.

browser-extension/scripts/README.md

@@ -1,16 +1,12 @@
 const fs = require('fs');
 const path = require('path');
 const { getVersion } = require('./get-version');
+const { buildDir, chromeDir, firefoxDir, projectRoot } = require('./directories');
 
 // Get version from git tag
 const version = getVersion();
 console.log(`Using version: ${version}`);
 
-// These directories are where we'll output our build artifacts:
-const buildDir = path.join(__dirname, 'build');
-const chromeDir = path.join(buildDir, 'chrome');
-const firefoxDir = path.join(buildDir, 'firefox');
-
 // Ensure build directories exist
 if (!fs.existsSync(buildDir)) fs.mkdirSync(buildDir);
 if (!fs.existsSync(chromeDir)) fs.mkdirSync(chromeDir);
@@ -70,14 +66,14 @@ copyFiles(sourceFilesInManifest, firefoxDir);
 
 // Copy and update manifest files with dynamic version
 updateManifestVersion(
-  path.join(__dirname, 'manifest.json'),
+  path.join(projectRoot, 'manifest.json'),
   path.join(chromeDir, 'manifest.json'),
   version
 );
 // For Firefox, we use our Chrome manifest as a base and inject Firefox-specific fields
 renderFirefoxManifest(
-  path.join(__dirname, 'manifest.json'),
-  path.join(__dirname, 'manifest_firefox_stub.json'),
+  path.join(projectRoot, 'manifest.json'),
+  path.join(projectRoot, 'manifest_firefox_stub.json'),
   path.join(firefoxDir, 'manifest.json'),
   version
 );

browser-extension/build.js browser-extension/scripts/build.jsbrowser-extension/build.js renamed to browser-extension/scripts/build.js

@@ -0,0 +1,27 @@
+/**
+ * A platform-agnostic script to clean out old build artifacts.
+ */
+
+const fs = require('fs');
+const path = require('path');
+const { projectRoot } = require('./directories');
+
+// Which files/folders to delete, relative to the browser extension project root (where package.json is).
+const PATHS_TO_DELETE = [
+    "build"
+]
+
+function deleteRecursive(pathToDelete) {
+  if (fs.existsSync(pathToDelete)) {
+    console.log(`Deleting "${pathToDelete}"...`);
+    fs.rmSync(pathToDelete, { recursive: true });
+  }
+}
+
+console.log('Cleaning browser-extension working tree...');
+
+PATHS_TO_DELETE.forEach((pathToDelete) => {
+    deleteRecursive(path.join(projectRoot, pathToDelete));
+});
+
+console.log('Successfully cleaned working tree!');

browser-extension/scripts/clean.js

@@ -0,0 +1,25 @@
+/**
+ * Define important build paths that are shared across build scripts.
+ */
+
+const path = require('path');
+
+// The root of the project, i.e. where package.json lives.
+const projectRoot = path.join(__dirname, '..');
+
+// The directory to which we write all build artifacts.
+const buildDir = path.join(projectRoot, 'build');
+
+// Where our built artifacts for Chrome get written.
+const chromeDir = path.join(buildDir, 'chrome');
+
+// Where our built artifacts for Firefox get written.
+const firefoxDir = path.join(buildDir, 'firefox');
+
+// Export for use in other scripts
+module.exports = {
+    buildDir,
+    chromeDir,
+    firefoxDir,
+    projectRoot
+};

browser-extension/scripts/directories.js

@@ -1,6 +1,7 @@
 const { execSync } = require('child_process');
 const fs = require('fs');
 const path = require('path');
+const { projectRoot } = require('./directories');
 
 function getVersion() {
   try {
@@ -15,7 +16,7 @@ function getVersion() {
   } catch (error) {
     // Fallback to package.json version
     console.warn('Warning: No git tags found. Using package.json version.');
-    const packageJson = JSON.parse(fs.readFileSync(path.join(__dirname, 'package.json'), 'utf8'));
+    const packageJson = JSON.parse(fs.readFileSync(path.join(projectRoot, 'package.json'), 'utf8'));
     return packageJson.version;
   }
 }

browser-extension/get-version.js browser-extension/scripts/get-version.jsbrowser-extension/get-version.js renamed to browser-extension/scripts/get-version.js

@@ -1,9 +1,8 @@
 const fs = require('fs');
 const path = require('path');
 const { execSync } = require('child_process');
+const { buildDir, chromeDir } = require('./directories');
 
-const buildDir = path.join(__dirname, 'build');
-const chromeDir = path.join(buildDir, 'chrome');
 const outputFile = path.join(buildDir, 'chrome-extension.zip');
 
 // Check if chrome build directory exists
@@ -21,21 +20,21 @@ try {
   // Try to use zip command first (available on Linux and macOS)
   if (process.platform !== 'win32') {
     console.log('📦 Creating Chrome extension zip with zip command...');
-    execSync('zip -r ../chrome-extension.zip *', { 
+    execSync('zip -r ../chrome-extension.zip *', {
       cwd: chromeDir,
-      stdio: 'inherit' 
+      stdio: 'inherit'
     });
   } else {
     // On Windows, use PowerShell
     console.log('📦 Creating Chrome extension zip with PowerShell...');
-    execSync('powershell -Command "Compress-Archive -Path * -DestinationPath ../chrome-extension.zip -Force"', { 
+    execSync('powershell -Command "Compress-Archive -Path * -DestinationPath ../chrome-extension.zip -Force"', {
       cwd: chromeDir,
-      stdio: 'inherit' 
+      stdio: 'inherit'
     });
   }
-  
+
   console.log('✅ Chrome extension packaged successfully: build/chrome-extension.zip');
 } catch (error) {
   console.error('❌ Failed to create Chrome extension zip:', error.message);
   process.exit(1);
-} 
+}