Skip to content

smashedr/extension-manager

Repository files navigation

Chrome Web Store Users Mozilla Add-on Users Chrome Web Store Version Mozilla Add-on Version GitHub Release Version Manifest Version Build Quality Gate Status

Extension Manager

Modern Chrome Web Extension and Firefox Browser Addon Extension Manager Example. README.md copied from link-extractor as an example.

Install

Chrome Firefox Edge Chromium Brave Vivaldi Opera

All Chromium Based Browsers can install the extension from the Chrome Web Store.

Features

Please submit a Feature Request for new features.
For any issues, bugs or concerns; please Open an Issue.

Configuration

You can pin the Addon by clicking the Puzzle Piece, find the Web Extension icon, then;
Chrome, click the Pin icon.
Firefox, click the Settings Wheel and Pin to Toolbar.

To open the options, click on the icon (from above) then click Open Options.
Here you can set flags and add as many saved regular expressions as you would like for easy use later.
Make sure to clickSave Options when finished.

For more information on regex, see: https://regex101.com/

Development

Quick Start

First, clone (or download) this repository and change into the directory.

Second, install the dependencies:

npm install

Finally, to run Chrome or Firefox with web-ext, run one of the following:

npm run chrome
npm run firefox

Additionally, to Load Unpacked/Temporary Add-on make a manifest.json and run from the src folder, run one of the following:

npm run manifest:chrome
npm run manifest:firefox

Chrome: https://developer.chrome.com/docs/extensions/get-started/tutorial/hello-world#load-unpacked
Firefox: https://extensionworkshop.com/documentation/develop/temporary-installation-in-firefox/

For more information on web-ext, read this documentation.
To pass additional arguments to an npm run command, use --.
Example: npm run chrome -- --chromium-binary=...

Building

Install the requirements and copy libraries into the src/dist directory by running npm install. See gulpfile.js for more information on postinstall.

npm install

To load unpacked or temporary addon from the src folder, you must generate the src/manifest.json for the desired browser.

npm run manifest:chrome
npm run manifest:firefox

If you would like to create a .zip archive of the src directory for the desired browser.

npm run build
npm run build:chrome
npm run build:firefox

For more information on building, see the scripts in the package.json file.

Chrome Setup

  1. Build or Download a Release.
  2. Unzip the archive, place the folder where it must remain and note its location for later.
  3. Open Chrome, click the 3 dots in the top right, click Extensions, click Manage Extensions.
  4. In the top right, click Developer Mode then on the top left click Load unpacked.
  5. Navigate to the folder you extracted in step #3 then click Select Folder.

Firefox Setup

  1. Build or Download a Release.
  2. Unzip the archive, place the folder where it must remain and note its location for later.
  3. Go to about:debugging#/runtime/this-firefox and click Load Temporary Add-on...
  4. Navigate to the folder you extracted earlier, select manifest.json then click Select File.
  5. Optional: Open about:config search for extensions.webextensions.keepStorageOnUninstall and set to true.

If you need to test a restart, you must pack the addon. This only works in ESR, Development, or Nightly. You may also use an Unbranded Build: https://wiki.mozilla.org/Add-ons/Extension_Signing#Unbranded_Builds

  1. Run npm run build:firefox then use web-ext-artifacts/{name}-firefox-{version}.zip.
  2. Open about:config search for xpinstall.signatures.required and set to false.
  3. Open about:addons and drag the zip file to the page or choose Install from File from the Settings wheel.

About

No description, website, or topics provided.

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published