Awesome WebExtensions

A curated list of awesome resources for WebExtensions development.

WebExtensions are a cross-browser system for developing browser add-ons. To a large extent the system is compatible with the extension API supported by Google Chrome and Opera. Extensions written for these browsers will in most cases run in Firefox or Microsoft Edge with just a few changes.

Contents

• Getting Started
• Libraries and Frameworks
• Tools
• Boilerplates
• Sample Extensions

Getting started

• Chrome Extensions documentation
• Chrome Extensions API
• Mozilla's WebExtensions documentation
• Mozilla's WebExtensions implementation status - WebExtensions are not yet fully compatible/implemented in Firefox, this helps you see what isn't.
• Support for Chrome & WebExtension APIs across Browsers
• Guide to port a Chrome Extension to work in Firefox

Libraries and Frameworks

Code meant become part of the extension.

• webext-options-sync - Helps you manage and autosave your extension's options.
• webext-inject-on-install - Automatically add content scripts to existing tabs when your extension is installed. Chrome + Firefox.
• chrome-promise - Promised version of chrome.* callback-style functions.

Tools

Apps that help you manage your extensions.

• Chrome Webstore Upload - Upload the extension to the Chrome Web Store via cli (or on Travis, automatically).
• mozilla/Web-ext Command line tool to help build, run, and test WebExtensions.
• Extensionizr - Web UI that helps you create an initial configuration and files.
• chromepet - Get notified when your new version has been published.
• inline-install - Simplify the installation of the extension directly from your website.
• wemf - Format and validate manifest.json.
• maniver - Bump the extension version via cli.
• chrome-ext-downloader - Download any extension on Chrome Web Store to see how they do it.
• chrome-i18n - Helps build a locales database from some project files.

Boilerplates

• extensionizr.com - Basic Boilerplate.
• generator-chrome-extension - Boilerplate based on gulp & babel.
• generator-chrome-extension-kickstart - Flexible Boilerplate based on gulp, webpack & babel.
• react-chrome-extension-boilerplate - React boilerplate with Hot reloading.

Sample Extensions

These are simple and modern WebExtensions repositories that could help you figure out where pieces go, including automatic deployment via Travis CI.

• npm-hub
• Sticky Pinned Tabs
• Dim Files on GitHub

License

To the extent possible under law, Federico Brigante has waived all copyright and related or neighboring rights to this work.