Cheerio's version of node-soupselect.
JavaScript
Pull request Compare This branch is 4 commits behind matthewmueller:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.
lib
test
.gitignore
.npmignore
History.md
Makefile
README.md
package.json

README.md

cheerio-soupselect

A fork of harryf's node-soupselect, which is originally a port of Simon Willison's soupselect for use with node.js and node-htmlparser.

Installation

$ npm install cheerio-soupselect

Testing

From the root folder:

$ make test

Features

Selectors

cheerio-soupselect supports all of the most common jQuery selectors, including multiple attribute selectors and multiple selectors.

Filters

soupselect also supports a bunch of basic filters, listed below. Each filter is implement according to the jQuery specification.

  • contains
  • empty
  • parent
  • has
  • header
  • not
  • eq
  • gt
  • lt
  • even
  • odd
  • first
  • last

Filter Extensions

cheerio-soupselect supports custom filters through the exported filters object. It's simple:

var soupselect = require("cheerio-soupselect"),
    filters = soupselect.filters;
...
filters["custom-filter"] = function(ctx, val){
    console.log("Hello filters!");
    return [];
};
...
var ret = soupselect.select(dom, ":custom-filter('awesome arg')");

The ctx parameter provides an array of htmlparser2 DOMs, which are themselves arrays. These element are grouped by parent.

The val parameter provides access to everything inside the brackets of the filter, if anything.

A few notes about custom selectors:

  • Your custom function must return an array.

  • For the most part, you will not need to handle nesting filters/selectors. However, if you wish to modify the nested selector then, you may do so by modifiying val.