DevelopmentInstructions

How to Build

Requirements:

• Git (https://git-scm.com/)
• Node 18 or later (https://nodejs.org/)
• npm 8 or later (https://www.npmjs.com/)

Build the script:

npm run build

This also runs the tests and checks the formatting.

How to Run

After building:

• The dist/userscript directory will contain the Userscript.

  • Enable the Tampermonkey extension in Mozilla Firefox.
  • Open the script in the browser to install it.

• The dist/googlechrome directory will contain the Google Chrome extension.

  • Open the Tools -> Extensions page.
  • Turn on Developer Mode.
  • Click on Load unpacked and select the dist/googlechrome directory.

How to Test

npm test

When testing manually, see Features for a list of test cases.

Formatting

The code is formatted with Prettier.

Format the code:

npm run format

Check whether the code is formatted correctly:

npm run format-check

How to Release

(Requires access to the Greasy Fork and Google accounts.)

• Tag the release commit and push. e.g.

  git tag -a 1.7.0 -m "1.7.0"
  git push --follow-tags
  

• Download the build artifacts from the Github build for the tag.
• Upload the Userscript to Greasy Fork.
• Upload the Google Chrome extension to the Chrome Web Store Developer Dashboard.
• Update the Releases wiki page.