/FiltersCompiler

A tool that compiles & validates filters

Primary LanguageJavaScriptGNU Lesser General Public License v3.0LGPL-3.0

AG Filters

What is AdGuard?

Filters compiler package

Usage

This package is suggested to be used with filters repository with directory structure presented in tests here.

The package could be run with the following command:

 const whitelist = [1, 3];
 const blacklist = [2];

 const path = require('path');
 const compiler = require("adguard-filters-compiler");

 const filtersDir = path.join(__dirname, './filters');
 const logPath = path.join(__dirname, './log.txt');
 const reportPath = path.join(__dirname, './report.txt');

 const platformsPath = path.join(__dirname, './platforms');

 compiler.compile(filtersDir, logPath, reportPath, platformsPath, whitelist, blacklist);

Tests

 yarn test

Development

In order to add support for new scriptlets and redirects, you should update @adguard/tsurlfilter with updated scriptlets.

For fixing scriptlets converting or validation you should update scriptlets.

Filters metadata

Check the filters metadata information description here