development.md

Setup the development environment

Make sure to have the npm command available:

$ npm --version
10.9.2

Install the dependencies:

$ make install

Build the assets with the Parcel watcher:

$ make watch

Run the extension in Firefox:

$ make run

Or in Chromium:

$ make run BROWSER=chromium

Or in Firefox for Android (connect your phone in USB first and make sure you have adb installed):

$ make run BROWSER=<device>

You can find the name of your device with:

$ adb devices

Build the extension with:

$ make build

It builds the assets under the dist/assets folder, and builds a ZIP archive under dist/artifacts/.

Linters

Run the linters with:

$ make lint

You can run a specific linter with:

$ make lint LINTER=biome
$ make lint LINTER=webext

Note that the webext linter runs over the dist/assets files and not the files under src/. This is to check that the final assets don't present any problems.