All your base are belong to us!
Here are some decisions we have done for our development, feel free to suggest better ones.
This document only highlights things necessary for contributing to this this codebase. For details on our architecture, see ARCHITECTURE.md instead.
Use npm run develop or npm start to run web-ext run behind the scenes. web-ext in an official tool from Mozilla that will:
- Spin up a new browser instance.
- Watch for file changes and automatically reload them in the browser.
Learn how you can debug the extension on the browser on Mozilla's Extension Workshop website.
See TESTING.md.
- We use lint-staged and husky to automatically run tests before commits. Check their sections in
package.jsonfor more details on what they do. - We use prettier to auto style our code so you don't have to worry about it. ✨
npm run format. Will auto format your js, json, css and markdown files usingprettier. This command is called by lint-staged before any commit attempt.
- We use eslint to lint (and fix, when possible) our code for common errors. It is configured to also report and fix
prettiererrors, makingeslintour single entry point for static analysis.npm run lint:fix. Will lint your javascript files and auto-fix whatever it can. This command is called by lint-staged before any commit attempt.
For your daily development, we recommend:
- Having one terminal window running
npm run develop - Having one terminal window running
npm run test:watch - Running linting and formatting automatically upon file save with your editor/IDE, so your testing and committing flows are faster and with less surprises.
We're using Github Actions as our CI envirorment. Check the workflows folder for what we are using. In sum, it:
- Runs
npm run teston each PR. - Runs
npm run releaseon each push tomain, auto-generating a release, release notes, version bumps, etc. See the RELEASES.md for more details on how releases are done. - Create a new PR with the updated files and automerge it