Swift Safari Converter

Content Blocker converter swift code

Safari Content Blocker

Converts filter rules in AdGuard format to the format supported by Safari.

• https://webkit.org/blog/3476/content-blockers-first-look/

How to build:

    swift build

Tests:

    swift test

How to use converter:

    let result: ConversionResult? = ContentBlockerConverter.convertArray(
        rules: [String], limit: Int = 0, optimize: Bool = false, advancedBlocking: Bool = false
    );

The result contains following properties:

• totalConvertedCount: length of content blocker
• convertedCount: length after reducing to limit if provided
• errorsCount: errors count
• overLimit: is limit exceeded flag
• converted: json string of content blocker rules
• advancedBlocking: json string of advanced blocking rules

How to use converter from command line:

    ./ConverterTool -limit=0 -optimize=true -advancedBlocking=false <<STDIN -o other --options
    test_rule_one
    test_rule_two
    STDIN

The tool then reads stdin line by line for rule until an empty line.

How to release on Github

Push a new tag in v*.*.* format, then provided github action is intended to build and publish new release with an asset binary.

Supported AdGuard rules types:

Basic content blocker format:

• Elemhide rules (##)
• Elemhide exceptions
• Url blocking rules
• Url blocking exceptions

Extended Advanced blocking types:

• Script rules (#%#)
• Script rules exceptions
• Extended css elemhide rules (##)
• Scriptlet rules (#%#//scriptlet)
• Scriptlet rules exceptions

Third-party dependencies

• Punycode (https://github.com/gumob/PunycodeSwift.git)