Mirrors
/
uBlock
mirror of https://github.com/gorhill/uBlock.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
uBlock/tools/make-nodejs.sh

68 lines
2.2 KiB
Bash
Raw Normal View History

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 08:55:35 -06:00
#!/usr/bin/env bash
#
# This script assumes a linux environment
DES=dist/build/uBlock0.nodejs
mkdir -p $DES/js
cp src/js/base64-custom.js $DES/js
cp src/js/biditrie.js $DES/js
cp src/js/filtering-context.js $DES/js
cp src/js/globals.js $DES/js
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
cp src/js/text-iterators.js $DES/js
cp src/js/uri-utils.js $DES/js
mkdir -p $DES/lib
cp -R src/lib/punycode.js $DES/lib/
cp -R src/lib/publicsuffixlist $DES/lib/
cp -R src/lib/regexanalyzer $DES/lib/
Remove requirement of uAssets presence to build a package Related discussion: - https://github.com/cliqz-oss/adblocker/pull/2075#discussion_r678654293
2021-07-28 17:40:11 -06:00
# Use existing uAssets, or git-clone a temporary one
if [ -d "../uAssets" ]; then
UASSETS=../uAssets
else
echo "*** ../uAssets not present, git-cloning..."
TMPDIR=$(mktemp -d)
UASSETS=$TMPDIR/uAssets
git clone --depth=1 https://github.com/uBlockOrigin/uAssets.git $UASSETS
fi
Use `require` instead of `fs` Related feedback: - https://github.com/uBlockOrigin/uBlock-issues/issues/1664#issuecomment-888332409
2021-07-28 08:38:24 -06: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-28 17:40:11 -06: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 08:55:35 -06:00
mkdir -p $DES/data
Use `require` instead of `fs` Related feedback: - https://github.com/uBlockOrigin/uBlock-issues/issues/1664#issuecomment-888332409
2021-07-28 08:38:24 -06: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-28 17:40:11 -06: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 08:38:24 -06: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 08:55:35 -06:00
Remove requirement of uAssets presence to build a package Related discussion: - https://github.com/cliqz-oss/adblocker/pull/2075#discussion_r678654293
2021-07-28 17:40:11 -06:00
# Remove temporary git-clone uAssets
if [ -n "$TMPDIR" ]; then
echo "*** Removing temporary $TMPDIR"
rm -rf $TMPDIR
fi
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 08:55:35 -06:00
cp platform/nodejs/*.js $DES/
cp platform/nodejs/*.json $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-28 17:40:11 -06:00
if [ "$1" = all ]; then
echo "*** uBlock0.nodejs: Creating plain package..."
pushd $(dirname $DES/) > /dev/null
zip uBlock0.nodejs.zip -qr $(basename $DES/)/*
popd > /dev/null
elif [ -n "$1" ]; then
echo "*** uBlock0.nodejs: Creating versioned package..."
pushd $(dirname $DES/) > /dev/null
zip uBlock0_"$1".nodejs.zip -qr $(basename $DES/)/*
popd > /dev/null
fi
echo "*** uBlock0.nodejs: Package done."