Skip to content

Releases: cheeriojs/cheerio

v1.0.0

09 Aug 19:02
@fb55 fb55
v1.0.0
50b5d5c
Compare
Choose a tag to compare
v1.0.0 Latest
Latest

Cheerio 1.0 is here! 🎉

Announcement Blog Post

Breaking Changes

  • The minimum NodeJS version is now 18.17 or higher #3959

  • Import paths were simplified. For example, use cheerio/slim instead of
    cheerio/lib/slim. #3970

  • The deprecated default Cheerio instance and static methods were removed. #3974

    Before, it was possible to write code like this:

    import cheerio, { html } from 'cheerio';

html(cheerio('<test></test>')); // ~ '<test></test>' -- NO LONGER WORKS

    Make sure to always load documents first:

    import * as cheerio from 'cheerio';

cheerio.load('<test></test>').html();

  • Node types previously re-exported by Cheerio must now be imported directly
    from (domhandler)(https://github.com/fb55/domhandler). #3969

  • htmlparser2 options now reside exclusively under the xml key (#2916):

    const $ = cheerio.load('<html>', {
  xml: {
    withStartIndices: true,
  },
});

New Features

  • Add functions to load buffers, streams & URLs in NodeJS by @fb55 in #2857
  • Add extract method by @fb55 in #2750

Fixes

Other

Full Changelog: v1.0.0-rc.12...v1.0.0

Contributors

blixt, fb55, and 2 other contributors
Assets 2
Loading
4 Join discussion

v1.0.0-rc.12

26 Jun 13:35
@fb55 fb55
v1.0.0-rc.12
d1cbc66
Compare
Choose a tag to compare
v1.0.0-rc.12

Bugfix release. Fixed issues:

  • Align prop undefined handling with jQuery by @fb55 in #2557
  • Allow deep imports of cheerio/lib/utils by @blixt in #2601

New Contributors

Full Changelog: v1.0.0-rc.11...v1.0.0-rc.12

Contributors

blixt and fb55
Assets 2
Loading

v1.0.0-rc.11

20 May 15:27
@fb55 fb55
v1.0.0-rc.11
7b260a2
Compare
Choose a tag to compare
v1.0.0-rc.11

[email protected] is hopefully the last RC before the 1.0.0 release of Cheerio. There are two APIs that will be added for the next major release: An exract method (#2523) and NodeJS specific loader methods (#2051). These are still in flux and I'd appreciate feedback on the proposals.

A big thank you to everyone that contributed to this release! This includes code contributors, as well as the amazing financial support on GitHub Sponsors!

Under the hood, a lot of work for this release went into updating parse5, cheerio's default HTML parser. Have a look at parse5's release notes to see what has changed there.

Breaking

  • Cheerio is now a dual CommonJS and ESM module. That means that deep imports will now fail in newer versions of Node. #2508
  • script and style contents are added again in .text() #2509
    • To keep the old behavior, switch .text() to .prop('innerText')
  • The TypeScript types inherited from upstream dependencies have changed. #2503
    • Node types are now using tagged unions, which will make consumption a bit easier.

Features

  • Relevant options are now forwarded to cheerio-select #2511
  • For the .prop() method:
    • Add textContent and innerText props #2214
    • Users can now specify a baseURI option, which will lead to href and src props to be resolved as URLs. #2510
  • Added a slim export, which will always use htmlparser2 #1960

Fixes

  • Have text turn passed values to strings #2047
  • Include undefined in the return type of get by @glen-84 in #2392
  • Recognise comments as HTML #2504
  • Add missing undefined return value #2505
  • Export missing static methods #2506
  • Have style parsing add malformed fields to previous field #2521

Refactor

  • Use domutils module directly #1928
  • Hand-roll isHTML #1935
  • Move initialization logic to load #1951
  • Only return elements in closest #2057
  • Remove unnecessary code, be more explicit #2279
  • Use stricter TS, ESLint configs #2507
  • Update exported values #2512

Development Experience

Docs

New Contributors

Full Changelog: v1.0.0-rc.10...v1.0.0-rc.11

Contributors

glen-84, XhmikosR, and 3 other contributors
Assets 2
Loading

v1.0.0-rc.10

08 Jun 15:49
@fb55 fb55
v1.0.0-rc.10
6a6847a
Compare
Choose a tag to compare
v1.0.0-rc.10

Fixes:

Documentation:

Refactors:

v1.0.0-rc.9...v1.0.0-rc.10

Assets 2
Loading

v1.0.0-rc.9

06 May 15:57
@fb55 fb55
v1.0.0-rc.9
95759d6
Compare
Choose a tag to compare
v1.0.0-rc.9

Port to TypeScript

Cheerio has been ported entirely to TypeScript (in #1816)! This eliminates a lot of edge-cases within Cheerio and will allow you to use Cheerio with confidence. This release also features a new documentation website based on TypeDoc, allowing you to quickly navigate all available methods: https://cheerio.js.org

Breaking change: If you were using the function exported by Cheerio directly instead of first load()ing a document, you will now have to update the require to use the default export.

- const cheerio = require("cheerio");
+ const cheerio = require("cheerio").default;

cheerio('div', dom)

Please note that this way of using Cheerio is deprecated and might be removed in a future version. Please consider updating your code to:

const cheerio = require("cheerio");

const $ = cheerio.load(dom)
$('div')

Note: Cheerio uses template literal types to determine return types. These are available starting with TypeScript 4.1, so you might have to bump your TypeScript version.

For TypeScript types, Cheerio now implements the ArrayLike<T> interface. That means that Cheerio instances can contain objects of arbitrary types, but not all methods can be called on them.

The TypeScript compiler will figure out what structures you are operating on:

  • When calling a loaded Cheerio instance with an HTML string like $('<div>'), it will product a Cheerio<Node> type.
    • Node is the base class for DOM elements and includes eg. comment and text nodes.
  • When calling Cheerio with a selector like $('.foo'), it will produce a Cheerio<Element>, as only Elements can be part of the result set.
    • Element is the class representing tags.
  • You can still use $('...').map() to map to arbitrary values, and will get a compiler error when trying to call method that are not supported.
    • Eg. $('.foo').map((i, el) => $(el).text()).attr('test') will no longer be possible, as .attr is not allowed to be called on a Cheerio<string>.

This release does not contain other changes to functionality. Feedback is greatly appreciated; if you encounter a problem, please file an issue!

v1.0.0-rc.6...v1.0.0-rc.9

Assets 2
Loading

v1.0.0-rc.8

06 May 15:35
@fb55 fb55
v1.0.0-rc.8
649b6cf
Compare
Choose a tag to compare
v1.0.0-rc.8 Pre-release
Pre-release

Second botched release. Please use v1.0.0-rc.9 instead.

Assets 2
Loading

v1.0.0-rc.7

06 May 15:28
@fb55 fb55
v1.0.0-rc.7
819f9b2
Compare
Choose a tag to compare
v1.0.0-rc.7 Pre-release
Pre-release

Published without a lib directory — please ignore.

Assets 2
Loading

v1.0.0-rc.6

08 Apr 22:21
@fb55 fb55
v1.0.0-rc.6
0c787f6
Compare
Choose a tag to compare
v1.0.0-rc.6

Breaking:

  • Fixed the ordering of the output of several methods, including prevAll, prevUntil and parentsUntil. The new order matches jQuery.

This release contains three breaking changes inherited from dependencies.

  • Selectors (see [email protected]):
    • Several pseudo selectors are now stricter, in line with the HTML spec.
    • Some attributes are now case-insensitive based on the HTML spec.
  • DOM:
    • In XML mode, all elements will have type: 'tag'.

New features:

Types:

Bug fixes:

Documentation updates:

Refactors:

CI:

Test changes:

Commit Range:
v1.0.0-rc.5...v1.0.0-rc.6

Assets 2
Loading

v1.0.0-rc.5

21 Dec 21:06
@fb55 fb55
v1.0.0-rc.5
f386975
Compare
Choose a tag to compare
v1.0.0-rc.5

Hotfix release

  • fix(package): Use cheerio-select-tmp until naming issue is resolved 3751929

v1.0.0-rc.4...v1.0.0-rc.5

Assets 2
Loading

v1.0.0-rc.4

21 Dec 20:34
@fb55 fb55
v1.0.0-rc.4
52066f3
Compare
Choose a tag to compare
v1.0.0-rc.4

Welcome to [email protected]! This is the last pre-release before a full 1.0.0 release — please make sure to test this release and report any issues you might find.

This release was made possible by our supporters on Open Collective. If you want to support this project going forward, have a look at sponsorship options!

Breaking:

  • After upgrading parse5, cheerio temporarily has a minimum Node version of Node 6. See #1585 for details.
  • Use the parser's DOM without modifications (#1559 by @fb55)
    • Nodes no longer have a root reference. The root node is now referenced by the parent property.
  • Use parse5 to serialize the DOM (04091a4 by @fb55)
    • We will no longer encode non-ASCII characters by default. Please make sure that you pass on the appropriate content encoding.

New Features:

Bug Fixes:

Other notable changes:

1.0.0-rc.2...v1.0.0-rc.4

Assets 2
Loading