browser-extension-manager 1.2.7 → 1.2.8

package/dist/gulp/tasks/package.js

@@ -301,6 +301,65 @@ async function packageZip() {
   }
 }
 
+// Create source code zip for Firefox review
+async function packageSource() {
+  const { template } = require('node-powertools');
+  const os = require('os');
+
+  // Log
+  logger.log(`Zipping source code...`);
+
+  try {
+    const sourceZipPath = 'packaged/source.zip';
+
+    // Only in build mode
+    if (!Manager.isBuildMode()) {
+      logger.log(`Skipping source zip (not in build mode)`);
+      return;
+    }
+
+    // Remove existing zip if it exists
+    jetpack.remove(sourceZipPath);
+
+    // Get system info
+    const platform = os.platform();
+    const platformName = {
+      darwin: 'macOS',
+      win32: 'Windows',
+      linux: 'Linux',
+    }[platform] || platform;
+
+    // Read template and replace variables
+    const templatePath = path.join(rootPathPackage, 'dist', 'gulp', 'templates', 'BUILD_INSTRUCTIONS.md');
+    const templateContent = jetpack.read(templatePath);
+    const instructions = template(templateContent, {
+      system: {
+        platform: platformName,
+        release: os.release(),
+        arch: os.arch(),
+        nodeVersion: process.version,
+      },
+    });
+
+    // Write instructions to project root temporarily
+    const instructionsPath = path.join(process.cwd(), 'BUILD_INSTRUCTIONS.md');
+    jetpack.write(instructionsPath, instructions);
+
+    // Create source zip using git archive (respects .gitignore)
+    await execute(`git archive --format=zip --output=${sourceZipPath} HEAD`);
+
+    // Add BUILD_INSTRUCTIONS.md to the zip
+    await execute(`zip -u ${sourceZipPath} BUILD_INSTRUCTIONS.md`);
+
+    // Clean up temp file
+    jetpack.remove(instructionsPath);
+
+    logger.log(`Source code zip created at ${sourceZipPath}`);
+  } catch (e) {
+    logger.error(`Error zipping source code`, e);
+  }
+}
+
 function liveReload() {
   // Log
   logger.log('Reloading live server clients...');
@@ -349,6 +408,9 @@ async function packageFn(complete) {
     // Run packageZip
     await packageZip();
 
+    // Run packageSource
+    await packageSource();
+
     // Run build:post hook
     await hook('build:post', index);
 

package/dist/gulp/templates/BUILD_INSTRUCTIONS.md

@@ -0,0 +1,47 @@
+# Build Instructions
+
+This document provides instructions for building the extension from source code.
+
+## System Requirements
+
+This extension was built on the following system:
+- **Operating System:** { system.platform } { system.release } ({ system.arch })
+- **Node.js Version:** { system.nodeVersion }
+
+## Prerequisites
+
+1. Install Node.js { system.nodeVersion } or compatible version
+2. Install npm (comes with Node.js)
+
+## Build Steps
+
+1. Extract the source code zip
+2. Open a terminal and navigate to the extracted directory
+3. Install dependencies:
+```sh
+npm install
+```
+4. Build the extension:
+```sh
+npm run build
+```
+5. The built extension will be in `packaged/raw/` directory
+6. The packaged zip will be at `packaged/extension.zip`
+
+## Loading the Extension
+
+### Firefox
+1. Go to `about:debugging`
+2. Click "This Firefox"
+3. Click "Load Temporary Add-on"
+4. Select `packaged/raw/manifest.json`
+
+### Chrome
+1. Go to `chrome://extensions`
+2. Enable "Developer mode"
+3. Click "Load unpacked"
+4. Select the `packaged/raw/` directory
+
+## Questions
+
+If you have any questions about the build process, please contact the developer.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "browser-extension-manager",
-  "version": "1.2.7",
+  "version": "1.2.8",
   "description": "Browser Extension Manager dependency manager",
   "main": "dist/index.js",
   "exports": {