File: README.md Copy Chapter

SponsorBlock

SponsorBlock is an open-source crowdsourced browser extension to skip sponsor segments in YouTube videos. Users submit when a sponsor happens from the extension, and the extension automatically skips sponsors it knows about. It also supports skipping other categories, such as intros, outros and reminders to subscribe.

It also supports Invidious.

Translate:

Important Links

See the Wiki for important links.

Server

The backend server code is available here: https://github.com/ajayyy/SponsorBlockServer

To make sure that this project doesn't die, I have made the database publicly downloadable at https://sponsor.ajay.app/database (License). If you are planning on using the database in another project, please read the API Docs page for more information.

The dataset and API are now being used in some ports as well as a neural network.

API

You can read the API docs here.

Building

See CONTRIBUTING.md

Credit

The awesome Invidious API was previously used, and the server is now using NewLeaf to get video info from YouTube.

Originally forked from YTSponsorSkip, but very little code remains.

Icons made by:

• Gregor Cresnar from www.flaticon.com and are licensed by CC 3.0 BY
• Freepik from www.flaticon.com and are licensed by CC 3.0 BY
• Alexander Kahlkopf from iconmonstr.com and are licensed by iconmonstr License

License Copy Section

This project is licensed under GNU GPL v3 or any later version

File: CONTRIBUTING.md Copy Chapter

If you make any contributions to SponsorBlock after this file was created, you are agreeing that any code you have contributed will be licensed under GPL-3.0 and agree to allow distribution on app stores as outlined in LICENSE-APPSTORE.

Translations

https://crowdin.com/project/sponsorblock

Building

Building locally Copy Chapter

0. You must have Node.js 22 or later and npm installed. Works best on Linux
1. Clone with submodules

git clone --recursive https://github.com/ajayyy/SponsorBlock

Or if you already cloned it, pull submodules with

git submodule update --init --recursive

2. Copy the file config.json.example to config.json and adjust configuration as desired.

• Comments are invalid in JSON, make sure they are all removed.
• You will need to repeat this step in the future if you get build errors related to CompileConfig or property does not exist on type ConfigClass. This can happen for example when a new category is added.

3. Run npm ci in the repository to install dependencies.
4. Run npm run build:dev (for Chrome) or npm run build:dev:firefox (for Firefox) to generate a development version of the extension with source maps.
   • You can also run npm run build (for Chrome) or npm run build:firefox (for Firefox) to generate a production build.
5. The built extension is now in dist/. You can load this folder directly in Chrome as an unpacked extension, or convert it to a zip file to load it as a temporary extension in Firefox.

Developing with a clean profile and hot reloading Copy Chapter

Run npm run dev (for Chrome) or npm run dev:firefox (for Firefox) to run the extension using a clean browser profile with hot reloading. This uses web-ext run.

Known chromium bug: Extension is not loaded properly on first start. Visit chrome://extensions/ and reload the extension.

For Firefox for Android, use npm run dev:firefox-android -- --adb-device . See the Firefox documentation for more information. You may need to edit package.json and add the parameters directly there.

File: crowdin.yml Copy Chapter

files:

• source: /public/_locales/en/*
  translation: /public/_locales/%two_letters_code%/%original_file_name%

File: LICENSE-APPSTORE.txt Copy Chapter

The developers are aware that the terms of service that
apply to apps distributed via Apple's App Store services and similar app stores may conflict
with rights granted under the SponsorBlock license, the GNU General
Public License, version 3. The copyright holders of the SponsorBlock
project do not wish this conflict to prevent the otherwise-compliant
distribution of derived apps via the App Store and similar app stores.
Therefore, we have committed not to pursue any license
violation that results solely from the conflict between the GNU GPLv3
and the Apple App Store terms of service or similar app stores. In
other words, as long as you comply with the GPL in all other respects,
including its requirements to provide users with source code and the
text of the license, we will not object to your distribution of the
SponsorBlock project through the App Store.

File: LICENSE-HISTORY.txt Copy Chapter

Prior to commit 7338af3b384e2297eaf710443121ac840099a9f1, this project was licensed under LGPL 3.0.

You must follow LICENSE instead if you want to use any newer version.

GNU LESSER GENERAL PUBLIC LICENSE
                   Version 3, 29 June 2007

Copyright (C) 2007 Free Software Foundation, Inc. https://fsf.org/
Everyone is permitted to copy and distribute verbatim copies
of this license document, but changing it is not allowed.

This version of the GNU Lesser General Public License incorporates
the terms and conditions of version 3 of the GNU General Public
License, supplemented by the additional permissions listed below.

0. Additional Definitions.

As used herein, "this License" refers to version 3 of the GNU Lesser
General Public License, and the "GNU GPL" refers to version 3 of the GNU
General Public License.

"The Library" refers to a covered work governed by this License,
other than an Application or a Combined Work as defined below.

An "Application" is any work that makes use of an interface provided
by the Library, but which is not otherwise based on the Library.
Defining a subclass of a class defined by the Library is deemed a mode
of using an interface provided by the Library.

A "Combined Work" is a work produced by combining or linking an
Application with the Library. The particular version of the Library
with which the Combined Work was made is also called the "Linked
Version".

The "Minimal Corresponding Source" for a Combined Work means the
Corresponding Source for the Combined Work, excluding any source code
for portions of the Combined Work that, considered in isolation, are
based on the Application, and not on the Linked Version.

The "Corresponding Application Code" for a Combined Work means the
object code and/or source code for the Application, including any data
and utility programs needed for reproducing the Combined Work from the
Application, but excluding the System Libraries of the Combined Work.

1. Exception to Section 3 of the GNU GPL.

You may convey a covered work under sections 3 and 4 of this License
without being bound by section 3 of the GNU GPL.

2. Conveying Modified Versions.

If you modify a copy of the Library, and, in your modifications, a
facility refers to a function or data to be supplied by an Application
that uses the facility (other than as an argument passed when the
facility is invoked), then you may convey a copy of the modified
version:

a) under this License, provided that you make a good faith effort to
ensure that, in the event an Application does not supply the
function or data, the facility still operates, and performs
whatever part of its purpose remains meaningful, or

b) under the GNU GPL, with none of the additional permissions of
this License applicable to that copy.

3. Object Code Incorporating Material from Library Header Files.

The object code form of an Application may incorporate material from
a header file that is part of the Library. You may convey such object
code under terms of your choice, provided that, if the incorporated
material is not limited to numerical parameters, data structure
layouts and accessors, or small macros, inline functions and templates
(ten or fewer lines in length), you do both of the following:

a) Give prominent notice with each copy of the object code that the
Library is used in it and that the Library and its use are
covered by this License.

b) Accompany the object code with a copy of the GNU GPL and this license
document.

4. Combined Works.

You may convey a Combined Work under terms of your choice that,
taken together, effectively do not restrict modification of the
portions of the Library contained in the Combined Work and reverse
engineering for debugging such modifications, if you also do each of
the following:

a) Give prominent notice with each copy of the Combined Work that
the Library is used in it and that the Library and its use are
covered by this License.

b) Accompany the Combined Work with a copy of the GNU GPL and this license
document.

c) For a Combined Work that displays copyright notices during
execution, include the copyright notice for the Library among
these notices, as well as a reference directing the user to the
copies of the GNU GPL and this license document.

d) Do one of the following:

0) Convey the Minimal Corresponding Source under the terms of this
   License, and the Corresponding Application Code in a form
   suitable for, and under terms that permit, the user to
   recombine or relink the Application with a modified version of
   the Linked Version to produce a modified Combined Work, in the
   manner specified by section 6 of the GNU GPL for conveying
   Corresponding Source.

   1) Use a suitable shared library mechanism for linking with the
   Library.  A suitable mechanism is one that (a) uses at run time
   a copy of the Library already present on the user's computer
   system, and (b) will operate properly with a modified version
   of the Library that is interface-compatible with the Linked
   Version.

e) Provide Installation Information, but only if you would otherwise
be required to provide such information under section 6 of the
GNU GPL, and only to the extent that such information is
necessary to install and execute a modified version of the
Combined Work produced by recombining or relinking the
Application with a modified version of the Linked Version. (If
you use option 4d0, the Installation Information must accompany
the Minimal Corresponding Source and Corresponding Application
Code. If you use option 4d1, you must provide the Installation
Information in the manner specified by section 6 of the GNU GPL
for conveying Corresponding Source.)

5. Combined Libraries.

You may place library facilities that are a work based on the
Library side by side in a single library together with other library
facilities that are not Applications and are not covered by this
License, and convey such a combined library under terms of your
choice, if you do both of the following:

a) Accompany the combined library with a copy of the same work based
on the Library, uncombined with any other library facilities,
conveyed under the terms of this License.

b) Give prominent notice with the combined library that part of it
is a work based on the Library, and explaining where to find the
accompanying uncombined form of the same work.

6. Revised Versions of the GNU Lesser General Public License.

The Free Software Foundation may publish revised and/or new versions
of the GNU Lesser General Public License from time to time. Such new
versions will be similar in spirit to the present version, but may
differ in detail to address new problems or concerns.

Each version is given a distinguishing version number. If the
Library as you received it specifies that a certain numbered version
of the GNU Lesser General Public License "or any later version"
applies to it, you have the option of following the terms and
conditions either of that published version or of any later version
published by the Free Software Foundation. If the Library as you
received it does not specify a version number of the GNU Lesser
General Public License, you may choose any version of the GNU Lesser
General Public License ever published by the Free Software Foundation.

If the Library as you received it specifies that a proxy can decide
whether future versions of the GNU Lesser General Public License shall
apply, that proxy's public statement of acceptance of any version is
permanent authorization for you to choose that version for the
Library.

File: package.json Copy Chapter

{
"name": "sponsorblock",
"version": "1.0.0",
"description": "",
"main": "background.js",
"dependencies": {
"content-scripts-register-polyfill": "^4.0.2",
"react": "^18.2.0",
"react-dom": "^18.2.0"
},
"overrides": {
"content-scripts-register-polyfill": {
"webext-content-scripts": "v2.5.5"
}
},
"devDependencies": {
"@types/chrome": "^0.0.220",
"@types/firefox-webext-browser": "^111.0.0",
"@types/jest": "^29.4.0",
"@types/react": "^18.0.28",
"@types/react-dom": "^18.0.11",
"@types/selenium-webdriver": "^4.1.13",
"@types/wicg-mediasession": "^1.1.4",
"@typescript-eslint/eslint-plugin": "^5.54.1",
"@typescript-eslint/parser": "^5.54.1",
"chromedriver": "^140.0.0",
"concurrently": "^7.6.0",
"copy-webpack-plugin": "^11.0.0",
"eslint": "^8.35.0",
"eslint-plugin-react": "^7.32.2",
"fork-ts-checker-webpack-plugin": "^7.3.0",
"jest": "^29.5.0",
"jest-environment-jsdom": "^30.2.0",
"rimraf": "^4.3.1",
"schema-utils": "^4.0.0",
"selenium-webdriver": "^4.8.1",
"ts-jest": "^29.0.5",
"ts-loader": "^9.4.2",
"ts-node": "^10.9.1",
"typescript": "4.9",
"web-ext": "^8.10.0",
"webpack": "^5.105.0",
"webpack-cli": "^4.10.0",
"webpack-merge": "^5.8.0"
},
"scripts": {
"web-run": "npm run web-run:chrome",
"web-sign": "web-ext sign --channel unlisted -s dist",
"web-run:firefox": "cd dist && web-ext run --start-url https://addons.mozilla.org/firefox/addon/ublock-origin/",
"web-run:firefox-android": "cd dist && web-ext run -t firefox-android --firefox-apk org.mozilla.fenix",
"web-run:chrome": "cd dist && web-ext run --start-url https://chrome.google.com/webstore/detail/ublock-origin/cjpalhdlnbpafiamejdnhcphjbkeiagm -t chromium",
"build": "npm run build:chrome",
"build:chrome": "webpack --env browser=chrome --config webpack/webpack.prod.js",
"build:firefox": "webpack --env browser=firefox --config webpack/webpack.prod.js",
"build:safari": "webpack --env browser=safari --config webpack/webpack.prod.js",
"build:edge": "webpack --env browser=edge --config webpack/webpack.prod.js",
"build:dev": "npm run build:dev:chrome",
"build:dev:chrome": "webpack --env browser=chrome --config webpack/webpack.dev.js",
"build:dev:firefox": "webpack --env browser=firefox --config webpack/webpack.dev.js",
"build:watch": "npm run build:watch:chrome",
"build:watch:chrome": "webpack --env browser=chrome --config webpack/webpack.dev.js --watch",
"build:watch:firefox": "webpack --env browser=firefox --config webpack/webpack.dev.js --watch",
"ci:invidious": "ts-node ci/generateList.ts",
"dev": "npm run build:dev && concurrently "npm run web-run" "npm run build:watch"",
"dev:firefox": "npm run build:dev:firefox && concurrently "npm run web-run:firefox" "npm run build:watch:firefox"",
"dev:firefox-android": "npm run build:dev:firefox && concurrently "npm run web-run:firefox-android" "npm run build:watch:firefox"",
"clean": "rimraf dist",
"test": "npm run build:chrome && npx jest",
"test-without-building": "npx jest",
"lint": "eslint src",
"lint:fix": "eslint src --fix"
},
"engines": {
"node": ">=16"
},
"funding": [
{
"type": "individual",
"url": "https://sponsor.ajay.app/donate"
},
{
"type": "github",
"url": "https://github.com/sponsors/ajayyy-org"
},
{
"type": "patreon",
"url": "https://www.patreon.com/ajayyy"
},
{
"type": "individual",
"url": "https://paypal.me/ajayyy"
}
],
"repository": {
"type": "git",
"url": "git+https://github.com/ajayyy/SponsorBlock.git"
},
"author": "Ajay Ramachandran",
"license": "GPL-3.0",
"private": true
}

File: tsconfig-production.json Copy Chapter

{
"compilerOptions": {
"module": "commonjs",
"target": "es6",
"noImplicitAny": false,
"noImplicitReturns": true,
"noFallthroughCasesInSwitch": true,
"sourceMap": true,
"outDir": "dist/js",
"noEmitOnError": false,
"typeRoots": [ "node_modules/@types" ],
"resolveJsonModule": true,
"jsx": "react",
"lib": [
"es2019",
"dom",
"dom.iterable"
]
},
"include": [
"src/**/*"
]
}

File: tsconfig.json Copy Chapter

{
"compilerOptions": {
"module": "commonjs",
"target": "es6",
"noImplicitAny": false,
"noImplicitReturns": true,
"noFallthroughCasesInSwitch": true,
"sourceMap": true,
"outDir": "dist/js",
"noEmitOnError": false,
"typeRoots": [ "node_modules/@types" ],
"resolveJsonModule": true,
"jsx": "react",
"lib": [
"es2020",
"dom",
"dom.iterable"
]
},
"include": [
"src/**/*"
]
}

File: .eslintrc.json Copy Chapter

{
"env": {
"browser": true,
"es2021": true,
"node": true,
"jest": true
},
"extends": [
"eslint:recommended",
"plugin:react/recommended",
"plugin:@typescript-eslint/recommended"
],
"parser": "@typescript-eslint/parser",
"parserOptions": {
"ecmaFeatures": {
"jsx": true
},
"ecmaVersion": 12,
"sourceType": "module"
},
"plugins": ["react", "@typescript-eslint"],
"rules": {
"@typescript-eslint/no-unused-vars": "error",
"no-self-assign": "off",
"@typescript-eslint/no-empty-interface": "off",
"react/prop-types": [2, { "ignore": ["children"] }],
"@typescript-eslint/member-delimiter-style": "warn",
"@typescript-eslint/no-non-null-assertion": "off",
"@typescript-eslint/ban-ts-comment": "off",
"@typescript-eslint/no-this-alias": "off"
},
"settings": {
"react": {
"version": "detect"
}
}
}

File: ci/invidiouslist.json Copy Chapter

["www.youtubekids.com","inv.nadeko.net","invidious.f5.si","invidious.nerdvpn.de","yt.chocolatemoo53.com"]

File: manifest/beta-manifest-extra.json Copy Chapter

{
"name": "BETA - SponsorBlock"
}

File: manifest/chrome-manifest-extra.json Copy Chapter

{
"host_permissions": [
"https://.youtube.com/",
"https://sponsor.ajay.app/"
],
"optional_host_permissions": [
":///"
],
"web_accessible_resources": [{
"resources": [
"icons/LogoSponsorBlocker256px.png",
"icons/IconSponsorBlocker256px.png",
"icons/PlayerStartIconSponsorBlocker.svg",
"icons/PlayerStopIconSponsorBlocker.svg",
"icons/PlayerUploadIconSponsorBlocker.svg",
"icons/PlayerUploadFailedIconSponsorBlocker.svg",
"icons/PlayerCancelSegmentIconSponsorBlocker.svg",
"icons/clipboard.svg",
"icons/settings.svg",
"icons/pencil.svg",
"icons/check.svg",
"icons/check-smaller.svg",
"icons/upvote.png",
"icons/downvote.png",
"icons/thumbs_down.svg",
"icons/thumbs_down_locked.svg",
"icons/thumbs_up.svg",
"icons/help.svg",
"icons/report.png",
"icons/close.png",
"icons/skipIcon.svg",
"icons/refresh.svg",
"icons/beep.oga",
"icons/pause.svg",
"icons/stop.svg",
"icons/skip.svg",
"icons/heart.svg",
"icons/visible.svg",
"icons/not_visible.svg",
"icons/sort.svg",
"icons/money.svg",
"icons/segway.png",
"icons/close-smaller.svg",
"icons/right-arrow.svg",
"icons/campaign.svg",
"icons/star.svg",
"icons/lightbulb.svg",
"icons/bolt.svg",
"icons/stopwatch.svg",
"icons/music-note.svg",
"icons/import.svg",
"icons/export.svg",
"icons/PlayerInfoIconSponsorBlocker.svg",
"icons/PlayerDeleteIconSponsorBlocker.svg",
"icons/dearrow.svg",
"icons/sb-pride.png",
"icons/pride.svg",
"popup.html",
"popup.css",
"content.css",
"shared.css",
"js/document.js",
"libs/Source+Sans+Pro.css",
"libs/6xKydSBYKcSV-LCoeQqfX1RYOo3ig4vwlxdu.woff2",
"libs/6xKydSBYKcSV-LCoeQqfX1RYOo3ig4vwmRduz8A.woff2",
"libs/6xKydSBYKcSV-LCoeQqfX1RYOo3ig4vwmBduz8A.woff2",
"libs/6xKydSBYKcSV-LCoeQqfX1RYOo3ig4vwlBduz8A.woff2"
],
"matches": [""],
"use_dynamic_url": true
}],
"content_scripts": [
{
"world": "MAIN",
"js": [
"./js/document.js"
],
"matches": [
"https://.youtube.com/",
"https://www.youtube-nocookie.com/embed/"
],
"exclude_matches": [
"https://accounts.youtube.com/RotateCookiesPage"
],
"all_frames": true,
"run_at": "document_start"
},
{
"world": "ISOLATED",
"js": [
"./js/content.js"
],
"css": [
"content.css",
"shared.css"
],
"matches": [
"https://.youtube.com/",
"https://www.youtube-nocookie.com/embed/"
],
"exclude_matches": [
"https://accounts.youtube.com/RotateCookiesPage"
],
"all_frames": true,
"run_at": "document_start"
}
],
"action": {
"default_title": "SponsorBlock",
"default_popup": "popup.html",
"default_icon": {
"16": "icons/IconSponsorBlocker16px.png",
"32": "icons/IconSponsorBlocker32px.png",
"64": "icons/IconSponsorBlocker64px.png",
"128": "icons/IconSponsorBlocker128px.png"
},
"theme_icons": [
{
"light": "icons/IconSponsorBlocker16px.png",
"dark": "icons/IconSponsorBlocker16px.png",
"size": 16
},
{
"light": "icons/IconSponsorBlocker32px.png",
"dark": "icons/IconSponsorBlocker32px.png",
"size": 32
},
{
"light": "icons/IconSponsorBlocker64px.png",
"dark": "icons/IconSponsorBlocker64px.png",
"size": 64
},
{
"light": "icons/IconSponsorBlocker128px.png",
"dark": "icons/IconSponsorBlocker128px.png",
"size": 128
},
{
"light": "icons/IconSponsorBlocker256px.png",
"dark": "icons/IconSponsorBlocker256px.png",
"size": 256
},
{
"light": "icons/IconSponsorBlocker512px.png",
"dark": "icons/IconSponsorBlocker512px.png",
"size": 512
},
{
"light": "icons/IconSponsorBlocker1024px.png",
"dark": "icons/IconSponsorBlocker1024px.png",
"size": 1024
}
]
},
"background": {
"service_worker": "./js/background.js"
},
"manifest_version": 3
}

File: manifest/firefox-beta-manifest-extra.json Copy Chapter

{
"browser_specific_settings": {
"gecko": {
"id": "[email protected]"
}
}
}

File: manifest/firefox-manifest-extra.json Copy Chapter

{
"browser_specific_settings": {
"gecko": {
"id": "[email protected]",
"strict_min_version": "102.0"
},
"gecko_android": {
"strict_min_version": "113.0"
}
},
"background": {
"persistent": false
},
"browser_action": {
"default_area": "navbar"
}
}

File: manifest/manifest-v2-extra.json Copy Chapter

{
"web_accessible_resources": [
"icons/LogoSponsorBlocker256px.png",
"icons/IconSponsorBlocker256px.png",
"icons/PlayerStartIconSponsorBlocker.svg",
"icons/PlayerStopIconSponsorBlocker.svg",
"icons/PlayerUploadIconSponsorBlocker.svg",
"icons/PlayerUploadFailedIconSponsorBlocker.svg",
"icons/PlayerCancelSegmentIconSponsorBlocker.svg",
"icons/clipboard.svg",
"icons/settings.svg",
"icons/pencil.svg",
"icons/check.svg",
"icons/check-smaller.svg",
"icons/upvote.png",
"icons/downvote.png",
"icons/thumbs_down.svg",
"icons/thumbs_down_locked.svg",
"icons/thumbs_up.svg",
"icons/help.svg",
"icons/report.png",
"icons/close.png",
"icons/skipIcon.svg",
"icons/refresh.svg",
"icons/beep.oga",
"icons/pause.svg",
"icons/stop.svg",
"icons/skip.svg",
"icons/heart.svg",
"icons/visible.svg",
"icons/not_visible.svg",
"icons/sort.svg",
"icons/money.svg",
"icons/segway.png",
"icons/close-smaller.svg",
"icons/right-arrow.svg",
"icons/campaign.svg",
"icons/star.svg",
"icons/lightbulb.svg",
"icons/bolt.svg",
"icons/stopwatch.svg",
"icons/music-note.svg",
"icons/import.svg",
"icons/export.svg",
"icons/PlayerInfoIconSponsorBlocker.svg",
"icons/PlayerDeleteIconSponsorBlocker.svg",
"icons/dearrow.svg",
"icons/sb-pride.png",
"icons/pride.svg",
"popup.html",
"popup.css",
"content.css",
"shared.css",
"js/document.js",
"libs/Source+Sans+Pro.css",
"libs/6xKydSBYKcSV-LCoeQqfX1RYOo3ig4vwlxdu.woff2",
"libs/6xKydSBYKcSV-LCoeQqfX1RYOo3ig4vwmRduz8A.woff2",
"libs/6xKydSBYKcSV-LCoeQqfX1RYOo3ig4vwmBduz8A.woff2",
"libs/6xKydSBYKcSV-LCoeQqfX1RYOo3ig4vwlBduz8A.woff2"
],
"permissions": [
"https://sponsor.ajay.app/"
],
"optional_permissions": [
":///"
],
"browser_action": {
"default_title": "SponsorBlock",
"default_popup": "popup.html",
"default_icon": {
"16": "icons/IconSponsorBlocker16px.png",
"32": "icons/IconSponsorBlocker32px.png",
"64": "icons/IconSponsorBlocker64px.png",
"128": "icons/IconSponsorBlocker128px.png"
},
"theme_icons": [
{
"light": "icons/IconSponsorBlocker16px.png",
"dark": "icons/IconSponsorBlocker16px.png",
"size": 16
},
{
"light": "icons/IconSponsorBlocker32px.png",
"dark": "icons/IconSponsorBlocker32px.png",
"size": 32
},
{
"light": "icons/IconSponsorBlocker64px.png",
"dark": "icons/IconSponsorBlocker64px.png",
"size": 64
},
{
"light": "icons/IconSponsorBlocker128px.png",
"dark": "icons/IconSponsorBlocker128px.png",
"size": 128
},
{
"light": "icons/IconSponsorBlocker256px.png",
"dark": "icons/IconSponsorBlocker256px.png",
"size": 256
},
{
"light": "icons/IconSponsorBlocker512px.png",
"dark": "icons/IconSponsorBlocker512px.png",
"size": 512
},
{
"light": "icons/IconSponsorBlocker1024px.png",
"dark": "icons/IconSponsorBlocker1024px.png",
"size": 1024
}
]
},
"background": {
"scripts":[
"./js/background.js"
]
},
"content_scripts": [{
"run_at": "document_start",
"matches": [
"https://.youtube.com/",
"https://www.youtube-nocookie.com/embed/"
],
"exclude_matches": [
"https://accounts.youtube.com/RotateCookiesPage"
],
"all_frames": true,
"js": [
"./js/content.js"
],
"css": [
"content.css",
"shared.css"
]
}],
"manifest_version": 2
}

File: manifest/manifest.json Copy Chapter

{
"name": "MSG_fullName",
"short_name": "SponsorBlock",
"version": "6.1.7",
"default_locale": "en",
"description": "MSG_Description",
"homepage_url": "https://sponsor.ajay.app",
"icons": {
"16": "icons/IconSponsorBlocker16px.png",
"32": "icons/IconSponsorBlocker32px.png",
"64": "icons/IconSponsorBlocker64px.png",
"128": "icons/IconSponsorBlocker128px.png",
"256": "icons/IconSponsorBlocker256px.png",
"512": "icons/IconSponsorBlocker512px.png",
"1024": "icons/IconSponsorBlocker1024px.png"
},
"permissions": [
"storage",
"scripting",
"unlimitedStorage"
],
"options_ui": {
"page": "options/options.html",
"open_in_tab": true
}
}

File: manifest/safari-manifest-extra.json Copy Chapter

{
"background": {
"persistent": false
},
"optional_permissions": [
"webNavigation"
],
"browser_action": {
"default_icon": {
"16": "icons/SafariIconSponsorBlocker16px.png",
"32": "icons/SafariIconSponsorBlocker32px.png",
"64": "icons/SafariIconSponsorBlocker64px.png",
"128": "icons/SafariIconSponsorBlocker128px.png"
}
},
"browser_specific_settings": {
"safari": {
"strict_min_version": "14.0"
}
}
}

File: oss-attribution/licenseInfos.json Copy Chapter

{
"content-scripts-register-polyfill": {
"ignore": false,
"name": "content-scripts-register-polyfill",
"version": "4.0.2",
"authors": "Federico Brigante [email protected] (https://fregante.com)",
"url": "https://github.com/fregante/content-scripts-register-polyfill",
"license": "MIT",
"licenseText": "MIT License\n\nCopyright (c) Federico Brigante [email protected] (https://fregante.com)\n\nPermission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n"
},
"escape-string-regexp": {
"ignore": false,
"name": "escape-string-regexp",
"version": "5.0.0",
"authors": "Sindre Sorhus [email protected]",
"url": "https://github.com/sindresorhus/escape-string-regexp",
"license": "MIT",
"licenseText": "MIT License\n\nCopyright (c) Sindre Sorhus [email protected] (https://sindresorhus.com)\n\nPermission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n"
},
"js-tokens": {
"ignore": false,
"name": "js-tokens",
"version": "4.0.0",
"authors": "Simon Lydell",
"url": "https://github.com/lydell/js-tokens",
"license": "MIT",
"licenseText": "The MIT License (MIT)\n\nCopyright (c) 2014, 2015, 2016, 2017, 2018 Simon Lydell\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the "Software"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in\nall copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\nTHE SOFTWARE.\n"
},
"loose-envify": {
"ignore": false,
"name": "loose-envify",
"version": "1.4.0",
"authors": "Andres Suarez [email protected]",
"url": "https://github.com/zertosh/loose-envify",
"license": "MIT",
"licenseText": "The MIT License (MIT)\n\nCopyright (c) 2015 Andres Suarez [email protected]\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the "Software"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in\nall copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN\nTHE SOFTWARE.\n"
},
"react-dom": {
"ignore": false,
"name": "react-dom",
"version": "18.2.0",
"url": "https://github.com/facebook/react",
"license": "MIT",
"licenseText": "MIT License\n\nCopyright (c) Facebook, Inc. and its affiliates.\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the "Software"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n"
},
"react": {
"ignore": false,
"name": "react",
"version": "18.2.0",
"url": "https://github.com/facebook/react",
"license": "MIT",
"licenseText": "MIT License\n\nCopyright (c) Facebook, Inc. and its affiliates.\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the "Software"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n"
},
"scheduler": {
"ignore": false,
"name": "scheduler",
"version": "0.23.0",
"url": "https://github.com/facebook/react",
"license": "MIT",
"licenseText": "MIT License\n\nCopyright (c) Facebook, Inc. and its affiliates.\n\nPermission is hereby granted, free of charge, to any person obtaining a copy\nof this software and associated documentation files (the "Software"), to deal\nin the Software without restriction, including without limitation the rights\nto use, copy, modify, merge, publish, distribute, sublicense, and/or sell\ncopies of the Software, and to permit persons to whom the Software is\nfurnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all\ncopies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR\nIMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,\nFITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE\nAUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER\nLIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,\nOUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE\nSOFTWARE.\n"
},
"webext-content-scripts": {
"ignore": false,
"name": "webext-content-scripts",
"version": "2.5.5",
"authors": "Federico Brigante [email protected] (https://fregante.com)",
"url": "https://github.com/fregante/webext-content-scripts",
"license": "MIT",
"licenseText": "MIT License\n\nCopyright (c) Federico Brigante [email protected] (https://fregante.com)\n\nPermission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n"
},
"webext-patterns": {
"ignore": false,
"name": "webext-patterns",
"version": "1.3.0",
"authors": "Federico Brigante [email protected] (https://fregante.com)",
"url": "https://github.com/fregante/webext-patterns",
"license": "MIT",
"licenseText": "MIT License\n\nCopyright (c) Federico Brigante [email protected] (https://fregante.com)\n\nPermission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n"
},
"webext-polyfill-kinda": {
"ignore": false,
"name": "webext-polyfill-kinda",
"version": "1.0.2",
"authors": "Federico Brigante [email protected] (https://fregante.com)",
"url": "https://github.com/fregante/webext-polyfill-kinda",
"license": "MIT",
"licenseText": "MIT License\n\nCopyright (c) Federico Brigante [email protected] (https://fregante.com)\n\nPermission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n"
}
}

File: public/oss-attribution/attribution.txt Copy Chapter

content-scripts-register-polyfill
4.0.2 https://github.com/fregante/content-scripts-register-polyfill
MIT License

Copyright (c) Federico Brigante [email protected] (https://fregante.com)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

escape-string-regexp
5.0.0 https://github.com/sindresorhus/escape-string-regexp
MIT License

Copyright (c) Sindre Sorhus [email protected] (https://sindresorhus.com)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

js-tokens
4.0.0 https://github.com/lydell/js-tokens
The MIT License (MIT)

Copyright (c) 2014, 2015, 2016, 2017, 2018 Simon Lydell

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

loose-envify
1.4.0 https://github.com/zertosh/loose-envify
The MIT License (MIT)

Copyright (c) 2015 Andres Suarez [email protected]

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

react
18.2.0 https://github.com/facebook/react
MIT License

Copyright (c) Facebook, Inc. and its affiliates.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

react-dom
18.2.0 https://github.com/facebook/react
MIT License

Copyright (c) Facebook, Inc. and its affiliates.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

scheduler
0.23.0 https://github.com/facebook/react
MIT License

Copyright (c) Facebook, Inc. and its affiliates.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

webext-content-scripts
2.5.5 https://github.com/fregante/webext-content-scripts
MIT License

Copyright (c) Federico Brigante [email protected] (https://fregante.com)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

webext-patterns
1.3.0 https://github.com/fregante/webext-patterns
MIT License

Copyright (c) Federico Brigante [email protected] (https://fregante.com)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

webext-polyfill-kinda
1.0.2 https://github.com/fregante/webext-polyfill-kinda
MIT License

Copyright (c) Federico Brigante [email protected] (https://fregante.com)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

File: public/res/countries.json Copy Chapter

{"Albania":{"allowed":true},"Algeria":{"allowed":true},"Angola":{"allowed":true},"Argentina":{"allowed":true},"Armenia":{"allowed":true},"Australia":{"allowed":false},"Austria":{"allowed":false},"Azerbaijan":{"allowed":true},"Bangladesh":{"allowed":true},"Belarus":{"allowed":true},"Belgium":{"allowed":false},"Belize":{"allowed":true},"Benin":{"allowed":true},"Bhutan":{"allowed":true},"Bolivia":{"allowed":true},"Bosnia and Herzegovina":{"allowed":true},"Botswana":{"allowed":true},"Brazil":{"allowed":true},"Bulgaria":{"allowed":true},"Burkina Faso":{"allowed":true},"Burundi":{"allowed":true},"Cameroon":{"allowed":true},"Canada":{"allowed":false},"Central African Republic":{"allowed":true},"Chad":{"allowed":true},"Chile":{"allowed":true},"China":{"allowed":true},"Colombia":{"allowed":true},"Comoros":{"allowed":true},"Costa Rica":{"allowed":true},"Croatia":{"allowed":true},"Cyprus":{"allowed":false},"Czech Republic":{"allowed":false},"Denmark":{"allowed":false},"Djibouti":{"allowed":true},"Dominican Republic":{"allowed":true},"DR Congo":{"allowed":true},"Ecuador":{"allowed":true},"Egypt":{"allowed":true},"El Salvador":{"allowed":true},"Estonia":{"allowed":false},"Eswatini":{"allowed":true},"Ethiopia":{"allowed":true},"Fiji":{"allowed":true},"Finland":{"allowed":false},"France":{"allowed":false},"Gabon":{"allowed":true},"Gambia":{"allowed":true},"Georgia":{"allowed":true},"Germany":{"allowed":false},"Ghana":{"allowed":true},"Greece":{"allowed":true},"Guatemala":{"allowed":true},"Guinea":{"allowed":true},"Guinea-Bissau":{"allowed":true},"Guyana":{"allowed":true},"Haiti":{"allowed":true},"Honduras":{"allowed":true},"Hungary":{"allowed":true},"Iceland":{"allowed":false},"India":{"allowed":true},"Iran":{"allowed":true},"Iraq":{"allowed":true},"Ireland":{"allowed":false},"Israel":{"allowed":false},"Italy":{"allowed":false},"Ivory Coast":{"allowed":true},"Jamaica":{"allowed":true},"Japan":{"allowed":false},"Jordan":{"allowed":true},"Kazakhstan":{"allowed":true},"Kenya":{"allowed":true},"Kiribati":{"allowed":true},"Kyrgyzstan":{"allowed":true},"Laos":{"allowed":true},"Latvia":{"allowed":true},"Lebanon":{"allowed":true},"Lesotho":{"allowed":true},"Liberia":{"allowed":true},"Lithuania":{"allowed":true},"Luxembourg":{"allowed":false},"Madagascar":{"allowed":true},"Malawi":{"allowed":true},"Malaysia":{"allowed":true},"Maldives":{"allowed":true},"Mali":{"allowed":true},"Malta":{"allowed":false},"Mauritania":{"allowed":true},"Mauritius":{"allowed":true},"Mexico":{"allowed":true},"Micronesia":{"allowed":true},"Moldova":{"allowed":true},"Mongolia":{"allowed":true},"Montenegro":{"allowed":true},"Morocco":{"allowed":true},"Mozambique":{"allowed":true},"Myanmar":{"allowed":true},"Namibia":{"allowed":true},"Nepal":{"allowed":true},"Netherlands":{"allowed":false},"Nicaragua":{"allowed":true},"Niger":{"allowed":true},"Nigeria":{"allowed":true},"North Macedonia":{"allowed":true},"Norway":{"allowed":false},"Pakistan":{"allowed":true},"Panama":{"allowed":true},"Papua New Guinea":{"allowed":true},"Paraguay":{"allowed":true},"Peru":{"allowed":true},"Philippines":{"allowed":true},"Poland":{"allowed":true},"Portugal":{"allowed":true},"Republic of the Congo":{"allowed":true},"Romania":{"allowed":true},"Russia":{"allowed":true},"Rwanda":{"allowed":true},"Saint Lucia":{"allowed":true},"Samoa":{"allowed":true},"Sao Tome and Principe":{"allowed":true},"Senegal":{"allowed":true},"Serbia":{"allowed":true},"Seychelles":{"allowed":true},"Sierra Leone":{"allowed":true},"Slovakia":{"allowed":true},"Slovenia":{"allowed":false},"Solomon Islands":{"allowed":true},"South Africa":{"allowed":true},"South Korea":{"allowed":false},"South Sudan":{"allowed":true},"Spain":{"allowed":false},"Sri Lanka":{"allowed":true},"Sudan":{"allowed":true},"Suriname":{"allowed":true},"Sweden":{"allowed":false},"Switzerland":{"allowed":false},"Syria":{"allowed":true},"Taiwan":{"allowed":false},"Tajikistan":{"allowed":true},"Tanzania":{"allowed":true},"Thailand":{"allowed":true},"Timor-Leste":{"allowed":true},"Togo":{"allowed":true},"Tonga":{"allowed":true},"Trinidad and Tobago":{"allowed":true},"Tunisia":{"allowed":true},"Turkey":{"allowed":true},"Turkmenistan":{"allowed":true},"Tuvalu":{"allowed":true},"Uganda":{"allowed":true},"Ukraine":{"allowed":true},"United Arab Emirates":{"allowed":false},"United Kingdom":{"allowed":false},"United States":{"allowed":false},"Uruguay":{"allowed":true},"Uzbekistan":{"allowed":true},"Vanuatu":{"allowed":true},"Venezuela":{"allowed":true},"Vietnam":{"allowed":true},"Yemen":{"allowed":true},"Zambia":{"allowed":true},"Zimbabwe":{"allowed":true}}

File: .github/FUNDING.yml Copy Chapter

github: ajayyy-org
patreon: ajayyy
custom: [sponsor.ajay.app/donate]

File: .github/pull_request_template.md Copy Chapter

• I agree to license my contribution under GPL-3.0 and agree to allow distribution on app stores as outlined in LICENSE-APPSTORE

To test this pull request, follow the instructions in the wiki.

File: .github/workflows/ci.yml Copy Chapter

name: CI

on: [push, pull_request]

jobs:

build:
name: Create artifacts
runs-on: ubuntu-latest

steps:
  # Initialization
  - uses: actions/checkout@v4
    with:
      submodules: recursive
  - uses: actions/setup-node@v4
    with:
      node-version: '18'
  - run: npm ci
  - name: Copy configuration
    run: cp config.json.example config.json

  # Run linter
  - name: Lint
    run: npm run lint

  # Create Chrome artifacts
  - name: Create Chrome artifacts
    run: npm run build:chrome
  - uses: actions/upload-artifact@v4
    with:
      name: ChromeExtension
      path: dist
  - run: mkdir ./builds
  - uses: montudor/action-zip@0852c26906e00f8a315c704958823928d8018b28
    with:
      args: zip -qq -r ./builds/ChromeExtension.zip ./dist

  # Create Firefox artifacts
  - name: Create Firefox artifacts
    run: npm run build:firefox
  - uses: actions/upload-artifact@v4
    with:
      name: FirefoxExtension
      path: dist
  - uses: montudor/action-zip@0852c26906e00f8a315c704958823928d8018b28
    with:
      args: zip -qq -r ./builds/FirefoxExtension.zip ./dist

  # Create Beta artifacts (Builds with the name changed to beta)
  - name: Create Chrome Beta artifacts
    run: npm run build:chrome -- --env stream=beta
  - uses: actions/upload-artifact@v4
    with:
      name: ChromeExtensionBeta
      path: dist
  - uses: montudor/action-zip@0852c26906e00f8a315c704958823928d8018b28
    with:
      args: zip -qq -r ./builds/ChromeExtensionBeta.zip ./dist

  - name: Create Firefox Beta artifacts
    run: npm run build:firefox -- --env stream=beta
  - uses: actions/upload-artifact@v4
    with:
      name: FirefoxExtensionBeta
      path: dist
  - uses: montudor/action-zip@0852c26906e00f8a315c704958823928d8018b28
    with:
      args: zip -qq -r ./builds/FirefoxExtensionBeta.zip ./dist

File: .github/workflows/release.yml Copy Chapter

name: Upload Release Build

on:
release:
types: [published]

jobs:

build:
name: Upload Release
runs-on: ubuntu-latest

steps:
  # Initialization
  - name: Checkout release branch w/submodules
    uses: actions/checkout@v5
    with:
      submodules: recursive
  - uses: actions/setup-node@v4
    with:
      node-version: '18'
  - name: Copy configuration
    run: cp config.json.example config.json

  # Create source artifact with submodule
  - name: Create directory
    run: cd ..; mkdir ./builds
  - name: Zip Source code
    run: zip -r ../builds/SourceCodeUseThisOne.zip *
  - name: Upload Source to release
    uses: Shopify/upload-to-release@07611424e04f1475ddf550e1c0dd650b867d5467
    with:
      args: ../builds/SourceCodeUseThisOne.zip
      name: SourceCodeUseThisOne.zip
      path: ../builds/SourceCodeUseThisOne.zip
      repo-token: ${{ secrets.GITHUB_TOKEN }}

  - name: Checkout source maps branch
    uses: actions/checkout@v5
    with:
      path: source-maps
      ref: source-maps
  - name: Set up committer info
    run: |
      git config --global user.name "github-actions[bot]"
      git config --global user.email "41898282+github-actions[bot]@users.noreply.github.com"
  - run: npm ci

  # Create Firefox artifacts
  - name: Create Firefox artifacts
    run: npm run build:firefox -- --env ghpSourceMaps
  - run: mkdir ./builds
  - name: Move Firefox source maps to source map repo
    run: |
      VERSION=`jq -r '.version' ./dist/manifest.json`
      mkdir -p "./source-maps/firefox/$VERSION/"
      mv -v ./dist/**/*.js.map "./source-maps/firefox/$VERSION/"
      cp -v ./dist/**/*.js.LICENSE.txt "./source-maps/firefox/$VERSION/"
  - name: Zip Artifacts
    run: cd ./dist ; zip -r ../builds/FirefoxExtension.zip *
  - name: Upload FirefoxExtension to release
    uses: Shopify/upload-to-release@07611424e04f1475ddf550e1c0dd650b867d5467
    with:
      args: builds/FirefoxExtension.zip
      name: FirefoxExtension.zip
      path: ./builds/FirefoxExtension.zip
      repo-token: ${{ secrets.GITHUB_TOKEN }}
  
  # Create Chrome artifacts
  - name: Create Chrome artifacts
    run: npm run build:chrome -- --env ghpSourceMaps
  - name: Move Chrome source maps to source map repo
    run: |
      VERSION=`jq -r '.version' ./dist/manifest.json`
      mkdir -p "./source-maps/chrome/$VERSION/"
      mv -v ./dist/**/*.js.map "./source-maps/chrome/$VERSION/"
      cp -v ./dist/**/*.js.LICENSE.txt "./source-maps/chrome/$VERSION/"
  - name: Zip Artifacts
    run: cd ./dist ; zip -r ../builds/ChromeExtension.zip *
  - name: Upload ChromeExtension to release
    uses: Shopify/upload-to-release@07611424e04f1475ddf550e1c0dd650b867d5467
    with:
      args: builds/ChromeExtension.zip
      name: ChromeExtension.zip
      path: ./builds/ChromeExtension.zip
      repo-token: ${{ secrets.GITHUB_TOKEN }}

  # Create Edge artifacts
  - name: Clear dist for Edge
    run: rm -rf ./dist
  - name: Create Edge artifacts
    run: npm run build:edge -- --env ghpSourceMaps
  - name: Move Edge source maps to source map repo
    run: |
      VERSION=`jq -r '.version' ./dist/manifest.json`
      mkdir -p "./source-maps/edge/$VERSION/"
      mv -v ./dist/**/*.js.map "./source-maps/edge/$VERSION/"
      cp -v ./dist/**/*.js.LICENSE.txt "./source-maps/edge/$VERSION/"
  - name: Zip Artifacts
    run: cd ./dist ; zip -r ../builds/EdgeExtension.zip *
  - name: Upload EdgeExtension to release
    uses: Shopify/upload-to-release@07611424e04f1475ddf550e1c0dd650b867d5467
    with:
      args: builds/EdgeExtension.zip
      name: EdgeExtension.zip
      path: ./builds/EdgeExtension.zip
      repo-token: ${{ secrets.GITHUB_TOKEN }}

  # Create Safari artifacts
  - name: Create Safari artifacts
    run: npm run build:safari -- --env ghpSourceMaps
  - name: Move Safari source maps to source map repo
    run: |
      VERSION=`jq -r '.version' ./dist/manifest.json`
      mkdir -p "./source-maps/safari/$VERSION/"
      mv -v ./dist/**/*.js.map "./source-maps/safari/$VERSION/"
      cp -v ./dist/**/*.js.LICENSE.txt "./source-maps/safari/$VERSION/"
  - name: Zip Artifacts
    run: cd ./dist ; zip -r ../builds/SafariExtension.zip *
  - name: Upload SafariExtension to release
    uses: Shopify/upload-to-release@07611424e04f1475ddf550e1c0dd650b867d5467
    with:
      args: builds/SafariExtension.zip
      name: SafariExtension.zip
      path: ./builds/SafariExtension.zip
      repo-token: ${{ secrets.GITHUB_TOKEN }}

  # Create Beta artifacts (Builds with the name changed to beta)
  - name: Create Chrome Beta artifacts
    run: npm run build:chrome -- --env stream=beta --env ghpSourceMaps
  - name: Move Chrome Beta source maps to source map repo
    run: |
      VERSION=`jq -r '.version' ./dist/manifest.json`
      mkdir -p "./source-maps/chrome-beta/$VERSION/"
      mv -v ./dist/**/*.js.map "./source-maps/chrome-beta/$VERSION/"
      cp -v ./dist/**/*.js.LICENSE.txt "./source-maps/chrome-beta/$VERSION/"
  - name: Zip Artifacts
    run: cd ./dist ; zip -r ../builds/ChromeExtensionBeta.zip *
  - name: Upload ChromeExtensionBeta to release
    uses: Shopify/upload-to-release@07611424e04f1475ddf550e1c0dd650b867d5467
    with:
      args: builds/ChromeExtensionBeta.zip
      name: ChromeExtensionBeta.zip
      path: ./builds/ChromeExtensionBeta.zip
      repo-token: ${{ secrets.GITHUB_TOKEN }}

  # Firefox Beta
  - name: Create Firefox Beta artifacts
    run: npm run build:firefox -- --env stream=beta --env autoupdate --env ghpSourceMaps
  - uses: actions/upload-artifact@v4
    with:
      name: FirefoxExtensionBeta
      path: dist
  - name: Move Firefox Beta source maps to source map repo
    run: |
      VERSION=`jq -r '.version' ./dist/manifest.json`
      mkdir -p "./source-maps/firefox-beta/$VERSION/"
      mv -v ./dist/**/*.js.map "./source-maps/firefox-beta/$VERSION/"
      cp -v ./dist/**/*.js.LICENSE.txt "./source-maps/firefox-beta/$VERSION/"
  - name: Zip Artifacts
    run: cd ./dist ; zip -r ../builds/FirefoxExtensionBeta.zip *

  # Create Firefox Signed Beta version
  - name: Create Firefox Signed Beta artifacts
    run: npm run web-sign
    env:
      WEB_EXT_API_KEY: ${{ secrets.WEB_EXT_API_KEY }}
      WEB_EXT_API_SECRET: ${{ secrets.WEB_EXT_API_SECRET }}
  - name: Rename signed file
    run: mv ./web-ext-artifacts/* ./web-ext-artifacts/FirefoxSignedInstaller.xpi
  - uses: actions/upload-artifact@v4
    with:
      name: FirefoxExtensionSigned.xpi
      path: ./web-ext-artifacts/FirefoxSignedInstaller.xpi

  - name: Upload FirefoxSignedInstaller.xpi to release
    uses: Shopify/upload-to-release@07611424e04f1475ddf550e1c0dd650b867d5467
    with:
      args: web-ext-artifacts/FirefoxSignedInstaller.xpi
      name: FirefoxSignedInstaller.xpi
      path: ./web-ext-artifacts/FirefoxSignedInstaller.xpi
      repo-token: ${{ secrets.GITHUB_TOKEN }}

  - name: Commit & push new source maps
    if: always()
    run: |
      VERSION=`jq -r '.version' ./dist/manifest.json`
      cd ./source-maps
      git add .
      git commit -m "Publish source maps for version $VERSION"
      git push

  - name: Prepare new github pages deployment
    shell: python
    run: |
      from pathlib import Path
      import json
      import shutil
      import os

      # config stuff
      installer_name = "FirefoxSignedInstaller.xpi"
      owner, repo_name = os.environ["GITHUB_REPOSITORY"].split("/")
      owner = owner.lower()

      # create the github paged dir
      ghp_dir = Path("./github-pages")
      ghp_dir.mkdir(parents=True, exist_ok=True)

      # move in the installer
      Path("./web-ext-artifacts", installer_name).rename(ghp_dir / installer_name)

      # read manifest.json and extract parameters
      with open("./dist/manifest.json") as f:
        manifest = json.load(f)
      current_version = manifest["version"]
      ext_id = manifest["browser_specific_settings"]["gecko"]["id"]

      # generate updates file
      updates = {
        "addons": {
          ext_id: {
            "updates": [
              {
                "version": current_version,
                # param doesn't actually matter, it's just a cachebuster
                "update_link": f"https://{owner}.github.io/{repo_name}/{installer_name}?v={current_version}",
              },
            ],
          },
        },
      }
      (ghp_dir / "updates.json").write_text(json.dumps(updates))

      # copy in source maps
      def only_sourcemaps(cur, ls):
        if '/' in cur:
          return []
        return set(ls) - {"chrome", "chrome-beta", "edge", "firefox", "firefox-beta", "safari"}
      shutil.copytree("source-maps", ghp_dir, ignore=only_sourcemaps, dirs_exist_ok=True)

  - name: Upload new github pages deployment
    uses: actions/upload-pages-artifact@v3
    with:
      path: ./github-pages

deploy-ghp:
name: Deploy to github pages
needs: build
permissions:
id-token: write
pages: write
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
runs-on: ubuntu-latest
steps:
- name: Deploy
id: deployment
uses: actions/deploy-pages@v4

File: .github/workflows/take-action.yml Copy Chapter

.github/workflows/take.yml

name: Assign issue to contributor
on:
issue_comment:

jobs:
assign:
name: Take an issue
runs-on: ubuntu-latest
steps:
- name: take the issue
uses: bdougie/take-action@28b86cd8d25593f037406ecbf96082db2836e928
env:
GITHUB_TOKEN: ${{ github.token }}

File: .github/workflows/tests.yml Copy Chapter

name: Tests

on: [push, pull_request]

jobs:
test:
name: Run tests
runs-on: ubuntu-latest

steps:
  # Initialization
  - uses: actions/checkout@v4
    with:
      submodules: recursive
  - uses: actions/setup-node@v4
    with:
      node-version: '18'
  - run: npm ci
  
  - name: Copy configuration
    run: cp config.json.example config.json

  - name: Set up WireGuard Connection
    uses: niklaskeerl/easy-wireguard-action@50341d5f4b8245ff3a90e278aca67b2d283c78d0
    with:
      WG_CONFIG_FILE: ${{ secrets.WG_CONFIG_FILE }}

  - name: Run tests
    run: npm run test

  - name: Upload results on fail
    if: ${{ failure() }}
    uses: actions/upload-artifact@v4
    with:
      name: Test Results
      path: ./test-results

File: .github/workflows/update-oss-attribution.yml Copy Chapter

name: update oss attributions
on:
push:
branches:
- master
paths:
- 'package.json'
- 'package-lock.json'
workflow_dispatch:

jobs:
update-oss:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
submodules: recursive
- uses: actions/setup-node@v4
with:
node-version: '18'
- name: Install and generate attribution
run: |
npm ci
npm i oss-attribution-generator
generate-attribution
mv ./oss-attribution/attribution.txt ./public/oss-attribution/attribution.txt
- name: Prettify attributions
run: |
cd ci && npx ts-node prettify.ts

- name: Create pull request to update list
    uses: peter-evans/create-pull-request@v7
    # v4.2.3
    with:
      commit-message: Update OSS Attribution
      author: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
      branch: ci/oss_attribution
      title: Update OSS Attribution
      body: Automated OSS Attribution update

File: .github/workflows/updateInvidous.yml Copy Chapter

name: update invidious
on:
workflow_dispatch:
schedule:
- cron: '0 0 1 * *' # check every month

jobs:
check-list:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
with:
submodules: recursive
- name: Download instance lists
run: |
wget https://api.invidious.io/instances.json -O ci/invidious_instances.json
wget https://github.com/TeamPiped/piped-uptime/raw/master/history/summary.json -O ci/piped_instances.json
- name: Install dependencies
run: npm ci
- name: "Run CI"
run: npm run ci:invidious

- name: Create pull request to update list
    uses: peter-evans/create-pull-request@v7
    # v4.2.3
    with:
      commit-message: Update Invidious List
      author: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
      branch: ci/update_invidious_list
      title: Update Invidious List
      body: Automated Invidious list update