prehistoric-systems/uBlock
1
0
Fork 0
mirror of https://github.com/gorhill/uBlock.git synced 2026-03-11 09:04:36 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
uBlock/platform/mv3
History
Raymond Hill 8bcf533fc0
[mv3] Code review of uBO filter converter 
Related commit:
e8fb0e1cc9
2025-06-22 17:06:35 -04:00
..
chromium [mv3] New approach to toggle toolbar icon not requiring extra permissions 2025-05-07 08:53:59 -04:00
description Import translation work from https://crowdin.com/project/ublock 2025-06-11 15:23:14 -04:00
edge [mv3] Safari works; use 3-component version for uBOL 2025-05-08 16:53:07 -04:00
extension [mv3] Code review of uBO filter converter 2025-06-22 17:06:35 -04:00
firefox [mv3] Firefox doesn't yet support condition.responseHeaders 2025-06-11 09:40:52 -04:00
safari [mv3] Revert trying to transpose requestDomains 2025-06-12 09:32:59 -04:00
scriptlets [mv3] Eliminate false positives in new generic cosmetic exception code 2025-03-13 19:02:20 -04:00
make-rulesets.js [mv3] Add support to exclude lists from specific platforms 2025-06-22 12:07:06 -04:00
make-scriptlets.js [mv3] Add support for ancestor context syntax in scriptlets 2025-03-07 17:04:02 -05:00
package.json Add experimental mv3 version 2022-09-06 13:47:52 -04:00
README.md Update README.md 2025-06-10 09:37:01 -04:00
rulesets.json [mv3] Add support to exclude lists from specific platforms 2025-06-22 12:07:06 -04:00
safe-replace.js Better integrate latest eslint version 2025-01-10 10:25:15 -05:00
salvage-ruleids.mjs [mv3] Fix safari build script 2025-04-19 14:39:00 -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. git submodule init
  5. git submodule update
  6. make mv3-[platform], where [platform] is either chromium, edge, firefox, or safari
  7. 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
  • Edge: dist/build/uBOLite.edge
  • Firefox: dist/build/uBOLite.firefox
  • Safari: dist/build/uBOLite.safari

The folder dist/build/mv3-data will cache data fetched from remote servers, so as to avoid fetching repeatedly from remote servers with repeated build commands. Use make cleanassets to remove all locally cached filter lists 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