igorskyflyerAria ๐ช
Adblock template (ADBT) compiler
๐งฌ Meet
Aria, an efficient Adblock filter list compiler, with many features that make your maintenance of Adblock filter lists a breeze! ๐ฆ
๐ Support further development
I work hard for every project, including this one and your support means a lot to me!
Consider buying me a coffee. โ
Thank you for supporting my efforts! ๐๐
@igorskyflyer
๐ต๐ผโโ๏ธ Install
Install it by executing:
Global install
npm i -g "@igor.dvlpr/aria"Local install
npm i "@igor.dvlpr/aria"๐คน๐ผโโ๏ธ Usage
๐ก This file only documents Aria CLI-related API.
You should read the official ADBT API documentation for more information on how ADBT works, its syntax and usage.
๐ช Arguments
<None>
Will print the welcome + help screen
File
Compile the input ADBT template file.
Short: -f
Long: --file
Accepts: path: string
Required: yes
Example
aria -f './my-template.adbt'๐ก Template files should end with the
.adbtextension.
Root
Set the root directory (CWD).
Short: -r
Long: --root
Accepts: path: string
Required: no
Example
aria -f './my-template.adbt' --root 'D:\my-filter'๐ก Useful when passing an absolute template path or when working from a directory that's not the directory where the template file is stored.
Versioning
The versioning to use, can be:
auto: default, letAriadecide which versioning system to use.
If the resulting file already exists, i.e.Ariaalready compiled the template before, it will re-use the versioning found in the file, otherwise it will usesemver,semver: use valid SemVer versioning when exporting the filter file, e.g.v1.0.0,v2.199.222, etc.
If no version is found the counting starts withv1.0.0,timestamp: use current UNIX timestamp, e.g.1690409508.
Short: -v
Long: --versioning
Accepts: auto, semver, timestamp
Required: no
Example
aria -f './my-template.adbt' -v semverโน๏ธ Versioning in Adblock filters
Take this snippet from my AdVoid filter list:
! Title: AdVoid.Core
! Description: โ AdVoid is an efficient AdBlock filter that blocks ads! ๐พ
! Version: 1.8.1082Aria takes care of the versioning, the last line you see in the snippet above - so you don't have to!
โWhen using SemVer as the versioning system,
Ariawill always increase only thepatchcomponent of the version.
๐ช Flags
Dry
Do a dry-run and print the resulting AST.
Short: -d
Long: --dry
Accepts: N/A
Required: no
Example
aria -f './my-template.adbt' -d๐ก The template will not be compiled;
Ariawill only print out the log.
โ If you want to both compile and print the log, then use the
logflag.
Tree
Will print the resulting AST.
Short: -t
Long: --tree
Accepts: N/A
Required: no
Example
aria -f './my-template.adbt' -t๐ก This will compile and print out the resulting AST.
๐ค What is AST?
In computer science, an abstract syntax tree (AST), or just syntax tree, is a tree representation of the abstract syntactic structure of text (often source code) written in a formal language. Each node of the tree denotes a construct occurring in the text. โ Wikipedia
Log
Enable compilation logging.
Short: -l
Long: --log
Accepts: N/A
Required: no
Example
aria -f './my-template.adbt' -l๐ก The template will be compiled and
Ariawill log while compiling.
โ If you only want to do a dry-run and don't compile the template, then use the
dryflag.
Help
Show the welcome + help screen.
Short: -h
Long: --help
Accepts: N/A
Required: no
Example
aria --help๐ก This flag works the same as calling
ariaon its own - with 0 arguments.
๐ Changelog
โจ Changelog is available here: CHANGELOG.md.
๐ชช License
Licensed under the MIT license which is available here, MIT license.
๐งฌ Related
๐ Provides ADBT (Adblock template) support in Visual Studio Code. ๐ช
@igor.dvlpr/adblock-filter-counter
๐ฒ A dead simple npm module that counts Adblock filter rules.๐ฆ
๐ก Parse, manage, compare and output SemVer-compatible version numbers. ๐งฎ
๐ NormalizedString provides you with a String type with consistent line-endings, guaranteed. ๐ฎ
๐ Zing is a C# style String formatter for JavaScript that empowers Strings with positional arguments. ๐
โ AdVoid is an efficient AdBlock filter that blocks ads, trackers, malware and a lot more if you want it to! ๐พ
Provided by Igor Dimitrijeviฤ (@igorskyflyer).