From c303e934118a128058531e46bf36f85fe70fba51 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?D=C3=A1vid=20T=C3=B3ta?= Date: Wed, 18 Sep 2024 18:53:21 +0300 Subject: [PATCH] Update AGTree description Merge in ADGUARD-FILTERS/tsurlfilter from fix/update-agtree-readme to master Squashed commit of the following: commit 58d7d087b6765ac17dd893a4623c79ee760e0cba Merge: 820cbd831 497f4ab36 Author: scripthunter7 Date: Wed Sep 18 17:41:37 2024 +0200 Merge branch 'master' into fix/update-agtree-readme commit 820cbd83143a9570959179a20c98dd3a17970a71 Author: scripthunter7 Date: Wed Sep 18 16:05:43 2024 +0200 update compatibility commit f69af36ac0ae8944d09d29ffdb20ee4e2b4c6ade Author: scripthunter7 Date: Wed Sep 18 15:48:56 2024 +0200 Update AGTree description --- packages/agtree/README.md | 52 ++++++++++++------------------------ packages/agtree/package.json | 12 ++++++--- 2 files changed, 26 insertions(+), 38 deletions(-) diff --git a/packages/agtree/README.md b/packages/agtree/README.md index f1fbcbec1..059a712dc 100644 --- a/packages/agtree/README.md +++ b/packages/agtree/README.md @@ -6,13 +6,13 @@ AGTree

-

Universal adblock filter list parser

+

Tool set for working with adblock filter lists

Supported syntaxes:

AdGuard logo AdGuard | uBlock Origin logo uBlock Origin - | AdBlock logoAdBlock - | Adblock Plus logoAdblock Plus + | AdBlock logo AdBlock + | Adblock Plus logo Adblock Plus

NPM version @@ -21,43 +21,29 @@

-Table of Contents: +## What is AGTree? -- [Introduction](#introduction) -- [Browser compatibility](#browser-compatibility) -- [Development \& Contribution](#development--contribution) -- [Ideas \& Questions](#ideas--questions) -- [License](#license) -- [References](#references) +AGTree is a tool set for working with adblock filter lists. It contains the following modules: -## Introduction - -AGTree is a universal tool for working with adblock filter lists. It contains the following modules: - -- [Adblock rule converter][converter-url] - [Adblock rule parser][parser-url] +- [Adblock rule converter][converter-url] - [Adblock rule validator][validator-url] - [Compatibility tables][compatibility-tables-url] -AGTree supports all syntaxes currently in use: +## Installation - -- AdGuard logo [AdGuard][adg-url] -- uBlock Origin logo [uBlock Origin][ubo-url] -- Adblock Plus logo [Adblock Plus][abp-url] -- AdBlock logo [AdBlock][ab-url] - +You can install the library using + +- [Yarn][yarn-pkg-manager-url]: `yarn add @adguard/agtree` +- [NPM][npm-pkg-manager-url]: `npm install @adguard/agtree` +- [PNPM][pnpm-pkg-manager-url]: `pnpm add @adguard/agtree` -## Browser compatibility +> [!IMPORTANT] +> AGTree requires Node.js version 18 or higher. -| Browser | Version | -|-----------------------|:----------| -| Chrome | ✅ 80 | -| Firefox | ✅ 78 | -| Edge | ✅ 80 | -| Opera | ✅ 67 | -| Safari | ✅ 14 | -| Internet Explorer | ❌ | +[yarn-pkg-manager-url]: https://yarnpkg.com/en/docs/install +[npm-pkg-manager-url]: https://www.npmjs.com/get-npm +[pnpm-pkg-manager-url]: https://pnpm.io/ ## Development & Contribution @@ -94,16 +80,13 @@ resources, please let us know. - AdGuard logo [AdGuard's compatibility table][adg-compatibility-table] -[ab-url]: https://getadblock.com [abp-ext-css]: https://help.eyeo.com/adblockplus/how-to-write-filters#elemhide-emulation [abp-filters]: https://help.eyeo.com/adblockplus/how-to-write-filters [abp-snippets]: https://help.eyeo.com/adblockplus/snippet-filters-tutorial#snippets-ref -[abp-url]: https://adblockplus.org [adg-compatibility-table]: https://github.com/AdguardTeam/Scriptlets/blob/master/wiki/compatibility-table.md [adg-ext-css]: https://github.com/AdguardTeam/ExtendedCss/blob/master/README.md [adg-filters]: https://kb.adguard.com/en/general/how-to-create-your-own-ad-filters [adg-scriptlets]: https://github.com/AdguardTeam/Scriptlets/blob/master/wiki/about-scriptlets.md#scriptlets -[adg-url]: https://adguard.com [compatibility-tables-url]: https://github.com/AdguardTeam/tsurlfilter/tree/master/packages/agtree/src/compatibility-tables [contributing-url]: https://github.com/AdguardTeam/tsurlfilter/tree/master/packages/agtree/CONTRIBUTING.md [converter-url]: https://github.com/AdguardTeam/tsurlfilter/tree/master/packages/agtree/src/converter @@ -116,4 +99,3 @@ resources, please let us know. [ubo-filters]: https://github.com/gorhill/uBlock/wiki/Static-filter-syntax [ubo-procedural]: https://github.com/gorhill/uBlock/wiki/Procedural-cosmetic-filters [ubo-scriptlets]: https://github.com/gorhill/uBlock/wiki/Resources-Library#available-general-purpose-scriptlets -[ubo-url]: https://github.com/gorhill/uBlock diff --git a/packages/agtree/package.json b/packages/agtree/package.json index c1b61b67b..6591de720 100644 --- a/packages/agtree/package.json +++ b/packages/agtree/package.json @@ -1,13 +1,19 @@ { "name": "@adguard/agtree", "version": "2.1.0", - "description": "Universal adblock filter list parser.", + "description": "Tool set for working with adblock filter lists", "keywords": [ "adblock", "filter", "list", + "rule", "parser", - "ast" + "ast", + "converter", + "validator", + "generator", + "serialize", + "deserialize" ], "author": "Adguard Software Ltd.", "license": "MIT", @@ -34,7 +40,7 @@ "dist" ], "engines": { - "node": ">=17" + "node": ">=18" }, "scripts": { "build": "pnpm clean && pnpm build-txt && pnpm build-compatibility-tables && pnpm build-compatibility-tables-wiki && pnpm rollup --config rollup.config.ts --configPlugin typescript && rimraf dist/types",