external/uBlock
1
0
Fork 0
mirror of https://github.com/gorhill/uBlock.git synced 2024-11-10 01:02:08 +01:00
Code Issues Projects Releases Packages Wiki Activity
uBlock/platform/mv3
History
Raymond Hill f049aea65e
Provide instructions on how to build uBO Lite 
Required by AMO when submitting an extension to be hosted on AMO.
2023-08-12 08:02:42 -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-07-17 09:36:56 -04:00
extension [mv3] Use workaround to inject scriptlets in Firefox 2023-08-11 13:22:25 -04:00
firefox [mv3] Fix strict_min_version for Firefox 2023-07-13 18:02:10 -04:00
scriptlets Comment 2023-08-11 17:55:29 -04:00
make-rulesets.js Provide instructions on how to build uBO Lite 2023-08-12 08:02:42 -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
README.md Provide instructions on how to build uBO Lite 2023-08-12 08:02:42 -04:00
safe-replace.js [mv3] Avoid String.replace() to safely replace templates 2023-06-05 20:17:50 -04:00
ubo-version Provide instructions on how to build uBO Lite 2023-08-12 08:02:42 -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.[2] 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)