Skip to content

Latest commit

 

History

History
100 lines (60 loc) · 5.02 KB

developing.md

File metadata and controls

100 lines (60 loc) · 5.02 KB
Raw

Developing

This was created from https://github.com/fregante/browser-extension-template.

Features

Getting started

🛠 Build locally

  1. Run npm install to install all required dependencies
  2. Run npm run build

The build step will create the distribution folder, this folder will contain the generated extension.

🏃 Run the extension

Using web-ext is recommended for automatic reloading and running in a dedicated browser instance. Alternatively you can load the extension manually (see below).

  1. Run npm run watch to watch for file changes and build continuously
  2. In another terminal, run npx web-ext run -t chromium
  3. Check that the extension is loaded by opening the extension options (in Firefox or in Chrome).

📦 Packaging

You can package the extension manually by running npm run package.

ℹ️ This uses the version number in the manifest which is different to the Release Workflow which uses the current UTC date time.

Manually

You can also load the extension manually in Chrome or Firefox.

✏️ Make a change

  1. For example, edit source\manifest.json to "name": "My Awesome Extension",
  2. Go back to your browser, reload and see the change take effect

Note: Firefox will automatically reload content scripts when the extension is updated, Chrome requires you to reload the page to reload the content scripts.

📕 Read the documentation

Here are some websites you should refer to:

Configuration

The extension doesn't target any specific ECMAScript environment or provide any transpiling by default. The extensions output will be the same ECMAScript you write. This allows us to always target the latest browser version, which is a good practice you should be following.

Parcel 2

Being based on Parcel 2 and its WebExtension transformer, you get all the good parts:

  • Browserlist-based code transpiling (which defaults to just the latest Chrome and Firefox versions)
  • Automatically picks up any new file specified in manifest.json

Auto-syncing options

Options are managed by fregante/webext-options-sync, which auto-saves and auto-restores the options form, applies defaults and runs migrations.

Publishing

It's possible to automatically publish to both the Chrome Web Store and Mozilla Addons at once by adding these secrets on GitHub Actions:

  1. CLIENT_ID, CLIENT_SECRET, and REFRESH_TOKEN from Google APIs.
  2. WEB_EXT_API_KEY, and WEB_EXT_API_SECRET from AMO.

Also include EXTENSION_ID in the secrets (how to find it) and add Mozilla’s gecko.id to manifest.json.

The GitHub Actions workflow will:

  1. Build the extension
  2. Create a version number based on the current UTC date time, like 19.6.16 and sets it in the manifest.json
  3. Deploy it to both stores

Auto-publishing

Thanks to the included GitHub Action Workflows, if you set up those secrets in the repo's Settings, the deployment will automatically happen:

  • on a schedule, by default every week (but only if there are any new commits in the last tag)
  • manually, by clicking "Run workflow" in the Actions tab.