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/Makefile

106 lines
2.5 KiB
Makefile
Raw Normal View History

Add platform "dig", to experiment/validate code changes This is a replacement for the dubious approach when the extension itself was used to run benchmarks to detect performance and filtering behavior regressions.
2021-08-15 19:47:40 +00:00
# https://stackoverflow.com/a/6273809
run_options := $(filter-out $@,$(MAKECMDGOALS))
[mv3] Add support to add/remove rulesets through policies Related discussion: https://github.com/uBlockOrigin/uBOL-home/discussions/35#discussioncomment-11157444 New policy setting: `rulesets` Type: array Type of array items: string Each item in the list is a list id (as seen in `rulesets/ruleset-details.json`), prefixed with either `+` to enable the ruleset, or `-` to disable the ruleset. Users will not be able to enable or disable rulesets present in the `rulesets` policy. Disabled rulesets will not appear in the dashboard. Use `-*` to remove all non-default rulesets, except for those added using `+[ruleset_id]`. Additionally, some work has been done to properly handle policy changes in a non-blocking and deferred manner, as I observed that it often takes long for calls to `storage.manage.get` to resolve. This potentailly takes care of the following issue: https://github.com/uBlockOrigin/uBOL-home/issues/174
2024-11-11 18:20:54 +00:00
.PHONY: all clean cleanassets test lint chromium opera firefox npm dig \
Use "make mv3-edge" to build Edge package
2025-03-08 15:43:59 +00:00
mv3-chromium mv3-firefox mv3-edge \
Add median cost output to dig-snfe
2021-08-29 12:58:20 +00:00
compare maxcost medcost mincost modifiers record wasm
Add Makefile (#3789)
2021-07-31 12:41:28 +00:00
Properly handle default list status changes in assets.json This commit fix properly handling toggling off the default status of a list such that the list will be automatically turned off when its status change from default to non-default. Additionally, imported lists which become stock lists will be properly migrated from imported lists section.
2023-03-23 17:40:51 +00:00
sources := $(wildcard assets/* assets/*/* dist/version src/* src/*/* src/*/*/* src/*/*/*/*)
Create a MVP version of uBOLite for Firefox What does not work at the time of commit: Cosmetic filtering does not work: The content scripts responsible for cosmetic filtering fail when trying to inject the stylesheets through document.adoptedStyleSheets, with the following error message: XrayWrapper denied access to property Symbol.iterator (reason: object is not safely Xrayable). See https://developer.mozilla.org/en-US/docs/Xray_vision for more information. ... css-declarative.js:106:8 A possible solution is to inject those content scripts in the MAIN world. However Firefox scripting API does not support MAIN world injection at the moment. Scriptlet-filtering does not work: Because scriptlet code needs to be injected in the MAIN world, and this is currently not supported by Firefox's scripting API, see https://bugzilla.mozilla.org/show_bug.cgi?id=1736575 There is no count badge on the toolbar icon in Firefox, as it currently does not support the `DNR.setExtensionActionOptions` method. Other than the above issues, it does appear uBO is blocking properly with no error reported in the dev console. The adoptedStyleSheets issue though is worrisome, as the cosmetic filtering content scripts were designed with ISOLATED world injection in mind. Being forced to inject in MAIN world (when available) make things a bit more complicated as uBO has to ensure it's global variables do not leak into the page.
2023-04-07 14:19:43 +00:00
platform := $(wildcard platform/* platform/*/* platform/*/*/* platform/*/*/*/* platform/*/*/*/*/*)
Use `git clone` instead of submodule to pull uAssets dependencies Related issue: - https://github.com/uBlockOrigin/uBlock-issues/issues/2358 We need two different branches of uAssets to properly add the default filter lists into the packages. I couldn't figure out how to do this with submodules, using simple `git clone` as a dependency just work.
2022-11-14 14:50:53 +00:00
assets := dist/build/uAssets
Add Makefile (#3789)
2021-07-31 12:41:28 +00:00
Add support for nodejs flavors The main nodejs flavor is "npm", which is to be used to lint/test and the publication of an official npm package -- and by design it has dependencies on mocha, eslint, etc. A new flavor "dig" has been created with minimal dependencies and which purpose is to easily allow to write specialized code to investigate local code changes in uBO -- and it's not meant for publication. Consequently, "make nodejs" has been replaced with "make npm", and a new "dig" target has been added to the makefile, to be used for instrumenting local code changes for investigation purpose.
2021-08-15 14:43:36 +00:00
all: chromium firefox npm
Add Makefile (#3789)
2021-07-31 12:41:28 +00:00
Add build script as a dependency Related discussion: - https://github.com/gorhill/uBlock/pull/3789#issuecomment-891902206
2021-08-03 15:27:55 +00:00
dist/build/uBlock0.chromium: tools/make-chromium.sh $(sources) $(platform) $(assets)
Add Makefile (#3789)
2021-07-31 12:41:28 +00:00
tools/make-chromium.sh
# Build the extension for Chromium.
chromium: dist/build/uBlock0.chromium
Add `opera` as a make target
2023-01-01 15:21:54 +00:00
dist/build/uBlock0.opera: tools/make-opera.sh $(sources) $(platform) $(assets)
tools/make-opera.sh
# Build the extension for Opera.
opera: dist/build/uBlock0.opera
Add build script as a dependency Related discussion: - https://github.com/gorhill/uBlock/pull/3789#issuecomment-891902206
2021-08-03 15:27:55 +00:00
dist/build/uBlock0.firefox: tools/make-firefox.sh $(sources) $(platform) $(assets)
Add Makefile (#3789)
2021-07-31 12:41:28 +00:00
tools/make-firefox.sh all
# Build the extension for Firefox.
firefox: dist/build/uBlock0.firefox
Add support for nodejs flavors The main nodejs flavor is "npm", which is to be used to lint/test and the publication of an official npm package -- and by design it has dependencies on mocha, eslint, etc. A new flavor "dig" has been created with minimal dependencies and which purpose is to easily allow to write specialized code to investigate local code changes in uBO -- and it's not meant for publication. Consequently, "make nodejs" has been replaced with "make npm", and a new "dig" target has been added to the makefile, to be used for instrumenting local code changes for investigation purpose.
2021-08-15 14:43:36 +00:00
dist/build/uBlock0.npm: tools/make-nodejs.sh $(sources) $(platform) $(assets)
tools/make-npm.sh
Add Makefile (#3789)
2021-07-31 12:41:28 +00:00
Fix makefile
2025-01-11 15:53:36 +00:00
npm: dist/build/uBlock0.npm
Better integrate latest eslint version
2025-01-09 14:33:22 +00:00
# Dev tools
Fix workflow and makefile
2025-01-10 16:08:54 +00:00
node_modules:
Better integrate latest eslint version
2025-01-09 14:33:22 +00:00
npm install
Add Makefile (#3789)
2021-07-31 12:41:28 +00:00
Fix makefile
2025-01-11 15:53:36 +00:00
init: node_modules
Fix workflow and makefile
2025-01-10 16:08:54 +00:00
Fix makefile
2025-01-11 15:53:36 +00:00
lint: init
Better integrate latest eslint version
2025-01-09 14:33:22 +00:00
npm run lint
Move linting out of tools/make-nodejs.sh (#3803)
2021-08-04 18:40:20 +00:00
Add support for nodejs flavors The main nodejs flavor is "npm", which is to be used to lint/test and the publication of an official npm package -- and by design it has dependencies on mocha, eslint, etc. A new flavor "dig" has been created with minimal dependencies and which purpose is to easily allow to write specialized code to investigate local code changes in uBO -- and it's not meant for publication. Consequently, "make nodejs" has been replaced with "make npm", and a new "dig" target has been added to the makefile, to be used for instrumenting local code changes for investigation purpose.
2021-08-15 14:43:36 +00:00
test: npm
Run npm install in make-npm.sh (#3831)
2021-08-16 16:34:54 +00:00
cd dist/build/uBlock0.npm && npm run test
Add support for nodejs flavors The main nodejs flavor is "npm", which is to be used to lint/test and the publication of an official npm package -- and by design it has dependencies on mocha, eslint, etc. A new flavor "dig" has been created with minimal dependencies and which purpose is to easily allow to write specialized code to investigate local code changes in uBO -- and it's not meant for publication. Consequently, "make nodejs" has been replaced with "make npm", and a new "dig" target has been added to the makefile, to be used for instrumenting local code changes for investigation purpose.
2021-08-15 14:43:36 +00:00
Add --full-battery option for tests (#3834)
2021-08-17 12:55:31 +00:00
test-full-battery: npm
cd dist/build/uBlock0.npm && npm run test-full-battery
Add check-leaks make target (#3837)
2021-08-18 11:28:23 +00:00
check-leaks: npm
cd dist/build/uBlock0.npm && npm run check-leaks
Add support for nodejs flavors The main nodejs flavor is "npm", which is to be used to lint/test and the publication of an official npm package -- and by design it has dependencies on mocha, eslint, etc. A new flavor "dig" has been created with minimal dependencies and which purpose is to easily allow to write specialized code to investigate local code changes in uBO -- and it's not meant for publication. Consequently, "make nodejs" has been replaced with "make npm", and a new "dig" target has been added to the makefile, to be used for instrumenting local code changes for investigation purpose.
2021-08-15 14:43:36 +00:00
dist/build/uBlock0.dig: tools/make-nodejs.sh $(sources) $(platform) $(assets)
tools/make-dig.sh
dig: dist/build/uBlock0.dig
Add platform "dig", to experiment/validate code changes This is a replacement for the dubious approach when the extension itself was used to run benchmarks to detect performance and filtering behavior regressions.
2021-08-15 19:47:40 +00:00
cd dist/build/uBlock0.dig && npm install
dig-snfe: dig
cd dist/build/uBlock0.dig && npm run snfe $(run_options)
Add test target to makefile (#3810)
2021-08-10 17:50:06 +00:00
Fix mv3 build commands
2025-03-08 18:39:53 +00:00
mv3-assets:
mkdir dist/build/mv3-data
dist/build/uBOLite.chromium: tools/make-mv3.sh $(sources) $(platform) mv3-assets
Create a MVP version of uBOLite for Firefox What does not work at the time of commit: Cosmetic filtering does not work: The content scripts responsible for cosmetic filtering fail when trying to inject the stylesheets through document.adoptedStyleSheets, with the following error message: XrayWrapper denied access to property Symbol.iterator (reason: object is not safely Xrayable). See https://developer.mozilla.org/en-US/docs/Xray_vision for more information. ... css-declarative.js:106:8 A possible solution is to inject those content scripts in the MAIN world. However Firefox scripting API does not support MAIN world injection at the moment. Scriptlet-filtering does not work: Because scriptlet code needs to be injected in the MAIN world, and this is currently not supported by Firefox's scripting API, see https://bugzilla.mozilla.org/show_bug.cgi?id=1736575 There is no count badge on the toolbar icon in Firefox, as it currently does not support the `DNR.setExtensionActionOptions` method. Other than the above issues, it does appear uBO is blocking properly with no error reported in the dev console. The adoptedStyleSheets issue though is worrisome, as the cosmetic filtering content scripts were designed with ISOLATED world injection in mind. Being forced to inject in MAIN world (when available) make things a bit more complicated as uBO has to ensure it's global variables do not leak into the page.
2023-04-07 14:19:43 +00:00
tools/make-mv3.sh chromium
[mv3] Add support to add/remove rulesets through policies Related discussion: https://github.com/uBlockOrigin/uBOL-home/discussions/35#discussioncomment-11157444 New policy setting: `rulesets` Type: array Type of array items: string Each item in the list is a list id (as seen in `rulesets/ruleset-details.json`), prefixed with either `+` to enable the ruleset, or `-` to disable the ruleset. Users will not be able to enable or disable rulesets present in the `rulesets` policy. Disabled rulesets will not appear in the dashboard. Use `-*` to remove all non-default rulesets, except for those added using `+[ruleset_id]`. Additionally, some work has been done to properly handle policy changes in a non-blocking and deferred manner, as I observed that it often takes long for calls to `storage.manage.get` to resolve. This potentailly takes care of the following issue: https://github.com/uBlockOrigin/uBOL-home/issues/174
2024-11-11 18:20:54 +00:00
mv3-chromium: dist/build/uBOLite.chromium
Fix mv3 build commands
2025-03-08 18:39:53 +00:00
dist/build/uBOLite.firefox: tools/make-mv3.sh $(sources) $(platform) mv3-assets
Create a MVP version of uBOLite for Firefox What does not work at the time of commit: Cosmetic filtering does not work: The content scripts responsible for cosmetic filtering fail when trying to inject the stylesheets through document.adoptedStyleSheets, with the following error message: XrayWrapper denied access to property Symbol.iterator (reason: object is not safely Xrayable). See https://developer.mozilla.org/en-US/docs/Xray_vision for more information. ... css-declarative.js:106:8 A possible solution is to inject those content scripts in the MAIN world. However Firefox scripting API does not support MAIN world injection at the moment. Scriptlet-filtering does not work: Because scriptlet code needs to be injected in the MAIN world, and this is currently not supported by Firefox's scripting API, see https://bugzilla.mozilla.org/show_bug.cgi?id=1736575 There is no count badge on the toolbar icon in Firefox, as it currently does not support the `DNR.setExtensionActionOptions` method. Other than the above issues, it does appear uBO is blocking properly with no error reported in the dev console. The adoptedStyleSheets issue though is worrisome, as the cosmetic filtering content scripts were designed with ISOLATED world injection in mind. Being forced to inject in MAIN world (when available) make things a bit more complicated as uBO has to ensure it's global variables do not leak into the page.
2023-04-07 14:19:43 +00:00
tools/make-mv3.sh firefox
Add experimental mv3 version This create a separate Chromium extension, named "uBO Minus (MV3)". This experimental mv3 version supports only the blocking of network requests through the declarativeNetRequest API, so as to abide by the stated MV3 philosophy of not requiring broad "read/modify data" permission. Accordingly, the extension should not trigger the warning at installation time: Read and change all your data on all websites The consequences of being permission-less are the following: - No cosmetic filtering (##) - No scriptlet injection (##+js) - No redirect= filters - No csp= filters - No removeparam= filters At this point there is no popup panel or options pages. The default filterset correspond to the default filterset of uBO proper: Listset for 'default': https://ublockorigin.github.io/uAssets/filters/badware.txt https://ublockorigin.github.io/uAssets/filters/filters.txt https://ublockorigin.github.io/uAssets/filters/filters-2020.txt https://ublockorigin.github.io/uAssets/filters/filters-2021.txt https://ublockorigin.github.io/uAssets/filters/filters-2022.txt https://ublockorigin.github.io/uAssets/filters/privacy.txt https://ublockorigin.github.io/uAssets/filters/quick-fixes.txt https://ublockorigin.github.io/uAssets/filters/resource-abuse.txt https://ublockorigin.github.io/uAssets/filters/unbreak.txt https://easylist.to/easylist/easylist.txt https://easylist.to/easylist/easyprivacy.txt https://malware-filter.gitlab.io/malware-filter/urlhaus-filter-online.txt https://pgl.yoyo.org/adservers/serverlist.php?hostformat=hosts&showintro=1&mimetype=plaintext The result of the conversion of the filters in all these filter lists is as follow: Ruleset size for 'default': 22245 Good: 21408 Maybe good (regexes): 127 redirect-rule= (discarded): 458 csp= (discarded): 85 removeparams= (discarded): 22 Unsupported: 145 The fact that the number of DNR rules are far lower than the number of network filters reported in uBO comes from the fact that lists-to-rulesets converter does its best to coallesce filters into minimal set of rules. Notably, the DNR's requestDomains condition property allows to create a single DNR rule out of all pure hostname-based filters. Regex-based rules are dynamically added at launch time since they must be validated as valid DNR regexes through isRegexSupported() API call. At this point I consider being permission-less the limiting factor: if broad "read/modify data" permission is to be used, than there is not much point for an MV3 version over MV2, just use the MV2 version if you want to benefit all the features which can't be implemented without broad "read/modify data" permission. To locally build the MV3 extension: make mv3 Then load the resulting extension directory in the browser using the "Load unpacked" button. From now on there will be a uBlock0.mv3.zip package available in each release.
2022-09-06 17:47:52 +00:00
[mv3] Add support to add/remove rulesets through policies Related discussion: https://github.com/uBlockOrigin/uBOL-home/discussions/35#discussioncomment-11157444 New policy setting: `rulesets` Type: array Type of array items: string Each item in the list is a list id (as seen in `rulesets/ruleset-details.json`), prefixed with either `+` to enable the ruleset, or `-` to disable the ruleset. Users will not be able to enable or disable rulesets present in the `rulesets` policy. Disabled rulesets will not appear in the dashboard. Use `-*` to remove all non-default rulesets, except for those added using `+[ruleset_id]`. Additionally, some work has been done to properly handle policy changes in a non-blocking and deferred manner, as I observed that it often takes long for calls to `storage.manage.get` to resolve. This potentailly takes care of the following issue: https://github.com/uBlockOrigin/uBOL-home/issues/174
2024-11-11 18:20:54 +00:00
mv3-firefox: dist/build/uBOLite.firefox
Fix mv3 build commands
2025-03-08 18:39:53 +00:00
dist/build/uBOLite.edge: tools/make-mv3.sh tools/make-edge.mjs $(sources) $(platform) mv3-assets
Use "make mv3-edge" to build Edge package
2025-03-08 15:43:59 +00:00
tools/make-mv3.sh edge
[mv3] Add ability to enable/disable filter lists
2022-09-13 21:44:24 +00:00
Use "make mv3-edge" to build Edge package
2025-03-08 15:43:59 +00:00
mv3-edge: dist/build/uBOLite.edge
Add experimental mv3 version This create a separate Chromium extension, named "uBO Minus (MV3)". This experimental mv3 version supports only the blocking of network requests through the declarativeNetRequest API, so as to abide by the stated MV3 philosophy of not requiring broad "read/modify data" permission. Accordingly, the extension should not trigger the warning at installation time: Read and change all your data on all websites The consequences of being permission-less are the following: - No cosmetic filtering (##) - No scriptlet injection (##+js) - No redirect= filters - No csp= filters - No removeparam= filters At this point there is no popup panel or options pages. The default filterset correspond to the default filterset of uBO proper: Listset for 'default': https://ublockorigin.github.io/uAssets/filters/badware.txt https://ublockorigin.github.io/uAssets/filters/filters.txt https://ublockorigin.github.io/uAssets/filters/filters-2020.txt https://ublockorigin.github.io/uAssets/filters/filters-2021.txt https://ublockorigin.github.io/uAssets/filters/filters-2022.txt https://ublockorigin.github.io/uAssets/filters/privacy.txt https://ublockorigin.github.io/uAssets/filters/quick-fixes.txt https://ublockorigin.github.io/uAssets/filters/resource-abuse.txt https://ublockorigin.github.io/uAssets/filters/unbreak.txt https://easylist.to/easylist/easylist.txt https://easylist.to/easylist/easyprivacy.txt https://malware-filter.gitlab.io/malware-filter/urlhaus-filter-online.txt https://pgl.yoyo.org/adservers/serverlist.php?hostformat=hosts&showintro=1&mimetype=plaintext The result of the conversion of the filters in all these filter lists is as follow: Ruleset size for 'default': 22245 Good: 21408 Maybe good (regexes): 127 redirect-rule= (discarded): 458 csp= (discarded): 85 removeparams= (discarded): 22 Unsupported: 145 The fact that the number of DNR rules are far lower than the number of network filters reported in uBO comes from the fact that lists-to-rulesets converter does its best to coallesce filters into minimal set of rules. Notably, the DNR's requestDomains condition property allows to create a single DNR rule out of all pure hostname-based filters. Regex-based rules are dynamically added at launch time since they must be validated as valid DNR regexes through isRegexSupported() API call. At this point I consider being permission-less the limiting factor: if broad "read/modify data" permission is to be used, than there is not much point for an MV3 version over MV2, just use the MV2 version if you want to benefit all the features which can't be implemented without broad "read/modify data" permission. To locally build the MV3 extension: make mv3 Then load the resulting extension directory in the browser using the "Load unpacked" button. From now on there will be a uBlock0.mv3.zip package available in each release.
2022-09-06 17:47:52 +00:00
Use `git clone` instead of submodule to pull uAssets dependencies Related issue: - https://github.com/uBlockOrigin/uBlock-issues/issues/2358 We need two different branches of uAssets to properly add the default filter lists into the packages. I couldn't figure out how to do this with submodules, using simple `git clone` as a dependency just work.
2022-11-14 14:50:53 +00:00
dist/build/uAssets:
tools/pull-assets.sh
Add update-submodules as a target
2021-07-31 18:50:31 +00:00
Add Makefile (#3789)
2021-07-31 12:41:28 +00:00
clean:
Fix workflow and makefile
2025-01-10 16:08:54 +00:00
rm -rf dist/build tmp/node_modules node_modules
Add platform "dig", to experiment/validate code changes This is a replacement for the dubious approach when the extension itself was used to run benchmarks to detect performance and filtering behavior regressions.
2021-08-15 19:47:40 +00:00
Add ability to clean dist/build/[assets-related folders]
2024-02-25 23:27:07 +00:00
cleanassets:
rm -rf dist/build/mv3-data dist/build/uAssets
Add platform "dig", to experiment/validate code changes This is a replacement for the dubious approach when the extension itself was used to run benchmarks to detect performance and filtering behavior regressions.
2021-08-15 19:47:40 +00:00
# Not real targets, just convenient for auto-completion at shell prompt
compare:
@echo
maxcost:
@echo
Add median cost output to dig-snfe
2021-08-29 12:58:20 +00:00
medcost:
@echo
Add platform "dig", to experiment/validate code changes This is a replacement for the dubious approach when the extension itself was used to run benchmarks to detect performance and filtering behavior regressions.
2021-08-15 19:47:40 +00:00
mincost:
@echo
Expose matchAndFetchModifiers() in npm package Also, add instrumentation for the method in dig-snfe.
2021-08-17 16:48:39 +00:00
modifiers:
@echo
Add platform "dig", to experiment/validate code changes This is a replacement for the dubious approach when the extension itself was used to run benchmarks to detect performance and filtering behavior regressions.
2021-08-15 19:47:40 +00:00
record:
@echo
wasm:
@echo
Reference in a new issue Copy permalink