uBlock/platform/mv3
Raymond Hill 98b011f64c
[mv3] Add support for explicit generichide filter option
`generichide` option is implicitly enforced on all sites unless an
exception overrides `generichide`. Though rare, sometimes a
`generichide` exception needs to be overridden so that generic
cosmetic filtering is made possible on a specific site.

This commit is to add support for restoring generic cosmetic
filtering on sites which were excluded through a `generichide`
exception.

Concretely, this is needed to ensure the test suite can properly
verify that generic cosmetic filtering is working when the
filtering mode is set to "complete":

||ublockorigin.github.io^$generichide,important
2025-03-18 17:15:35 -04:00
..
chromium [mv3] Extend strict-blocking coverage; improve URL-skip behavior 2024-12-29 16:38:56 -05:00
description Import translation work from https://crowdin.com/project/ublock 2025-03-06 09:59:35 -05:00
extension [mv3] Add support for explicit generichide filter option 2025-03-18 17:15:35 -04:00
firefox [mv3] Remove obsolete Firefox workaround code 2025-02-22 11:07:58 -05: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 for explicit generichide filter option 2025-03-18 17:15:35 -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 2024-09-27 11:04:42 -04:00
safe-replace.js Better integrate latest eslint version 2025-01-10 10:25:15 -05:00
salvage-ruleids.mjs Fix the salvaging of rule ids 2024-03-11 22:22:57 -04:00

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 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 [2] c4d324362f/tools/make-mv3.sh (L103)