2088 Commit

tophf ce8f618e44 feat: show the first changed line when tracking		4 anni fa
.github	3a66884422 chore: fix CI action, attempt 2	4 anni fa
scripts	86887363ae fix: use iframe fallback for safe globals	4 anni fa
src	ce8f618e44 feat: show the first changed line when tracking	4 anni fa
test	0d0abcaea3 chore: fix tests	4 anni fa
.babelrc.js	9c94de280d fix: define safe globals via header injection (#1359)	4 anni fa
.browserslistrc	1e75a50fa3 chore: compile to Firefox >= 53	6 anni fa
.editorconfig	966004e8fa chore: avoid git noise in package.json's last newline	4 anni fa
.eslintignore	b4be70a3d0 chore: simplify generation of test build's name	4 anni fa
.eslintrc.js	686a9c7d77 fix: don't use `common` in `injected` directly	4 anni fa
.gitignore	9cc7a0e0bb chore: auto deploy AMO unlisted version	4 anni fa
.postcssrc.js	07233c9b61 feat: option for ui theme auto/dark/light	4 anni fa
LICENSE	be7d421dcf chore: add MIT LICENSE	8 anni fa
README.md	93e6d0f394 chore: describe test builds	4 anni fa
gulpfile.js	b5d6060a1b fix: use the actual manifest's version in VM_VER	4 anni fa
jsconfig.json	8634c36917 chore: add jsconfig.json to help IntelliSense	4 anni fa
package.json	80e7cb6e67 fix: use window.opener to guard the vault	4 anni fa
yarn.lock	86887363ae fix: use iframe fallback for safe globals	4 anni fa

Violentmonkey

Violentmonkey provides userscripts support for browsers. It works on browsers with WebExtensions support.

More details can be found here.

Automated Builds for Testers

A test build is generated automatically for changes between beta releases. It can be installed as an unpacked extension in Chrome and Chromium-based browsers or as a temporary extension in Firefox. It's likely to have bugs so do an export in Violentmonkey settings first. This zip is available only if you're logged-in on GitHub site. Open an entry in the CI workflows table and click the Violentmonkey-... link at the bottom to download it.

Environment Variables

The following environment variables will be injected at compilation time for some features to work:

SYNC_GOOGLE_CLIENT_ID / SYNC_GOOGLE_CLIENT_SECRET - Google sync service
SYNC_ONEDRIVE_CLIENT_ID / SYNC_ONEDRIVE_CLIENT_SECRET - OneDrive sync service

Workflows

Development

Make sure Node.js greater than v10.0 and Yarn v1.x is installed.

# Install dependencies
$ yarn

# Watch and compile
$ yarn dev

Then load the extension from 'dist/'.

Building

After a new (pre)release is created, we should build the project and upload to web stores.

# Build for normal releases
$ yarn build

# Build for self-hosted release that has an update_url
$ yarn build:selfHosted

Release

Just create a tag and push it.

When a tag is pushed to GitHub, a (pre)release will be created with assets built by GitHub Actions.

# Create a prerelease
$ yarn bump

# Create a patch release
$ yarn version --patch

README.md