filters

Filter templates

This folder holds the filter templates for https://letsblock.it, one filter per file. Adding one filter is as easy as adding a new file and opening a PR. Please read the contribution guidelines before getting started.

File structure

Each file is split into two sections, separated by a --- line:

• the first half is the filter properties, as a YAML object, described in the next section,
• the second half is the filter description, as Markdown. It will be displayed above the filter parameters form.

YAML properties

Let's start with the easy properties first: title and tags (a list) are self-explanatory, they are used in the filter list and the filter view pages.

Then comes the params list. It describes what parameters the filter accepts. Each entry must have:

• A lowercase name, used in the template rendering
• A human-facing description, used in the parameters form
• A type: either checkbox (true/false boolean), string (a single input line), list (several input lines, user can add / remove more dynamically) or multiline (a multi-line input box, used in custom-rules for example)
• A default value, used when displaying the filter to a new user. Valid values are:
  • checkbox: true or false
  • list and multiline: a single string between double quotes
  • list: a list of strings, in the YAML list format (e.g. ["one", "two"])

The template for the filter is defined in Handlebars format. Every param is accessible via their name. If a parameter is not specified by the user, the default value will be used.

To check that your syntax is correct and guard against regression, tests cases are written as a list of objects, with the following fields:

• params is a key/value object, defining the test case input
• output is the expected output of the filter template, the test will fail if it differs

If you have the Go compiler installed, you can run go test -v ./src/filters/ in the project's root directory. The tests will validate the filters' format and syntax, and run their test cases. Otherwise, they will run on your PR when it is reviewed.

uBlock Origin filter syntax

Have a look at the following pages to learn about the syntax:

• The uBlock Origin wiki pages: Static filter syntax and Procedural cosmetic filters.
• This cheatsheet by DandelionSprout.

Testing your changes

Filter files are checked by automated tests that will run on your PR once approved. You can run them locally with one of these commands:

• if you have the golang compiler installed: go test ./src/filters
• if you have docker installed: docker run --rm -w /source -v $PWD:/source golang go test ./src/filters