Merge pull request #306 from richardfrost/updates

Update Dev Dependencies

Author: richardfrost

.travis.yml

@@ -2,11 +2,12 @@ language: node_js
 
 node_js:
   - "node"
-  - "15"
+  - "16"
 
 before_script:
   - npm install
   - npm run package
 
 script:
+  - npm run test:lint:all
   - npm run test:all

bin/bookmarklet.webpack.config.js

@@ -1,4 +1,5 @@
-const TerserPlugin = require("terser-webpack-plugin");
+/* eslint-disable @typescript-eslint/naming-convention */
+const TerserPlugin = require('terser-webpack-plugin'); // eslint-disable-line @typescript-eslint/no-var-requires
 
 module.exports = {
   entry: {

bin/clean.js

@@ -0,0 +1,8 @@
+/* eslint-disable no-console */
+import fse from 'fs-extra';
+
+const folders = ['./dist', './test/built', './extension', './extension-chrome', './extension-firefox'];
+folders.forEach((folder) => {
+  console.log(`Cleaning ${folder}...`);
+  fse.removeSync(folder);
+});

bin/clean.mjs

@@ -1,9 +1,6 @@
-'use strict';
+/* eslint-disable no-console */
+import fse from 'fs-extra';
 
-// eslint-disable-next-line
-const fse = require('fs-extra');
-
-// eslint-disable-next-line no-console
 console.log('Copying static assets to ./dist folder...');
 fse.copySync('./src/static', './dist');
 fse.copySync('./src/audio', './dist/audio');

bin/copy-static.js renamed to bin/copy-static.mjs

@@ -1,8 +1,7 @@
-/* eslint-disable no-console, @typescript-eslint/no-var-requires */
-'use strict';
-const fse = require('fs-extra');
-const path = require('path');
-const AdmZip = require('adm-zip');
+/* eslint-disable no-console */
+import fse from 'fs-extra';
+import path from 'path';
+import AdmZip from 'adm-zip';
 
 function buildAll() {
   build(prepareZip());
@@ -13,7 +12,7 @@ function buildAll() {
 
 function build(zip, name = '') {
   if (name) { name = '-' + name; }
-  let packagePath = `./extension${name}.zip`;
+  const packagePath = `./extension${name}.zip`;
   console.log(`Building ${packagePath}`);
   fse.removeSync(packagePath);
   zip.writeZip(packagePath);
@@ -24,21 +23,20 @@ function buildBookmarklet() {
 }
 
 function buildEdgeLegacy(manifest, zip) {
-  let packagePath = './extension-edge-legacy.zip';
+  const packagePath = './extension-edge-legacy.zip';
   console.log(`Building ${packagePath}`);
 
   if (!fse.existsSync('./store/edge')) {
     console.log('Error! Missing Edge legacy polyfills.');
     return false;
   }
 
-  let msPreload = {
+  const msPreload = {
     backgroundScript: 'backgroundScriptsAPIBridge.js',
     contentScript: 'contentScriptsAPIBridge.js'
   };
 
   // Fix options_page
-  // eslint-disable-next-line @typescript-eslint/camelcase
   manifest.options_page = manifest.options_ui.page;
   delete manifest.options_ui;
 
@@ -52,9 +50,9 @@ function buildEdgeLegacy(manifest, zip) {
 }
 
 function buildFirefox(manifest, zip) {
-  let packagePath = './extension-firefox.zip';
+  const packagePath = './extension-firefox.zip';
   console.log(`Building ${packagePath}`);
-  let firefoxManifest = {
+  const firefoxManifest = {
     applications: {
       gecko: {
         id: '{853d1586-e2ab-4387-a7fd-1f7f894d2651}'
@@ -78,8 +76,8 @@ function packageSource() {
   console.log('Building ./extension-source.zip');
   console.log('Build from source: npm install && npm run package');
 
-  let sourceZip = new AdmZip();
-  let files = [
+  const sourceZip = new AdmZip();
+  const files = [
     'LICENSE',
     'package.json',
     'package-lock.json',
@@ -89,23 +87,23 @@ function packageSource() {
   sourceZip.addLocalFolder('./bin', 'bin');
   sourceZip.addLocalFolder('./src', 'src');
   sourceZip.addLocalFolder('./test', 'test');
-  files.forEach(file => { sourceZip.addLocalFile(path.join('./', file), null); });
+  files.forEach((file) => { sourceZip.addLocalFile(path.join('./', file), null); });
   sourceZip.writeZip('./extension-source.zip');
 }
 
 function prepareZip() {
-  let zip = new AdmZip();
+  const zip = new AdmZip();
   zip.addLocalFolder(dist, null);
   return zip;
 }
 
 function updateManifestFile(file, obj) {
-  let content = JSON.stringify(obj, null, 2);
+  const content = JSON.stringify(obj, null, 2);
   fse.writeFileSync(file, content);
 }
 
 function updateManifestFileInZip(zip, obj) {
-  let content = JSON.stringify(obj, null, 2);
+  const content = JSON.stringify(obj, null, 2);
   zip.updateFile('manifest.json', Buffer.alloc(content.length, content));
 }
 
@@ -117,12 +115,12 @@ function updateManifestVersion(manifest, newVersion) {
 }
 
 function updateOptionPageVersion(newVersion) {
-  let filename = 'optionPage.html';
-  let optionPage = path.join(staticDir, filename);
-  let optionPageHTML = fse.readFileSync(optionPage).toString();
+  const filename = 'optionPage.html';
+  const optionPage = path.join(staticDir, filename);
+  const optionPageHTML = fse.readFileSync(optionPage).toString();
   let foundMatch = false;
 
-  let newOptionPageHTML = optionPageHTML.replace(/id="helpVersion">.*?<\/a>/, function(match) {
+  const newOptionPageHTML = optionPageHTML.replace(/id="helpVersion">.*?<\/a>/, function(match) {
     foundMatch = true;
     return `id="helpVersion">${newVersion}</a>`;
   });
@@ -137,9 +135,9 @@ function updateOptionPageVersion(newVersion) {
 }
 
 function updateVersions() {
-  let manifest = getManifestJSON();
+  const manifest = getManifestJSON();
   if (manifest.version != process.env.npm_package_version) {
-    let newVersion = process.env.npm_package_version;
+    const newVersion = process.env.npm_package_version;
     console.log('Version number is being updated: ' + manifest.version + ' -> ' + newVersion);
     updateManifestVersion(manifest, newVersion);
     updateOptionPageVersion(newVersion);
@@ -148,6 +146,6 @@ function updateVersions() {
 
 const dist = './dist/';
 const staticDir = './src/static/';
-let manifestPath = path.join(staticDir, 'manifest.json');
+const manifestPath = path.join(staticDir, 'manifest.json');
 updateVersions();
 buildAll();

bin/package-extension.js renamed to bin/package-extension.mjs

@@ -0,0 +1,32 @@
+/* eslint-disable no-console */
+import fse from 'fs-extra';
+import path from 'path';
+import marked from 'marked';
+import download from 'download';
+
+const readmeURI = 'https://raw.githubusercontent.com/wiki/richardfrost/AdvancedProfanityFilter/Home.md';
+const optionPage = path.join('src/static', 'optionPage.html');
+const optionPageHTML = fse.readFileSync(optionPage).toString();
+const prefix = '<div id="helpContainer">';
+const postfix = '\n  </div>';
+let foundMatch = false;
+
+console.log('Downloading Wiki...');
+download(readmeURI).then((data) => {
+  console.log('Parsing markdown...');
+  const md = data.toString();
+  const html = marked(md);
+
+  const newOptionPageHTML = optionPageHTML.replace(/<div id="helpContainer">.*?<\/div>/s, function(match) {
+    foundMatch = true;
+    let output = prefix;
+    html.split('\n').forEach((line) => { if (line.trim() != '') output += `\n    ${line}`; });
+    return output + postfix;
+  });
+  if (foundMatch) {
+    console.log('Updating Help content...');
+    fse.writeFileSync(optionPage, newOptionPageHTML);
+  } else {
+    throw `Failed to update ${optionPage}`;
+  }
+});

bin/update-help.js

@@ -1,14 +1,14 @@
-'use strict';
+/* eslint-disable no-console */
+import fse from 'fs-extra';
+import path from 'path';
+import chokidar from 'chokidar';
+import { execSync } from 'child_process';
 
-const chokidar = require('chokidar');
-const execSync = require('child_process').execSync;
-const path = require('path');
-const fse = require('fs-extra');
-let scriptRegExp = new RegExp('\/script\/');
-let staticRegExp = new RegExp('\/static\/');
+const scriptRegExp = new RegExp('\/script\/');
+const staticRegExp = new RegExp('\/static\/');
 
 function copyStatic(file) {
-  let basename = path.basename(file);
+  const basename = path.basename(file);
   console.log('Copying static file: ', basename);
   fse.copySync(file, path.join('./dist/', basename));
 
@@ -20,8 +20,8 @@ function copyStatic(file) {
 }
 
 function compileScript(file) {
-  let basename = path.basename(file);
-  console.log('TypeScript file updated: ', basename)
+  const basename = path.basename(file);
+  console.log('TypeScript file updated: ', basename);
 
   try {
     console.log('Building Typescript...');
@@ -32,7 +32,7 @@ function compileScript(file) {
   }
 }
 
-let watcher = chokidar.watch(
+const watcher = chokidar.watch(
   [
     path.join(process.cwd() + '/src/**/*.ts'),
     path.join(process.cwd() + '/src/static/**/*.(css|html|json|)')
@@ -42,7 +42,7 @@ let watcher = chokidar.watch(
   }
 );
 
-let log = console.log.bind(console);
+const log = console.log.bind(console);
 // watcher.on('add', filePath => log(`File ${filePath} has been added`))
 // watcher.on('unlink', filePath => log(`File ${filePath} has been removed`));
 watcher.on('ready', () => log('Initial scan complete. Watching for changes...\n\n'));
@@ -51,4 +51,4 @@ watcher.on('change', (filePath, stats) => {
   // console.log(filePath, stats);
   if (scriptRegExp.test(filePath)) { compileScript(filePath); }
   if (staticRegExp.test(filePath)) { copyStatic(filePath); }
-});
+});