@adguard/agtree

 

Tool set for working with adblock filter lists

Supported syntaxes:

AdGuard | uBlock Origin | AdBlock | Adblock Plus

What is AGTree?

AGTree is a tool set for working with adblock filter lists. It contains the following modules:

• Adblock rule parser
• Adblock rule converter
• Adblock rule validator
• Compatibility tables

Installation

You can install the library using

• Yarn: yarn add @adguard/agtree
• NPM: npm install @adguard/agtree
• PNPM: pnpm add @adguard/agtree

[!IMPORTANT] AGTree is an ESM-only package and requires Node.js version 18 or higher.

Development & Contribution

Please read the CONTRIBUTING.md file for details on how to contribute to this project.

Ideas & Questions

If you have any questions or ideas for new features, please open an issue or a discussion. We will be happy to discuss it with you.

License

AGTree is licensed under the MIT License. See the LICENSE file for details.

References

Here are some useful links to help you write adblock rules. This list is not exhaustive, so if you know any other useful resources, please let us know.

• Syntax documentation:
  • AdGuard: How to create your own ad filters
  • uBlock Origin: Static filter syntax
  • Adblock Plus: How to write filters
• Extended CSS documentation:
  • MDN: CSS selectors
  • AdGuard: Extended CSS capabilities
  • uBlock Origin: Procedural cosmetic filters
  • Adblock Plus: Extended CSS selectors
• Scriptlets:
  • AdGuard scriptlets
  • uBlock Origin scriptlets
  • Adblock Plus snippets
• AdGuard's compatibility table