Github url

cheerio

by cheeriojs

cheeriojs /cheerio

Fast, flexible, and lean implementation of core jQuery designed specifically for the server.

22.2K Stars 1.4K Forks Last release: Not found MIT License 1.1K Commits 55 Releases

Available items

No Items, yet!

The developer of this repository has not created any items for sale yet. Need a bug fixed? Help with integration? A different license? Create a request here:

cheerio

Fast, flexible & lean implementation of core jQuery designed specifically for the server.

Travis CICoverageJoin the chat at https://gitter.im/cheeriojs/cheerioOpenCollective backersOpenCollective sponsors

中文文档 (Chinese Readme)

const cheerio = require('cheerio'); const $ = cheerio.load('
## Hello world
'); $('h2.title').text('Hello there!'); $('h2').addClass('welcome'); $.html(); //=\> 
## Hello there!

Installation

npm install cheerio

Features

❤ Familiar syntax:Cheerio implements a subset of core jQuery. Cheerio removes all the DOM inconsistencies and browser cruft from the jQuery library, revealing its truly gorgeous API.

ϟ Blazingly fast:Cheerio works with a very simple, consistent DOM model. As a result parsing, manipulating, and rendering are incredibly efficient. Preliminary end-to-end benchmarks suggest that cheerio is about 8x faster than JSDOM.

❁ Incredibly flexible:Cheerio wraps around parse5 parser and can optionally use @FB55's forgiving htmlparser2. Cheerio can parse nearly any HTML or XML document.

Cheerio is not a web browser

Cheerio parses markup and provides an API for traversing/manipulating the resulting data structure. It does not interpret the result as a web browser does. Specifically, it does not produce a visual rendering, apply CSS, load external resources, or execute JavaScript. If your use case requires any of this functionality, you should consider projects like PhantomJS or JSDom.

Sponsors

Does your company use Cheerio in production? Please consider sponsoring this project. Your help will allow maintainers to dedicate more time and resources to its development and support.

Backers

Become a backer to show your support for Cheerio and help us maintain and improve this open source project.

API

Markup example we'll be using:

  • Apple
  • Orange
  • Pear

This is the HTML markup we will be using in all of the API examples.

Loading

First you need to load in the HTML. This step in jQuery is implicit, since jQuery operates on the one, baked-in DOM. With Cheerio, we need to pass in the HTML document.

This is the preferred method:

const cheerio = require('cheerio'); const $ = cheerio.load('

...');

Optionally, you can also load in the HTML by passing the string as the context:

const $ = require('cheerio'); $('ul', '

...');

Or as the root:

const $ = require('cheerio'); $('li', 'ul', '

...');

If you need to modify parsing options for XML input, you may pass an extra object to

.load()

:

const $ = cheerio.load('

...', { xml: { normalizeWhitespace: true, }, });

The options in the

xml

object are taken directly from htmlparser2, therefore any options that can be used in

htmlparser2

are valid in cheerio as well. The default options are:

{ withDomLvl1: true, normalizeWhitespace: false, xmlMode: true, decodeEntities: true }

For a full list of options and their effects, see this andhtmlparser2's options.

Some users may wish to parse markup with the

htmlparser2

library, and traverse/manipulate the resulting structure with Cheerio. This may be the case for those upgrading from pre-1.0 releases of Cheerio (which relied on

htmlparser2

), for those dealing with invalid markup (because

htmlparser2

is more forgiving), or for those operating in performance-critical situations (because

htmlparser2

may be faster in some cases). Note that "more forgiving" means

htmlparser2

has error-correcting mechanisms that aren't always a match for the standards observed by web browsers. This behavior may be useful when parsing non-HTML content.

To support these cases,

load

also accepts a

htmlparser2

-compatible data structure as its first argument. Users may install

htmlparser2

, use it to parse input, and pass the result to

load

:

// Usage as of htmlparser2 version 3: const htmlparser2 = require('htmlparser2'); const dom = htmlparser2.parseDOM(document, options); const $ = cheerio.load(dom);

Selectors

Cheerio's selector implementation is nearly identical to jQuery's, so the API is very similar.

$( selector, [context], [root] )

selector

searches within the

context

scope which searches within the

root

scope.

selector

and

context

can be a string expression, DOM Element, array of DOM elements, or cheerio object.

root

is typically the HTML document string.

This selector method is the starting point for traversing and manipulating the document. Like jQuery, it's the primary method for selecting elements in the document, but unlike jQuery it's built on top of the CSSSelect library, which implements most of the Sizzle selectors.

$('.apple', '#fruits').text(); //=\> Apple $('ul .pear').attr('class'); //=\> pear $('li[class=orange]').html(); //=\> Orange
XML Namespaces

You can select with XML Namespaces but due to the CSS specification, the colon (

:

) needs to be escaped for the selector to be valid.

$('[xml\\:id="main"');

Rendering

When you're ready to render the document, you can call the

html

method on the "root" selection:

$.root().html(); //=\> // // //

// - Apple // - Orange // - Pear // // //

If you want to render the [

outerHTML

](https://developer.mozilla.org/en-US/docs/Web/API/Element/outerHTML) of a selection, you can use the

html

utility functon:

cheerio.html($('.pear')); //=\>
  • Pear

By default,

html

will leave some tags open. Sometimes you may instead want to render a valid XML document. For example, you might parse the following XML snippet:

const $ = cheerio.load('<thumbnail url="http://www.foo.com/keyframe.jpg" width="75" height="50" time="12:05:01.123"></thumbnail>');

... and later want to render to XML. To do this, you can use the 'xml' utility function:

$.xml(); //=\> <thumbnail url="http://www.foo.com/keyframe.jpg" width="75" height="50" time="12:05:01.123"></thumbnail>

You may also render the text content of a Cheerio object using the

text

static method:

const $ = cheerio.load('This is _content_.'); cheerio.text($('body')); //=\> This is content.

Plugins

Once you have loaded a document, you may extend the prototype or the equivalent

fn

property with custom plugin methods:

const $ = cheerio.load('Hello, **world**!'); $.prototype.logHtml = function () { console.log(this.html()); }; $('body').logHtml(); // logs "Hello, **world**!" to the console

The "DOM Node" object

Cheerio collections are made up of objects that bear some resemblence to browser-based DOM nodes. You can expect them to define the following properties:

  • tagName
  • parentNode
  • previousSibling
  • nextSibling
  • nodeValue
  • firstChild
  • childNodes
  • lastChild

Screencasts

http://vimeo.com/31950192

This video tutorial is a follow-up to Nettut's "How to Scrape Web Pages with Node.js and jQuery", using cheerio instead of JSDOM + jQuery. This video shows how easy it is to use cheerio and how much faster cheerio is than JSDOM + jQuery.

Contributors

These are some of the contributors that have made cheerio possible:

project : cheerio repo age : 2 years, 6 months active : 285 days commits : 762 files : 36 authors : 293 Matt Mueller 38.5% 133 Matthew Mueller 17.5% 92 Mike Pennisi 12.1% 54 David Chambers 7.1% 30 kpdecker 3.9% 19 Felix Böhm 2.5% 17 fb55 2.2% 15 Siddharth Mahendraker 2.0% 11 Adam Bretz 1.4% 8 Nazar Leush 1.0% 7 ironchefpython 0.9% 6 Jarno Leppänen 0.8% 5 Ben Sheldon 0.7% 5 Jos Shepherd 0.7% 5 Ryan Schmukler 0.7% 5 Steven Vachon 0.7% 4 Maciej Adwent 0.5% 4 Amir Abu Shareb 0.5% 3 [email protected] 0.4% 3 Andi Neck 0.4% 2 steve 0.3% 2 alexbardas 0.3% 2 finspin 0.3% 2 Ali Farhadi 0.3% 2 Chris Khoo 0.3% 2 Rob Ashton 0.3% 2 Thomas Heymann 0.3% 2 Jaro Spisak 0.3% 2 Dan Dascalescu 0.3% 2 Torstein Thune 0.3% 2 Wayne Larsen 0.3% 1 Timm Preetz 0.1% 1 Xavi 0.1% 1 Alex Shaindlin 0.1% 1 mattym 0.1% 1 Felix Böhm 0.1% 1 Farid Neshat 0.1% 1 Dmitry Mazuro 0.1% 1 Jeremy Hubble 0.1% 1 nevermind 0.1% 1 Manuel Alabor 0.1% 1 Matt Liegey 0.1% 1 Chris O'Hara 0.1% 1 Michael Holroyd 0.1% 1 Michiel De Mey 0.1% 1 Ben Atkin 0.1% 1 Rich Trott 0.1% 1 Rob "Hurricane" Ashton 0.1% 1 Robin Gloster 0.1% 1 Simon Boudrias 0.1% 1 Sindre Sorhus 0.1% 1 xiaohwan 0.1%

Cheerio in the real world

Are you using cheerio in production? Add it to the wiki!

Testing

To run the test suite, download the repository, then within the cheerio directory, run:

make setup make test

This will download the development packages and run the test suite.

Special Thanks

This library stands on the shoulders of some incredible developers. A special thanks to:

• @FB55 for node-htmlparser2 & CSSSelect:Felix has a knack for writing speedy parsing engines. He completely re-wrote both @tautologistic's

node-htmlparser

and @harry's

node-soupselect

from the ground up, making both of them much faster and more flexible. Cheerio would not be possible without his foundational work

• @jQuery team for jQuery:The core API is the best of its class and despite dealing with all the browser inconsistencies the code base is extremely clean and easy to follow. Much of cheerio's implementation and documentation is from jQuery. Thanks guys.

• @visionmedia:The style, the structure, the open-source"-ness" of this library comes from studying TJ's style and using many of his libraries. This dude consistently pumps out high-quality libraries and has always been more than willing to help or answer questions. You rock TJ.

License

MIT

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.