external/uBlock
1
0
Fork 0
mirror of https://github.com/gorhill/uBlock.git synced 2024-11-10 09:07:54 +01:00
Code Issues Projects Releases Packages Wiki Activity
uBlock/tools/make-nodejs.sh

74 lines
2.5 KiB
Bash
Raw Normal View History

Revert "Pass -e flag to bash (#3790)" This reverts commit bb2015949516346edb137384882022f839a187d2.
2021-07-31 20:49:32 +02:00
#!/usr/bin/env bash
Modularize codebase with export/import Related issue: - https://github.com/uBlockOrigin/uBlock-issues/issues/1664 The changes are enough to fulfill the related issue. A new platform has been added in order to allow for building a NodeJS package. From the root of the project: ./tools/make-nodejs This will create new uBlock0.nodejs directory in the ./dist/build directory, which is a valid NodeJS package. From the root of the package, you can try: node test This will instantiate a static network filtering engine, populated by easylist and easyprivacy, which can be used to match network requests by filling the appropriate filtering context object. The test.js file contains code which is typical example of usage of the package. Limitations: the NodeJS package can't execute the WASM versions of the code since the WASM module requires the use of fetch(), which is not available in NodeJS. This is a first pass at modularizing the codebase, and while at it a number of opportunistic small rewrites have also been made. This commit requires the minimum supported version for Chromium and Firefox be raised to 61 and 60 respectively.
2021-07-25 16:55:35 +02:00
#
# This script assumes a linux environment
Use set -e in Bash scripts (#3791)
2021-07-31 23:34:25 +02:00
set -e
Modularize codebase with export/import Related issue: - https://github.com/uBlockOrigin/uBlock-issues/issues/1664 The changes are enough to fulfill the related issue. A new platform has been added in order to allow for building a NodeJS package. From the root of the project: ./tools/make-nodejs This will create new uBlock0.nodejs directory in the ./dist/build directory, which is a valid NodeJS package. From the root of the package, you can try: node test This will instantiate a static network filtering engine, populated by easylist and easyprivacy, which can be used to match network requests by filling the appropriate filtering context object. The test.js file contains code which is typical example of usage of the package. Limitations: the NodeJS package can't execute the WASM versions of the code since the WASM module requires the use of fetch(), which is not available in NodeJS. This is a first pass at modularizing the codebase, and while at it a number of opportunistic small rewrites have also been made. This commit requires the minimum supported version for Chromium and Firefox be raised to 61 and 60 respectively.
2021-07-25 16:55:35 +02:00
DES=dist/build/uBlock0.nodejs
Create build folder in npm install script (#3799)
2021-08-03 13:02:48 +02:00
rm -rf $DES
Modularize codebase with export/import Related issue: - https://github.com/uBlockOrigin/uBlock-issues/issues/1664 The changes are enough to fulfill the related issue. A new platform has been added in order to allow for building a NodeJS package. From the root of the project: ./tools/make-nodejs This will create new uBlock0.nodejs directory in the ./dist/build directory, which is a valid NodeJS package. From the root of the package, you can try: node test This will instantiate a static network filtering engine, populated by easylist and easyprivacy, which can be used to match network requests by filling the appropriate filtering context object. The test.js file contains code which is typical example of usage of the package. Limitations: the NodeJS package can't execute the WASM versions of the code since the WASM module requires the use of fetch(), which is not available in NodeJS. This is a first pass at modularizing the codebase, and while at it a number of opportunistic small rewrites have also been made. This commit requires the minimum supported version for Chromium and Firefox be raised to 61 and 60 respectively.
2021-07-25 16:55:35 +02:00
mkdir -p $DES/js
cp src/js/base64-custom.js $DES/js
cp src/js/biditrie.js $DES/js
Export the rule-based filtering engines to the nodejs package The code exported to nodejs package was revised to use modern JavaScript syntax. A few issues were fixed at the same time. The exported classes are: - DynamicHostRuleFiltering - DynamicURLRuleFiltering - DynamicSwitchRuleFiltering These related to the content the of "My rules" pane in the uBlock Origin extension.
2021-08-03 18:19:25 +02:00
cp src/js/dynamic-net-filtering.js $DES/js
Modularize codebase with export/import Related issue: - https://github.com/uBlockOrigin/uBlock-issues/issues/1664 The changes are enough to fulfill the related issue. A new platform has been added in order to allow for building a NodeJS package. From the root of the project: ./tools/make-nodejs This will create new uBlock0.nodejs directory in the ./dist/build directory, which is a valid NodeJS package. From the root of the package, you can try: node test This will instantiate a static network filtering engine, populated by easylist and easyprivacy, which can be used to match network requests by filling the appropriate filtering context object. The test.js file contains code which is typical example of usage of the package. Limitations: the NodeJS package can't execute the WASM versions of the code since the WASM module requires the use of fetch(), which is not available in NodeJS. This is a first pass at modularizing the codebase, and while at it a number of opportunistic small rewrites have also been made. This commit requires the minimum supported version for Chromium and Firefox be raised to 61 and 60 respectively.
2021-07-25 16:55:35 +02:00
cp src/js/filtering-context.js $DES/js
cp src/js/globals.js $DES/js
Export the rule-based filtering engines to the nodejs package The code exported to nodejs package was revised to use modern JavaScript syntax. A few issues were fixed at the same time. The exported classes are: - DynamicHostRuleFiltering - DynamicURLRuleFiltering - DynamicSwitchRuleFiltering These related to the content the of "My rules" pane in the uBlock Origin extension.
2021-08-03 18:19:25 +02:00
cp src/js/hnswitches.js $DES/js
Modularize codebase with export/import Related issue: - https://github.com/uBlockOrigin/uBlock-issues/issues/1664 The changes are enough to fulfill the related issue. A new platform has been added in order to allow for building a NodeJS package. From the root of the project: ./tools/make-nodejs This will create new uBlock0.nodejs directory in the ./dist/build directory, which is a valid NodeJS package. From the root of the package, you can try: node test This will instantiate a static network filtering engine, populated by easylist and easyprivacy, which can be used to match network requests by filling the appropriate filtering context object. The test.js file contains code which is typical example of usage of the package. Limitations: the NodeJS package can't execute the WASM versions of the code since the WASM module requires the use of fetch(), which is not available in NodeJS. This is a first pass at modularizing the codebase, and while at it a number of opportunistic small rewrites have also been made. This commit requires the minimum supported version for Chromium and Firefox be raised to 61 and 60 respectively.
2021-07-25 16:55:35 +02:00
cp src/js/hntrie.js $DES/js
cp src/js/static-filtering-parser.js $DES/js
cp src/js/static-net-filtering.js $DES/js
cp src/js/static-filtering-io.js $DES/js
Fix make-nodejs Broken due to renaming text-iterators to text-utils.
2021-07-31 14:59:55 +02:00
cp src/js/text-utils.js $DES/js
Modularize codebase with export/import Related issue: - https://github.com/uBlockOrigin/uBlock-issues/issues/1664 The changes are enough to fulfill the related issue. A new platform has been added in order to allow for building a NodeJS package. From the root of the project: ./tools/make-nodejs This will create new uBlock0.nodejs directory in the ./dist/build directory, which is a valid NodeJS package. From the root of the package, you can try: node test This will instantiate a static network filtering engine, populated by easylist and easyprivacy, which can be used to match network requests by filling the appropriate filtering context object. The test.js file contains code which is typical example of usage of the package. Limitations: the NodeJS package can't execute the WASM versions of the code since the WASM module requires the use of fetch(), which is not available in NodeJS. This is a first pass at modularizing the codebase, and while at it a number of opportunistic small rewrites have also been made. This commit requires the minimum supported version for Chromium and Firefox be raised to 61 and 60 respectively.
2021-07-25 16:55:35 +02:00
cp src/js/uri-utils.js $DES/js
Export the rule-based filtering engines to the nodejs package The code exported to nodejs package was revised to use modern JavaScript syntax. A few issues were fixed at the same time. The exported classes are: - DynamicHostRuleFiltering - DynamicURLRuleFiltering - DynamicSwitchRuleFiltering These related to the content the of "My rules" pane in the uBlock Origin extension.
2021-08-03 18:19:25 +02:00
cp src/js/url-net-filtering.js $DES/js
Modularize codebase with export/import Related issue: - https://github.com/uBlockOrigin/uBlock-issues/issues/1664 The changes are enough to fulfill the related issue. A new platform has been added in order to allow for building a NodeJS package. From the root of the project: ./tools/make-nodejs This will create new uBlock0.nodejs directory in the ./dist/build directory, which is a valid NodeJS package. From the root of the package, you can try: node test This will instantiate a static network filtering engine, populated by easylist and easyprivacy, which can be used to match network requests by filling the appropriate filtering context object. The test.js file contains code which is typical example of usage of the package. Limitations: the NodeJS package can't execute the WASM versions of the code since the WASM module requires the use of fetch(), which is not available in NodeJS. This is a first pass at modularizing the codebase, and while at it a number of opportunistic small rewrites have also been made. This commit requires the minimum supported version for Chromium and Firefox be raised to 61 and 60 respectively.
2021-07-25 16:55:35 +02:00
mkdir -p $DES/lib
cp -R src/lib/punycode.js $DES/lib/
cp -R src/lib/regexanalyzer $DES/lib/
Simplify loading of WASM modules in nodejs
2021-07-31 13:06:11 +02:00
cp -R src/lib/publicsuffixlist $DES/lib/
# Convert wasm modules into json arrays
mkdir -p $DES/js/wasm
cp src/js/wasm/* $DES/js/wasm/
node -pe "JSON.stringify(Array.from(fs.readFileSync('src/js/wasm/hntrie.wasm')))" \
> $DES/js/wasm/hntrie.wasm.json
node -pe "JSON.stringify(Array.from(fs.readFileSync('src/js/wasm/biditrie.wasm')))" \
> $DES/js/wasm/biditrie.wasm.json
node -pe "JSON.stringify(Array.from(fs.readFileSync('src/lib/publicsuffixlist/wasm/publicsuffixlist.wasm')))" \
> $DES/lib/publicsuffixlist/wasm/publicsuffixlist.wasm.json
Modularize codebase with export/import Related issue: - https://github.com/uBlockOrigin/uBlock-issues/issues/1664 The changes are enough to fulfill the related issue. A new platform has been added in order to allow for building a NodeJS package. From the root of the project: ./tools/make-nodejs This will create new uBlock0.nodejs directory in the ./dist/build directory, which is a valid NodeJS package. From the root of the package, you can try: node test This will instantiate a static network filtering engine, populated by easylist and easyprivacy, which can be used to match network requests by filling the appropriate filtering context object. The test.js file contains code which is typical example of usage of the package. Limitations: the NodeJS package can't execute the WASM versions of the code since the WASM module requires the use of fetch(), which is not available in NodeJS. This is a first pass at modularizing the codebase, and while at it a number of opportunistic small rewrites have also been made. This commit requires the minimum supported version for Chromium and Firefox be raised to 61 and 60 respectively.
2021-07-25 16:55:35 +02:00
Make uAssets a submodule
2021-07-29 16:06:49 +02:00
git submodule update --depth 1 --init
UASSETS=submodules/uAssets
Remove requirement of uAssets presence to build a package Related discussion: - https://github.com/cliqz-oss/adblocker/pull/2075#discussion_r678654293
2021-07-29 01:40:11 +02:00
Use `require` instead of `fs` Related feedback: - https://github.com/uBlockOrigin/uBlock-issues/issues/1664#issuecomment-888332409
2021-07-28 16:38:24 +02:00
# https://github.com/uBlockOrigin/uBlock-issues/issues/1664#issuecomment-888332409
Remove requirement of uAssets presence to build a package Related discussion: - https://github.com/cliqz-oss/adblocker/pull/2075#discussion_r678654293
2021-07-29 01:40:11 +02:00
THIRDPARTY=$UASSETS/thirdparties/publicsuffix.org
Modularize codebase with export/import Related issue: - https://github.com/uBlockOrigin/uBlock-issues/issues/1664 The changes are enough to fulfill the related issue. A new platform has been added in order to allow for building a NodeJS package. From the root of the project: ./tools/make-nodejs This will create new uBlock0.nodejs directory in the ./dist/build directory, which is a valid NodeJS package. From the root of the package, you can try: node test This will instantiate a static network filtering engine, populated by easylist and easyprivacy, which can be used to match network requests by filling the appropriate filtering context object. The test.js file contains code which is typical example of usage of the package. Limitations: the NodeJS package can't execute the WASM versions of the code since the WASM module requires the use of fetch(), which is not available in NodeJS. This is a first pass at modularizing the codebase, and while at it a number of opportunistic small rewrites have also been made. This commit requires the minimum supported version for Chromium and Firefox be raised to 61 and 60 respectively.
2021-07-25 16:55:35 +02:00
mkdir -p $DES/data
Revert "Make the nodejs package load a serialized version of the PSL" This reverts commit 46c6ff8708419614201d3e477b20f74c2c275afd.
2021-08-01 21:42:46 +02:00
node -pe "JSON.stringify(fs.readFileSync('$THIRDPARTY/list/effective_tld_names.dat', 'utf8'))" \
> $DES/data/effective_tld_names.json
Remove requirement of uAssets presence to build a package Related discussion: - https://github.com/cliqz-oss/adblocker/pull/2075#discussion_r678654293
2021-07-29 01:40:11 +02:00
THIRDPARTY=$UASSETS/thirdparties/easylist-downloads.adblockplus.org
Use `require` instead of `fs` Related feedback: - https://github.com/uBlockOrigin/uBlock-issues/issues/1664#issuecomment-888332409
2021-07-28 16:38:24 +02:00
node -pe "JSON.stringify(fs.readFileSync('$THIRDPARTY/easylist.txt', 'utf8'))" \
> $DES/data/easylist.json
node -pe "JSON.stringify(fs.readFileSync('$THIRDPARTY/easyprivacy.txt', 'utf8'))" \
> $DES/data/easyprivacy.json
Modularize codebase with export/import Related issue: - https://github.com/uBlockOrigin/uBlock-issues/issues/1664 The changes are enough to fulfill the related issue. A new platform has been added in order to allow for building a NodeJS package. From the root of the project: ./tools/make-nodejs This will create new uBlock0.nodejs directory in the ./dist/build directory, which is a valid NodeJS package. From the root of the package, you can try: node test This will instantiate a static network filtering engine, populated by easylist and easyprivacy, which can be used to match network requests by filling the appropriate filtering context object. The test.js file contains code which is typical example of usage of the package. Limitations: the NodeJS package can't execute the WASM versions of the code since the WASM module requires the use of fetch(), which is not available in NodeJS. This is a first pass at modularizing the codebase, and while at it a number of opportunistic small rewrites have also been made. This commit requires the minimum supported version for Chromium and Firefox be raised to 61 and 60 respectively.
2021-07-25 16:55:35 +02:00
Add eslint dependency within Node.js package (#3813)
2021-08-13 12:43:20 +02:00
cp platform/nodejs/.*.json $DES/
...
2021-08-05 20:36:13 +02:00
cp platform/nodejs/*.js $DES/
cp platform/nodejs/*.json $DES/
cp platform/nodejs/README.md $DES/
cp LICENSE.txt $DES/
Remove requirement of uAssets presence to build a package Related discussion: - https://github.com/cliqz-oss/adblocker/pull/2075#discussion_r678654293
2021-07-29 01:40:11 +02:00
Run build script via tools/make-nodejs.sh (#3808)
2021-08-10 02:02:58 +02:00
cd $DES
npm run build
Use npm pack (#3812)
2021-08-12 13:57:56 +02:00
tarballname=$(npm pack 2> /dev/null)
Publish tgz package instead of zip Related feedback: - https://github.com/gorhill/uBlock/pull/3812#issuecomment-897057648
2021-08-12 14:33:43 +02:00
if [ "$1" ]; then
Remove requirement of uAssets presence to build a package Related discussion: - https://github.com/cliqz-oss/adblocker/pull/2075#discussion_r678654293
2021-07-29 01:40:11 +02:00
echo "*** uBlock0.nodejs: Creating versioned package..."
Publish tgz package instead of zip Related feedback: - https://github.com/gorhill/uBlock/pull/3812#issuecomment-897057648
2021-08-12 14:33:43 +02:00
mv $tarballname ../uBlock0_"$1".nodejs.tgz
else
echo "*** uBlock0.nodejs: Creating plain package..."
mv $tarballname ../uBlock0.nodejs.tgz
Remove requirement of uAssets presence to build a package Related discussion: - https://github.com/cliqz-oss/adblocker/pull/2075#discussion_r678654293
2021-07-29 01:40:11 +02:00
fi
Publish tgz package instead of zip Related feedback: - https://github.com/gorhill/uBlock/pull/3812#issuecomment-897057648
2021-08-12 14:33:43 +02:00
cd -
Remove requirement of uAssets presence to build a package Related discussion: - https://github.com/cliqz-oss/adblocker/pull/2075#discussion_r678654293
2021-07-29 01:40:11 +02:00
echo "*** uBlock0.nodejs: Package done."
Reference in a new issue Copy permalink