browser-extension-manager 0.0.1

package/dist/defaults/_.gitignore

@@ -0,0 +1,71 @@
+.DS_Store
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+firebase-debug.log*
+
+# Firebase cache
+.firebase/
+
+# Firebase config
+
+# Uncomment this if you'd like others to create their own Firebase project.
+# For a team working on the same Firebase project(s), it is recommended to leave
+# it commented so all members can deploy to the same project(s) in .firebaserc.
+.firebaserc
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
+.grunt
+
+# Bower dependency directory (https://bower.io/)
+bower_components
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (http://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+
+# Custom
+/dist
+/packaged
+/.temp

package/dist/defaults/hooks/build:post.js

@@ -0,0 +1,8 @@
+// Libraries
+const Manager = new (require('browser-extension-manager/build'));
+const logger = Manager.logger('build:post');
+
+// Hook
+module.exports = async (index) => {
+  logger.log('Running with index =', index);
+}

package/dist/defaults/hooks/build:pre.js

@@ -0,0 +1,8 @@
+// Libraries
+const Manager = new (require('browser-extension-manager/build'));
+const logger = Manager.logger('build:pre');
+
+// Hook
+module.exports = async (index) => {
+  logger.log('Running with index =', index);
+}

package/dist/defaults/src/_locales/en/messages.json

@@ -0,0 +1,14 @@
+{
+  appName: {
+    message: 'Ultimate Browser Extension - Browser Enhancer',
+    description: 'The name of the extension.',
+  },
+  appDescription: {
+    message: 'Ultimate Browser Extension - A powerful tool to enhance your browsing experience.',
+    description: 'The description of the extension.',
+  },
+  btnTooltip: {
+    message: 'Ultimate Browser Extension',
+    description: 'Tooltip for the button.',
+  },
+}

package/dist/defaults/src/assets/css/content.scss

@@ -0,0 +1,2 @@
+// content.scss
+// This file contains the styles for the content script of the extension.

package/dist/defaults/src/assets/css/options.scss

@@ -0,0 +1,2 @@
+// options.scss
+// This file contains the styles for the options page of the extension.

package/dist/defaults/src/assets/css/popup.scss

@@ -0,0 +1,2 @@
+// popup.scss
+// This file contains the styles for the popup page of the extension.

package/dist/defaults/src/assets/js/background.js

@@ -0,0 +1,11 @@
+// Init service worker
+const serviceWorker = self;
+
+// Import the Ultimate Extension Manager
+const Manager = new (require('browser-extension-manager/background'));
+
+// Initialize
+Manager.initialize()
+.then(() => {
+  Manager.log('Initialized');
+});

package/dist/defaults/src/assets/js/content.js

@@ -0,0 +1,8 @@
+// Import the Ultimate Extension Manager
+const Manager = new (require('browser-extension-manager/content'));
+
+// Initialize
+Manager.initialize()
+.then(() => {
+  Manager.log('Initialized');
+});

package/dist/defaults/src/assets/js/popup.js

@@ -0,0 +1,7 @@
+// Import the Ultimate Extension Manager
+const Manager = new (require('browser-extension-manager'));
+
+// Initialize
+Manager.initialize(() => {
+  console.log('Initialized');
+})

package/dist/defaults/src/manifest.json

@@ -0,0 +1,86 @@
+{
+  // Basic info
+  version: '1.0.0',
+  name: '__MSG_appName__',
+  description: '__MSG_appDescription__',
+
+  // Background script
+  background: {
+    service_worker: 'assets/js/background.bundle.js',
+  },
+
+  // Permissions
+  permissions: [
+    // 'tabs',
+    // 'storage',
+    // 'activeTab',
+    // 'scripting',
+  ],
+  host_permissions: [
+    // 'http://*/*',
+    // 'https://*/*',
+  ],
+
+  // Options page
+  options_ui: {
+    page: 'pages/options.html',
+  },
+
+  // Content scripts
+  content_scripts: [
+    // {
+    //   matches: [
+    //     'http://*/*',
+    //     'https://*/*',
+    //   ],
+    //   js: [
+    //     'assets/js/content.bundle.js',
+    //   ],
+    //   css: [
+    //     'assets/css/content.bundle.css',
+    //   ],
+    //   run_at: 'document_end',
+    //   all_frames: false,
+    // },
+  ],
+
+  // Browser action
+  action: {
+    default_title: '__MSG_appName__',
+    default_popup: 'pages/popup.html',
+  },
+
+  // Content security policy
+  content_security_policy: {
+    extension_pages: "script-src 'self'; object-src 'self'; worker-src 'self';",
+  },
+
+  // Web accessible resources
+  externally_connectable: {
+    matches: [
+    ],
+  },
+
+  // Web accessible resources
+  web_accessible_resources: [
+    // {
+    //   matches: [
+    //     '<all_urls>',
+    //   ],
+    //   resources: [
+    //     'assets/styles/content.bundle.css',
+    //   ],
+    // },
+  ],
+
+  // Commands
+  commands: {
+  },
+
+  // Sandbox
+  sandbox: {
+    pages: [
+      // 'pages/sandbox.html',
+    ],
+  },
+}

package/dist/defaults/src/pages/options.html

@@ -0,0 +1,21 @@
+<!doctype html>
+<html>
+  <head>
+    <meta charset="utf-8">
+    <link href="/assets/css/options.bundle.css" rel="stylesheet">
+    <meta name="viewport" content="width=device-width,initial-scale=1">
+    <title>Options & Settings</title>
+  </head>
+  <body class="wrap">
+    <footer class="main-footer">
+      <div class="grid">
+        <div class="unit whole center-on-mobiles">
+          <p class="text-center text-muted">
+            &copy; <a href="">ITW Creative Works</a> <span class="wm-year"></span>.
+          </p>
+        </div>
+      </div>
+    </footer>
+    <script src="/assets/css/options.bundle.js"></script>
+  </body>
+</html>

package/dist/defaults/src/pages/popup.html

@@ -0,0 +1,21 @@
+<!doctype html>
+<html>
+  <head>
+    <meta charset="utf-8">
+    <link href="/assets/css/popup.bundle.css" rel="stylesheet">
+    <meta name="viewport" content="width=device-width,initial-scale=1">
+    <title>Popup</title>
+  </head>
+  <body class="wrap">
+    <footer class="main-footer">
+      <div class="grid">
+        <div class="unit whole center-on-mobiles">
+          <p class="text-center text-muted">
+            &copy; <a href="">ITW Creative Works</a> <span class="wm-year"></span>.
+          </p>
+        </div>
+      </div>
+    </footer>
+    <script src="/assets/css/popup.bundle.js"></script>
+  </body>
+</html>

package/dist/gulp/main.js

@@ -0,0 +1,50 @@
+// Libraries
+const Manager = new (require('../build.js'));
+const logger = Manager.logger('main');
+const argv = Manager.getArguments();
+const { series, parallel, watch } = require('gulp');
+const path = require('path');
+const jetpack = require('fs-jetpack');
+
+// Log
+logger.log('Starting...', argv);
+
+// Load tasks
+const tasks = jetpack.list(path.join(__dirname, 'tasks'));
+
+// Init global
+global.tasks = {};
+global.browserSync = null;
+
+// Load tasks
+tasks.forEach((file) => {
+  const name = file.replace('.js', '');
+
+  // Log
+  logger.log('Loading task:', name);
+
+  // Export task
+  exports[name] = require(path.join(__dirname, 'tasks', file));
+});
+
+// Set global variable to access tasks in other files
+global.tasks = exports;
+
+// Define build process
+exports.build = series(
+  // exports.setup,
+  // exports.clean,
+  exports.distribute,
+  parallel(exports.sass, exports.webpack, exports.icons),
+  exports.package,
+);
+
+// Compose task scheduler
+exports.default = series(
+  // exports.setup,
+  // exports.clean,
+  exports.serve,
+  exports.build,
+  exports.developmentRebuild,
+  // exports.watcher,
+);

package/dist/gulp/plugins/webpack/replace.js

@@ -0,0 +1,52 @@
+// Plugin
+class ReplacePlugin {
+  constructor(replacements) {
+    this.replacements = this.flatten(replacements)
+  }
+
+  flatten(obj, prefix = '') {
+    let result = {}
+    for (let key in obj) {
+      let value = obj[key]
+      let path = prefix ? `${prefix}.${key}` : key
+      if (typeof value === 'object' && value !== null) {
+        Object.assign(result, this.flatten(value, path))
+      } else {
+        result[`{ ${path} }`] = value
+      }
+    }
+    return result
+  }
+
+  apply(compiler) {
+    compiler.hooks.compilation.tap('ReplacePlugin', (compilation) => {
+      compilation.hooks.processAssets.tap(
+        {
+          name: 'ReplacePlugin',
+          stage: compilation.PROCESS_ASSETS_STAGE_OPTIMIZE,
+        },
+        (assets) => {
+          for (const filename in assets) {
+            if (filename.endsWith('.js')) {
+              let asset = assets[filename]
+              let content = asset.source()
+
+              for (const [placeholder, replacement] of Object.entries(this.replacements)) {
+                const regex = new RegExp(placeholder.replace(/[-\/\\^$*+?.()|[\]{}]/g, '\\$&'), 'g')
+                content = content.replace(regex, replacement)
+              }
+
+              compilation.updateAsset(
+                filename,
+                new compiler.webpack.sources.RawSource(content)
+              )
+            }
+          }
+        }
+      )
+    })
+  }
+}
+
+// Export
+module.exports = ReplacePlugin

package/dist/gulp/tasks/developmentRebuild.js

@@ -0,0 +1,94 @@
+// Libraries
+const Manager = new (require('../../build.js'));
+const logger = Manager.logger('development-rebuild');
+const { src, dest, watch, series } = require('gulp');
+const path = require('path');
+const { execute } = require('node-powertools');
+
+// Load package
+const package = Manager.getPackage('main');
+const project = Manager.getPackage('project');
+
+// Glob
+const input = [
+  // Files to include
+  // `${__dirname}/../../defaults/dist/**/*`,
+  `${path.join(__dirname, '..', '..', 'defaults/dist')}/**/*`,
+
+  // Files to exclude
+];
+const output = 'dist';
+const delay = 250;
+
+// Index
+let index = -1;
+
+// SASS Compilation Task
+async function developmentRebuild(complete) {
+  // Increment index
+  index++;
+
+  // Log
+  logger.log('Starting...');
+
+  // Skip first run
+  if (index === 0 && false) {
+    logger.log('Skipping first run');
+    return complete();
+  }
+
+  // Execute uj setup again
+  const checks = [
+    '--check-manager=false',
+    '--check-node=false',
+    '--check-peer-dependencies=false',
+    '--setup-scripts=false',
+    '--build-site-files=true',
+    '--build-site-files-input="dist/**/*"',
+    '--check-locality=false',
+  ];
+
+  // Execute
+  await execute(`npx bxm setup ${checks.join(' ')}`, { log: true });
+
+  // Log
+  logger.log('Finished!');
+
+  // Complete
+  return complete();
+
+  // Compile
+  // return src(input)
+  //   .pipe(dest(output))
+  //   .on('end', () => {
+  //     // Log
+  //     logger.log('Finished!');
+
+  //     // Complete
+  //     return complete();
+  //   });
+}
+
+// Watcher Task
+function developmentRebuildWatcher(complete) {
+  // Quit if in build mode
+  if (Manager.isBuildMode()) {
+    logger.log('[watcher] Skipping watcher in build mode');
+    return complete();
+  }
+
+  // Log
+  logger.log('[watcher] Watching for changes...');
+
+  // Watch for changes
+  watch(input, { delay: delay }, developmentRebuild)
+  .on('change', function(path) {
+    logger.log(`[watcher] File ${path} was changed`);
+  });
+
+  // Complete
+  return complete();
+}
+
+// Default Task
+module.exports = series(developmentRebuild, developmentRebuildWatcher);

package/dist/gulp/tasks/distribute.js

@@ -0,0 +1,163 @@
+// Libraries
+const Manager = new (require('../../build.js'));
+const logger = Manager.logger('distribute');
+const { src, dest, watch, series } = require('gulp');
+const through2 = require('through2');
+const jetpack = require('fs-jetpack');
+const path = require('path');
+const { execute } = require('node-powertools');
+
+// Load package
+const package = Manager.getPackage('main');
+const project = Manager.getPackage('project');
+const manifest = Manager.getManifest();
+
+// Glob
+const input = [
+  // Files to include
+  'src/**/*',
+
+  // Files to exclude
+  // '!dist/**',
+];
+const output = 'dist';
+const delay = 250;
+
+// Index
+let index = -1;
+
+// Main task
+async function distribute(complete) {
+  // Increment index
+  index++;
+
+  // Log
+  logger.log('Starting...');
+
+  // Create build JSON
+  await createBuildJSON();
+
+  // Complete
+  return src(input, { base: 'src' })
+    // .pipe(customPathTransform())
+    .pipe(dest(output))
+    .on('end', () => {
+      // Log
+      logger.log('Finished!');
+
+      // Complete
+      return complete();
+    });
+}
+
+function customPathTransform() {
+  return through2.obj(function (file, _, callback) {
+    // Skip if it's a directory
+    if (file.isDirectory()) {
+      return callback(null, file);
+    }
+
+    // Get relative path
+    const relativePath = path.relative(file.base, file.path);
+
+    // Log
+    // logger.log(`Processing file 111: ${relativePath}`);
+
+    // Change path if it starts with 'pages/'
+    if (relativePath.startsWith('pages/')) {
+      const newRelativePath = relativePath.replace(/^pages\//, '');
+      file.path = path.join(file.base, newRelativePath);
+
+      // Log
+      // logger.log(`Changed path to 222: ${file.path}`);
+    }
+
+    // Log
+    // logger.log(`Processing file 333: ${file.path}`);
+
+    // Push the file
+    this.push(file);
+
+    // Continue
+    callback(null, file);
+  });
+}
+
+// Watcher task
+function distributeWatcher(complete) {
+  // Quit if in build mode
+  if (process.env.BXM_ === 'true') {
+    logger.log('[watcher] Skipping watcher in build mode');
+    return complete();
+  }
+
+  // Log
+  logger.log('[watcher] Watching for changes...');
+
+  // Watch for changes
+  watch(input, { delay: delay }, distribute)
+  .on('change', function(path) {
+    logger.log(`[watcher] File ${path} was changed`);
+  });
+
+  // Complete
+  return complete();
+}
+
+// Default Task
+module.exports = series(distribute, distributeWatcher);
+
+
+// Get git info
+async function getGitInfo() {
+  return await execute('git remote -v')
+  .then((r) => {
+    // Split on whitespace
+    const split = r.split(/\s+/);
+    const url = split[1];
+
+    // Get user and repo
+    const user = url.split('/')[3];
+    const name = url.split('/')[4].replace('.git', '');
+
+    // Return
+    return {user, name};
+  })
+}
+
+// Create build.json
+async function createBuildJSON() {
+  // Create build log JSON
+  try {
+    // Get info first
+    const git = await getGitInfo();
+
+    // Create JSON
+    const json = {
+      timestamp: new Date().toISOString(),
+      repo: {
+        user: git.user,
+        name: git.name,
+      },
+      environment: Manager.getEnvironment(),
+      packages: {
+        'web-manager': require('web-manager/package.json').version,
+        [package.name]: package.version,
+      },
+      manifest: manifest,
+    }
+
+    // Log object
+    // logger.log('Build JSON:', json);
+
+    // Write to file
+    jetpack.write('dist/build.json', JSON.stringify(json, null, 2));
+
+    // Log
+    logger.log('Created build.json');
+  } catch (e) {
+    console.error('Error updating build.json', e);
+  }
+}
+
+