Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
130 lines (85 loc) · 2.65 KB

CONTRIBUTING.md

File metadata and controls

130 lines (85 loc) · 2.65 KB

Contributing

Application

To get started clone the project and install the dependencies.

npm install

Developing

Note: WXT launches a browser by default when you run dev. See Browser Opening modify the browser or disable this behavior.

Chrome

npm run dev

To Load Manually, open Chrome and navigate to chrome://extensions/, enable "Developer mode", and load the unpacked extension from the .output directory.

Firefox

npm run dev:ff

To Load Manually, open Firefox and navigate to about:debugging#/runtime/this-firefox, then click "Load Temporary Add-on..." and load the unpacked extension from the .output directory.

Android

This requires the Android Debug Bridge (adb).

In another terminal (or without the watcher run npm build:ff).

npm run watch:ff

Enable USB or Wireless Debugging, connect, and get your device name.

adb devices

Then run using your device name.

npm run android -- name

Building

Package All

This type checks the project, builds and zips to the .output directory.

npm run package

Chrome

To build the .output directory.

npm run build

To build and create an archive in the .output directory.

npm run zip:chrome

Firefox

To build the .output directory.

npm build:ff

To build and create an archive in the .output directory.

npm run zip:ff

WXT

This project uses the WXT framework.

Browser Opening

To customize the config for development add a web-ext.config.ts to the project root.

The binaries allow you to pick which browser opens. To disable auto-opening set disabled: true.

// web-ext.config.ts
import { defineWebExtConfig } from 'wxt'

export default defineWebExtConfig({
  binaries: {
    firefox: 'C:/Program Files/Firefox Developer Edition/firefox.exe',
    chrome: 'C:/Program Files/BraveSoftware/Brave-Browser/Application/brave.exe',
  },
  // disabled: true,
})

Loading Unpacked

Additional notes on loading temporary/unpacked extensions.