Giter VIP home page Giter VIP logo

abp-filter-parser's Introduction

abp-filter-parser

For a faster more precise version of this library, see its C++ gyp rewrite.

JavaScript Adblock Plus filter parser for lists like EasyList

Build Status

Parses filter rules as per:

Usage

Babel / ES6:

import * as ABPFilterParser from 'abp-filter-parser.js';

Node:

let ABPFilterParser = require('abp-filter-parser');

Primary API:

let ABPFilterParser = require('abp-filter-parser');
var fs = require('fs');

let easyListTxt = fs.readFileSync('./test/data/easylist.txt', 'utf-8');
let parsedFilterData = {};
let urlToCheck = 'http://static.tumblr.com/dhqhfum/WgAn39721/cfh_header_banner_v2.jpg';

// This is the site who's URLs are being checked, not the domain of the URL being checked.
let currentPageDomain = 'slashdot.org';

ABPFilterParser.parse(easyListTxt, parsedFilterData);
// ABPFilterParser.parse(someOtherListOfFilters, parsedFilterData);

if (ABPFilterParser.matches(parsedFilterData, urlToCheck, {
      domain: currentPageDomain,
      elementTypeMaskMap: ABPFilterParser.elementTypes.SCRIPT,
    })) {
  console.log('You should block this URL!');
} else {
  console.log('You should NOT block this URL!');
}

Secondary APIs

You probably won't need these directly, they are used by the primary API above.

  • parseDomains
  • parseOptions
  • parseHTMLFilter
  • parseFilter
  • matchesFilter

abp-filter-parser's People

Contributors

adi1133 avatar aekeus avatar bbondy avatar brigand avatar ebramanti avatar hackable avatar joanbm avatar kevingrandon avatar

Stargazers

 avatar

Watchers

 avatar

Forkers

kicktheken

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.