Mirrors
/
uBlock
mirror of https://github.com/gorhill/uBlock.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
uBlock/platform/mv3
History
Raymond Hill ba8820fe31
Import translation work from https://crowdin.com/project/ublock 		2023-09-08 09:19:26 -04:00
..
chromium [mv3] Add support for admin configurations 2023-06-13 11:40:41 -04:00
description Import translation work from https://crowdin.com/project/ublock 2023-09-08 09:19:26 -04:00
extension Import translation work from https://crowdin.com/project/ublock 2023-09-08 09:19:26 -04:00
firefox [mv3] Put icon in nav bar by default 2023-08-20 09:35:16 -04:00
scriptlets Typo 2023-08-19 19:56:00 -04:00
README.md Update README.md 2023-08-12 08:06:31 -04:00
make-rulesets.js [mv3] Add support for converting `^responseheader()` filters to DNR 2023-08-19 07:48:14 -04:00
make-scriptlets.js [mv3] Use workaround to inject scriptlets in Firefox 2023-08-11 13:22:25 -04:00
package.json Add experimental mv3 version 2022-09-06 13:47:52 -04:00
safe-replace.js [mv3] Avoid String.replace() to safely replace templates 2023-06-05 20:17:50 -04:00
ubo-version [mv3] Point to new uBO version 2023-08-20 08:54:32 -04:00

README.md

How to build MV3 uBO Lite

Instructions for reviewers.

The following assumes a linux environment.

  1. Open Bash console
  2. git clone https://github.com/gorhill/uBlock.git
  3. cd uBlock
  4. make mv3-[platform], where [platform] is either chromium or firefox
  5. This will fully build uBO Lite, and during the process filter lists will be downloaded from their respective remote servers

Upon completion of the script, the resulting extension package will become present in:

  • Chromium: dist/build/uBOLite.chromium
  • Firefox: dist/build/uBOLite.firefox

The folder dist/build/mv3-data will cache data fetched from remote server, so as to avoid fetching repeatedly from remote server with repeated build commands. Remove dist/build/mv3-data if you want to build with latest versions of filter lists.

The file dist/build/mv3-data/log.txt will contain information about what happened during the build process.

The entry in the Makefile which implement the build process is tools/make-mv3.sh [platform].[1] This Bash script copy various files from uBlock Origin branch and MV3-specific branch into a single folder which will be the final extension package.

Notably, tools/make-mv3.sh [platform] calls a Nodejs script which purpose is to convert the filter lists into various rulesets to be used in a declarative way. The Nodejs version required is 17.5.0 or above.

All the final rulesets are present in the dist/build/uBOLite.[platform]/rulesets in the final extension package.

[1] c4d324362f/tools/make-mv3.sh [2] c4d324362f/tools/make-mv3.sh (L103)