🔀 Merge pull request #382 from richardfrost/more_build_fixes

Keep separate dev and release build states

Author: richardfrost

.gitignore

@@ -4,9 +4,8 @@
 # Ignore git-filter scripts (clean/smudge)
 bin/git-filters/*.js
 
-# Build state file
-/.build.json
-/.release.json
+# Build state files
+/.build.*json
 
 # Packaged extensions
 /dist/*

README.md

@@ -66,17 +66,17 @@ npm run build
 Once the extension has been built, you can load the unpacked extension (found in `dist/`) in your browser.
 
 ### Stages
-| Stage   | Output                   | Description                                       |
-|---------|--------------------------|---------------------------------------------------|
+| Stage   | Output                 | Description                                       |
+|---------|------------------------|---------------------------------------------------|
 | build   | `dist/`                | Build/compile the extension for local development |
 | package | `extension-target.zip` | Package the files for the target browser          |
 | release | `extension-target.zip` | Create an official release for a target browser   |
 
 ### Targets
 | Target  | Browser            |
 |---------|--------------------|
-| v3*     | Chrome, Edge, etc. |
-| v2      | Chrome, Edge, etc. |
+| v3      | Chrome, Edge, etc. |
+| v2*     | Chrome, Edge, etc. |
 | firefox | Firefox            |
 | safari  | Safari (MacOS/iOS) |
 
@@ -97,13 +97,15 @@ For all scripts, please see `package.json`.
 
 ### State files
 The state files hold the details about the current build. These files are managed by `bin/prebuild.mjs`.
-
 - `.build.json`
-  - Current development target details
-  - This is used for active development, and allows the developer to run simple commands such as `npm run build` to rebuild the project for the target specified in the file
-- `.release.json`
-  - Current release target details
-  - Takes precedence over `.build.json`, but gets removed after release is finished
+  - Active build state file that is referenced when building/packaging/releasing
+  - Gets replaced by the dev or release build files outlined below
+- `.build.dev.json`
+  - Holds the development build details and allows the developer to omit the target from commands such as `npm run build` to rebuild the project for the target specified in the file
+  - Overwrites `.build.json` when `--release` is **not** passed to `bin/prebuild.mjs`
+- `.build.release.json`
+  - Holds the release build details
+  - Overwrites `.build.json` when `--release` **is** passed to `bin/prebuild.mjs`
 
 #### Details contained in state files:
 - `config`: Overrides for the target

bin/clean.mjs

@@ -1,6 +1,6 @@
 /* eslint-disable no-console */
-import fse from 'fs-extra';
 import path from 'path';
+import { parseArgv, removeFiles } from './lib.mjs';
 
 const built = [
   path.join('extension'),
@@ -12,50 +12,32 @@ const dist = [
   path.join('dist-lib'),
 ];
 
-const release = [
-  path.join('./.release.json'),
-];
-
 const test = [
   path.join('test', 'built'),
 ];
 
-function clean(items) {
-  items.forEach((item) => {
-    console.log(`Cleaning ${item}...`);
-    fse.removeSync(item);
-  });
-}
-
 function main() {
   try {
-    // argv[0] = process (node)
-    // argv[1] = script (this file)
-    // argv[2] = first argument
-    if (process.argv.length >= 2) {
-      let args = process.argv.slice(2);
-      if (args.length == 0 || args.includes('--all')) {
-        args = ['--built', '--dist', '--release', '--test'];
+    const argv = parseArgv(process.argv);
+    if (argv.count >= 2) {
+      if (argv.arguments.length == 0 || argv.arguments.includes('--all')) {
+        argv.arguments = ['--built', '--dist', '--test'];
       }
 
       let toRemove = [];
-      if (args.includes('--built')) {
+      if (argv.arguments.includes('--built')) {
         toRemove = toRemove.concat(built);
       }
 
-      if (args.includes('--dist')) {
+      if (argv.arguments.includes('--dist')) {
         toRemove = toRemove.concat(dist);
       }
 
-      if (args.includes('--release')) {
-        toRemove = toRemove.concat(release);
-      }
-
-      if (args.includes('--test')) {
+      if (argv.arguments.includes('--test')) {
         toRemove = toRemove.concat(test);
       }
 
-      clean(toRemove);
+      removeFiles(toRemove);
     } else {
       usage();
     }
@@ -70,7 +52,6 @@ function usage() {
       npm run clean
       npm run clean:built
       npm run clean:dist
-      npm run clean:release
       npm run clean:test
   `);
 }

bin/lib.mjs

@@ -0,0 +1,42 @@
+import fse from 'fs-extra';
+import path from 'path';
+
+// Paths are relative from the project root
+// Should be correct when running with `npm run ...`
+export const buildFilePath = path.join('.build.json');
+export const devBuildFilePath = path.join('.build.dev.json');
+export const distManifestPath = path.join('dist', 'manifest.json');
+export const releaseBuildFilePath = path.join('.build.release.json');
+export const srcManifestPath = path.join('src', 'static', 'manifest.json');
+
+export function loadJSONFile(file) {
+  return JSON.parse(fse.readFileSync(file));
+}
+
+export function parseArgv(argv) {
+  const parsed = {};
+  parsed.count = argv.length;
+  parsed.process = argv[0]; // process (node)
+  parsed.script = argv[1]; // script
+  parsed.arguments = argv.slice(2);
+  return parsed;
+}
+
+export function removeFiles(files, silent = false) {
+  if (typeof files === 'string') {
+    files = [files];
+  }
+
+  files.forEach((file) => {
+    if (!silent) {
+      // eslint-disable-next-line no-console
+      console.log(`Removing ${file}`);
+    }
+    fse.removeSync(file);
+  });
+}
+
+export function writeJSONFile(file, object) {
+  const content = JSON.stringify(object, null, 2);
+  fse.writeFileSync(file, content);
+}

bin/package-extension.mjs

@@ -1,41 +1,24 @@
 /* eslint-disable no-console */
-import fse from 'fs-extra';
-import path from 'path';
 import AdmZip from 'adm-zip';
+import { buildFilePath, loadJSONFile, removeFiles } from './lib.mjs';
 
 let buildData;
-const buildDataPath = path.join('.build.json');
 const dist = './dist/';
-const releaseFilePath = path.join('.release.json');
 
 function buildArchive() {
   const zip = new AdmZip();
   zip.addLocalFolder(dist, null);
   return zip;
 }
 
-function loadJSONFile(file) {
-  try {
-    return JSON.parse(fse.readFileSync(file));
-  } catch (err) {
-    console.error(err.message);
-    throw err;
-  }
-}
-
 function main() {
   try {
-    // Load .release.json if present, otherwise load .build.json
-    if (fse.existsSync(releaseFilePath)) {
-      buildData = loadJSONFile(releaseFilePath);
-    } else {
-      buildData = loadJSONFile(buildDataPath);
-    }
+    buildData = loadJSONFile(buildFilePath);
 
     const zip = buildArchive();
     const packagePath = `./${zipName()}.zip`;
+    removeFiles(packagePath, true);
     console.log(`Building ${packagePath}`);
-    fse.removeSync(packagePath);
     zip.writeZip(packagePath);
   } catch (err) {
     console.error(err.message);

bin/package-source.mjs

@@ -1,13 +1,13 @@
 /* eslint-disable no-console */
-import fse from 'fs-extra';
 import Path from 'path';
 import AdmZip from 'adm-zip';
+import { removeFiles } from './lib.mjs';
 
-// Required due to bundled code
+// Required for Firefox due to bundled code
 function packageSource() {
-  fse.removeSync('./extension-source.zip');
+  removeFiles('./extension-source.zip', true);
   console.log('Building ./extension-source.zip');
-  console.log('Build from source: npm install && npm run build:bookmarklet && npm run package:firefox');
+  console.log('Build from source: npm install && npm run package:bookmarklet && npm run package:firefox');
   console.log('  Unpacked: ./dist');
   console.log('  Packed: ./extension-firefox.zip');
 

bin/postbuild.mjs

@@ -2,32 +2,36 @@
 /* eslint-disable no-console */
 import fse from 'fs-extra';
 import path from 'path';
+import {
+  buildFilePath,
+  distManifestPath,
+  loadJSONFile,
+  removeFiles,
+  srcManifestPath,
+  writeJSONFile
+} from './lib.mjs';
 
 let buildData;
-const buildDataPath = path.join('.build.json');
-const manifestPath = path.join('dist', 'manifest.json');
-const releaseFilePath = path.join('.release.json');
-const srcManifestPath = path.join('src', 'static', 'manifest.json');
 
 function common() {
   handleManifestVersion();
   handleVersion();
 }
 
 function firefoxBuild() {
-  const manifest = loadJSONFile(manifestPath);
+  const manifest = loadJSONFile(distManifestPath);
   manifest.applications = {
     gecko: {
       id: '{853d1586-e2ab-4387-a7fd-1f7f894d2651}'
     }
   };
   manifest.background.persistent = true; // Event pages are not currently supported.
-  writeJSONFile(manifestPath, manifest);
+  writeJSONFile(distManifestPath, manifest);
 }
 
 function handleManifestVersion() {
   if (buildData.manifestVersion == 2) {
-    const manifest = loadJSONFile(manifestPath);
+    const manifest = loadJSONFile(distManifestPath);
     manifest.action = undefined;
     manifest.manifest_version = buildData.manifestVersion;
     manifest.options_ui = {
@@ -48,17 +52,17 @@ function handleManifestVersion() {
       default_title: 'Advanced Profanity Filter',
     };
     manifest.web_accessible_resources = ['audio/*.mp3'];
-    writeJSONFile(manifestPath, manifest);
+    writeJSONFile(distManifestPath, manifest);
   }
 }
 
 function handleVersion() {
-  const manifest = loadJSONFile(manifestPath);
+  const manifest = loadJSONFile(distManifestPath);
 
   if (manifest.version != buildData.version) {
     console.log(`Updating manifest.json version (${manifest.version} -> ${buildData.version})`);
     manifest.version = buildData.version;
-    writeJSONFile(manifestPath, manifest);
+    writeJSONFile(distManifestPath, manifest);
 
     // Update source manfiest.json
     const srcManifest = loadJSONFile(srcManifestPath);
@@ -67,17 +71,8 @@ function handleVersion() {
   }
 }
 
-function loadJSONFile(file) {
-  return JSON.parse(fse.readFileSync(file));
-}
-
 function main() {
-  // Load .release.json if present, otherwise load .build.json
-  if (fse.existsSync(releaseFilePath)) {
-    buildData = loadJSONFile(releaseFilePath);
-  } else {
-    buildData = loadJSONFile(buildDataPath);
-  }
+  buildData = loadJSONFile(buildFilePath);
 
   // Perform postbuild actions
   common();
@@ -91,17 +86,6 @@ function main() {
   }
 }
 
-function removeFiles(files) {
-  if (typeof files === 'string') {
-    files = [files];
-  }
-
-  files.forEach((file) => {
-    console.log(`Removing ${file}`);
-    fse.removeSync(file);
-  });
-}
-
 function removeOptionPageBookmarklet() {
   console.log("Removing Bookmarklet tab from Option's page");
   const optionPage = path.join('dist', 'optionPage.html');
@@ -140,9 +124,4 @@ function safariBuild() {
   removeFiles(files);
 }
 
-function writeJSONFile(file, object) {
-  const content = JSON.stringify(object, null, 2);
-  fse.writeFileSync(file, content);
-}
-
 main();