TSUrlFilter

This repo contains typescript packages implementing AdGuard filtering engine.

Packages:

• tsurlfilter
• tswebextension
• adguard-api
• agtree
• examples/manifest-v2
• examples/manifest-v3
• examples/tswebextension-example
• examples/tswebextension-mv3

See packages details in ./packages.

TSUrlFilter

TSUrlFilter is a TypeScript library that implements AdGuard's blocking rules logic. See details in ./packages/tsurlfilter.

TSWebExtension

TSWebExtension is a TypeScript library that wraps webextension api for tsurlfilter library. See details in ./packages/tswebextension.

AdGuard API

AdGuard API is a TypeScript filtering library that provides filter list management, ad filtering via @adguard/tswebextension. See details in ./packages/adguard-api.

Sample extensions

Source code of the sample extensions is located in the directory ./packages/examples.

To build sample manifest-v2 extension go to the one of the examples and run:

$ lerna bootstrap && lerna run --scope manifest-v2 build

Reciprocally with manifest-v3:

$ lerna bootstrap && lerna run --scope manifest-v3 build

and

$ lerna bootstrap && lerna run --scope tswebextension-example build

After that it's ready to be added to Chrome using "Load unpacked" in developer mode.

To test if this extension works correctly you can use next test pages:

Test pages:

• Simple rules test
• Script rules test

Development

npm install -g lerna

lerna bootstrap

Bootstrap the packages in the current repo. Installing all their dependencies and linking any cross-dependencies.

Note: If you want to use another linked packages in monorepo workspace, link it in root folder

lerna run test

Runs tests in all packages.

lerna run build

Builds the packages in the current repo.