🔀 Merge pull request #380 from richardfrost/build_improvements

Add additional release state file to preserve `.build.json`.

Author: richardfrost

.gitignore

@@ -6,6 +6,7 @@ bin/git-filters/*.js
 
 # Build state file
 /.build.json
+/.release.json
 
 # Packaged extensions
 /dist/*

README.md

@@ -10,7 +10,7 @@ A browser extension to filter profanity from webpages.
 
 For an overview of features and options, please head to the [wiki](https://github.com/richardfrost/AdvancedProfanityFilter/wiki).
 
-### Installation
+## Installation
 | Browser | Download |
 |---------|----------|
 | Chrome  | [Chrome Web Store](https://chrome.google.com/webstore/detail/advanced-profanity-filter/piajkpdbaniagacofgklljacgjhefjeh) |
@@ -22,7 +22,7 @@ For an overview of features and options, please head to the [wiki](https://githu
 | iOS/Other | [Bookmarklet Info](https://github.com/richardfrost/AdvancedProfanityFilter/wiki/Bookmarklet) |
 | TV Cast | [Instructions](https://github.com/richardfrost/AdvancedProfanityFilter/wiki/Audio#watch-on-tv) - [Discussion](https://github.com/richardfrost/AdvancedProfanityFilter/issues/206) |
 
-### Features
+## Features
 * Filter modes
     * Censor - Hide offending words
     * Substitute - Replace offensive words
@@ -44,22 +44,69 @@ For an overview of features and options, please head to the [wiki](https://githu
 
 For a detailed overview of the features and settings, please see the [Getting Started page](https://github.com/richardfrost/AdvancedProfanityFilter/wiki).
 
-### Issues, Suggestions or Feedback?
+## Issues, Suggestions or Feedback?
 * Found a bug? Please open an [issue](https://github.com/richardfrost/AdvancedProfanityFilter/issues/new).
 * Have a great idea to improve the project? Want to share some feedback? Head over [here](https://goo.gl/forms/LTqFpJ0mCTsrgGgf2).
 
-### Beta Testing
+## Beta Testing
 If you would like to help with development, but don't have experience coding, its very helpful to have users test a release candidate before actually publishing it to everyone. If you are interested in testing new versions see [this page](https://github.com/richardfrost/AdvancedProfanityFilter/wiki/Beta-Testing) for more information.
 
-### Development
-This project is written in TypeScript, and during the build/package process it will be converted to JS. Please see `package.json`'s scripts for more info on the process.
+## Development
+### Quick Start
+After downloading/cloning the repository, run the following commands to get started:
 
-Getting started
-```
+```sh
+# Install dependencies
 npm install
-```
 
-To Build the extension
-```
-npm run package
+# Build the extension for the default target browser for local development
+# See table below for supported targets
+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                                       |
+|---------|--------------------------|---------------------------------------------------|
+| 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. |
+| firefox | Firefox            |
+| safari  | Safari (MacOS/iOS) |
+
+_* = default target_
+
+### Scripts
+For all scripts, please see `package.json`.
+
+#### Commonly used scripts
+| Target  | Stage   | Script                   | Description                       |
+|---------|---------|--------------------------|-----------------------------------|
+| v3      | build   | `npm run build:v3`       | Development build for Manifest V3 |
+| v2      | build   | `npm run build:v2`       | Development build for Manifest V2 |
+| firefox | build   | `npm run build:firefox`  | Development build for Firefox     |
+| safari  | build   | `npm run build:safari`   | Development build for Safari      |
+| safari  | release | `npm run package:safari` | Official release for safari       |
+|         | release | `npm run release:all`    | Official relase for all targets   |
+
+### 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
+
+#### Details contained in state files:
+- `config`: Overrides for the target
+- `manifestVersion`: Manifest version from `src/static/manifest.json`
+- `target`: Target browser
+- `version`: Build version from `package.json`

bin/clean.mjs

@@ -12,14 +12,18 @@ const dist = [
   path.join('dist-lib'),
 ];
 
+const release = [
+  path.join('./.release.json'),
+];
+
 const test = [
   path.join('test', 'built'),
 ];
 
-function clean(folders) {
-  folders.forEach((folder) => {
-    console.log(`Cleaning ${folder}...`);
-    fse.removeSync(folder);
+function clean(items) {
+  items.forEach((item) => {
+    console.log(`Cleaning ${item}...`);
+    fse.removeSync(item);
   });
 }
 
@@ -29,26 +33,29 @@ function main() {
     // argv[1] = script (this file)
     // argv[2] = first argument
     if (process.argv.length >= 2) {
-      const args = process.argv.slice(2);
-      let folders = [];
-
+      let args = process.argv.slice(2);
       if (args.length == 0 || args.includes('--all')) {
-        folders = folders.concat(built).concat(dist).concat(test);
-      } else {
-        if (args.includes('--built')) {
-          folders = folders.concat(built);
-        }
+        args = ['--built', '--dist', '--release', '--test'];
+      }
 
-        if (args.includes('--dist')) {
-          folders = folders.concat(dist);
-        }
+      let toRemove = [];
+      if (args.includes('--built')) {
+        toRemove = toRemove.concat(built);
+      }
+
+      if (args.includes('--dist')) {
+        toRemove = toRemove.concat(dist);
+      }
+
+      if (args.includes('--release')) {
+        toRemove = toRemove.concat(release);
+      }
 
-        if (args.includes('--test')) {
-          folders = folders.concat(test);
-        }
+      if (args.includes('--test')) {
+        toRemove = toRemove.concat(test);
       }
 
-      clean(folders);
+      clean(toRemove);
     } else {
       usage();
     }
@@ -61,7 +68,10 @@ function main() {
 function usage() {
   console.log(`usage:
       npm run clean
+      npm run clean:built
       npm run clean:dist
+      npm run clean:release
+      npm run clean:test
   `);
 }
 

bin/package-extension.mjs

@@ -3,9 +3,10 @@ import fse from 'fs-extra';
 import path from 'path';
 import AdmZip from 'adm-zip';
 
+let buildData;
 const buildDataPath = path.join('.build.json');
 const dist = './dist/';
-let buildData;
+const releaseFilePath = path.join('.release.json');
 
 function buildArchive() {
   const zip = new AdmZip();
@@ -24,7 +25,13 @@ function loadJSONFile(file) {
 
 function main() {
   try {
-    buildData = loadJSONFile(buildDataPath);
+    // Load .release.json if present, otherwise load .build.json
+    if (fse.existsSync(releaseFilePath)) {
+      buildData = loadJSONFile(releaseFilePath);
+    } else {
+      buildData = loadJSONFile(buildDataPath);
+    }
+
     const zip = buildArchive();
     const packagePath = `./${zipName()}.zip`;
     console.log(`Building ${packagePath}`);

bin/package-source.mjs

@@ -7,7 +7,9 @@ import AdmZip from 'adm-zip';
 function packageSource() {
   fse.removeSync('./extension-source.zip');
   console.log('Building ./extension-source.zip');
-  console.log('Build from source: npm install && npm run package:firefox');
+  console.log('Build from source: npm install && npm run build:bookmarklet && npm run package:firefox');
+  console.log('  Unpacked: ./dist');
+  console.log('  Packed: ./extension-firefox.zip');
 
   const sourceZip = new AdmZip();
   const files = [

bin/postbuild.mjs

@@ -3,8 +3,11 @@
 import fse from 'fs-extra';
 import path from 'path';
 
+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();
@@ -56,6 +59,11 @@ function handleVersion() {
     console.log(`Updating manifest.json version (${manifest.version} -> ${buildData.version})`);
     manifest.version = buildData.version;
     writeJSONFile(manifestPath, manifest);
+
+    // Update source manfiest.json
+    const srcManifest = loadJSONFile(srcManifestPath);
+    srcManifest.version = buildData.version;
+    writeJSONFile(srcManifestPath, srcManifest);
   }
 }
 
@@ -64,7 +72,14 @@ function loadJSONFile(file) {
 }
 
 function main() {
-  buildData = loadJSONFile(buildDataPath);
+  // Load .release.json if present, otherwise load .build.json
+  if (fse.existsSync(releaseFilePath)) {
+    buildData = loadJSONFile(releaseFilePath);
+  } else {
+    buildData = loadJSONFile(buildDataPath);
+  }
+
+  // Perform postbuild actions
   common();
 
   if (buildData.target == 'firefox') {
@@ -130,5 +145,4 @@ function writeJSONFile(file, object) {
   fse.writeFileSync(file, content);
 }
 
-let buildData;
 main();

bin/prebuild.mjs

@@ -12,6 +12,7 @@ const data = {
   target: 'chrome',
   version: '1.0.0',
 };
+const releaseFilePath = path.join('.release.json');
 
 function common() {
   data.version = process.env.npm_package_version;
@@ -29,16 +30,25 @@ function main() {
   // argv[0] = process (node)
   // argv[1] = script (this file)
   // argv[2] = first argument
-  if (process.argv.length == 2 || process.argv.length == 3) {
-    const arg = process.argv.slice(2)[0];
-    // Exit if no arg passed and .build.json already exists
-    if (!arg && fse.existsSync(buildFilePath)) {
+  if (process.argv.length >= 2 && process.argv.length <= 4) {
+    const args = process.argv.slice(2);
+    const release = args.includes('--release');
+    if (release) {
+      args.splice(args.indexOf('--release'), 1);
+    } else if (fse.existsSync(releaseFilePath)) {
+      // Remove .release.json if it exists when not prepareing for a release build
+      fse.removeSync(releaseFilePath);
+    }
+    const target = args[0];
+
+    // Exit if no target was passed and .build.json already exists (preserve current build target)
+    if (!target && fse.existsSync(buildFilePath)) {
       return;
     }
 
     common();
 
-    switch (arg) {
+    switch (target) {
       case '--firefox':
         firefoxBuild();
         break;
@@ -54,7 +64,7 @@ function main() {
       default:
         defaultBuild();
     }
-    writeData();
+    writeData(release);
   } else {
     throw (new Error('Incorrect number of arguments.'));
   }
@@ -73,9 +83,10 @@ function safariBuild() {
   data.config.muteMethod = 2; // Constants.MUTE_METHODS.VIDEO_MUTE;
 }
 
-function writeData() {
+function writeData(release = false) {
+  const filePath = release ? releaseFilePath : buildFilePath;
   const content = JSON.stringify(data, null, 2);
-  fse.writeFileSync(buildFilePath, content);
+  fse.writeFileSync(filePath, content);
 }
 
 main();

package.json

@@ -29,16 +29,24 @@
     "build:v3": "node bin/prebuild.mjs --manifestV3 && npm run build",
     "build": "npm run build:static && webpack --config bin/webpack.config.js",
     "clean:dist": "node bin/clean.mjs --dist",
+    "clean:release": "node bin/clean.mjs --release",
     "clean": "node bin/clean.mjs --all",
-    "package:firefox": "npm run build:firefox && npm run package",
-    "package:v2": "npm run build:v2 && npm run package",
-    "package:v3": "npm run build:v3 && npm run package",
-    "package": "npm run build:bookmarklet && node bin/package-extension.mjs",
+    "package:firefox": "npm run clean:release && node bin/prebuild.mjs --release --firefox && npm run release:build && npm run package",
+    "package:v2": "npm run clean:release && node bin/prebuild.mjs --release --manifestV2 && npm run release:build && npm run package",
+    "package:v3": "npm run clean:release && node bin/prebuild.mjs --release --manifestV3 && npm run release:build && npm run package",
+    "package": "node bin/package-extension.mjs",
     "postbuild": "node bin/postbuild.mjs",
-    "postpackage:firefox": "node bin/package-source.mjs",
+    "postpackage": "npm run clean:release",
+    "postrelease:build": "node bin/postbuild.mjs",
+    "postrelease:firefox": "node bin/package-source.mjs",
     "prebuild": "node bin/prebuild.mjs",
-    "release": "npm run clean && npm run package:v2 && npm run package:v3 && npm run package:firefox && npm run update:bookmarklet",
-    "test:addon": "npx addons-linter ./extension-firefox.zip",
+    "release:all": "npm run clean && npm run build:bookmarklet && npm run release:v3 && npm run release:v2 && npm run release:firefox && npm run update:bookmarklet",
+    "release:build": "npm run build:static && webpack --config bin/webpack.config.js",
+    "release:firefox": "npm run package:firefox",
+    "release:safari": "npm run clean && node bin/prebuild.mjs --release --safari && npm run release:build && npm run clean:release",
+    "release:v2": "npm run package:v2",
+    "release:v3": "npm run package:v3",
+    "test:addon": "npm run package:firefox && npx addons-linter ./extension-firefox.zip",
     "test:all": "npm run test && npm run test:lint:tests",
     "test:cov": "npm run build:test && nyc --reporter=lcov --reporter=text node_modules/mocha/bin/_mocha",
     "test:debug": "node --inspect-brk node_modules/mocha/bin/_mocha --reporter tap",

src/static/manifest.json

@@ -3,7 +3,7 @@
   "short_name": "Profanity Filter",
   "author": "Richard Frost",
   "manifest_version": 3,
-  "version": "2.30.0",
+  "version": "2.31.0",
   "description": "Advanced Profanity Filter helps to clean up bad language on the websites you and your family visit.",
   "icons": {
     "16": "img/icon16.png",
@@ -46,8 +46,12 @@
   },
   "web_accessible_resources": [
     {
-      "resources": [ "audio/*.mp3" ],
-      "matches": [ "<all_urls>" ]
+      "resources": [
+        "audio/*.mp3"
+      ],
+      "matches": [
+        "<all_urls>"
+      ]
     }
   ]
-}
+}