Skip to content

Latest commit

 

History

History
50 lines (36 loc) · 1.37 KB

README.md

File metadata and controls

50 lines (36 loc) · 1.37 KB
Raw

Adblocker

A fast, pure-JavaScript content-blocking library made by Cliqz.

This library is the building block technology used to power Cliqz and Ghostery's Adblocking. Being a pure JavaScript library, it can be used for various purposes such as:

  • Building a content-blocking extension (see this example for a minimal content-blocking webextension)
  • Building tooling around popular block-lists such as EasyList
  • Converting between various formats of filters (EasyList, Safari Block Lists, etc.)
  • Detecting duplicates in lists
  • Detecting dead domains
  • etc.

The library provides the low-level implementation to fetch, parse and match filters; which makes it possible to manipulate the lists at a high level.

Developement

Install dependencies:

$ npm install

Build:

$ npm run build
$ npm run bundle
$ npm run bundle

Test:

$ npm run test

You can use the following bundle: adblocker.umd.js.

Releasing Checklist

To publish a new version:

  1. Update version in package.json
  2. Update CHANGELOG.md
  3. New commit on local master branch (e.g.: Release v0.1.x)
  4. Add new tag git tag -f -a vX.Y.Z -m "vX.Y.Z"
  5. Push release commit + tag git push upstream master --tags
  6. Travis takes care of the rest!

License

Mozilla Public License 2.0