I'm a fan of Python library BeautifulSoup. It's feature-rich and very easy to use. But when I am working on a small react-native project, and I tried to find a HTML parser library
like BeautifulSoup, I failed.
So I want to write a HTML parser library which can be so easy to use just like BeautifulSoup in Javascript.
JSSoup uses tautologistics/node-htmlparser as HTML dom parser,
and creates a series of BeautifulSoup like API on top of it.
JSSoup supports both node and react-native.
JSSoup tries to use the same interfaces as BeautifulSoup so BeautifulSoup user can use JSSoup seamlessly.
However, JSSoup uses Javascript's camelCase naming style instead of Python's underscore naming style.
Such as find_all() in BeautifulSoup is replaced as findAll().
$ npm install jssoup
//react-native
import JSSoup from 'jssoup';
// nodejs
var JSSoup = require('jssoup').default;
var soup = new JSSoup('<html><head>hello</head></html>');
The text element only contains whitespace will be ignored by default. To disable this feature, set second parameter of JSSoup to false. This parameter is "ignoreWhitespace" and will be passed into htmlparser.
var soup = new JSSoup('<html><head>hello</head></html>', false);
var soup = new JSSoup('<html><head>hello</head></html>');
var tag = soup.find('head');
tag.name
// 'head'
tag.name = 'span'
console.log(tag)
//<span>hello</span>
var soup = new JSSoup('<tag id="hi" class="banner">hello</tag>');
var tag = soup.nextElement;
tag.attrs
// {id: 'hi', class: 'banner'}
tag.attrs.id = 'test';
console.log(tag)
// <tag id="test" class="banner">hello</tag>
var data = `
<div>
<a>1</a>
<b>2</b>
<c>3</c>
</div>
`
var soup = new JSSoup(data);
var div = soup.nextElement;
var b = div.nextElement.nextElement;
// b.string: '2'
var a = b.previousElement;
// a.string: '1'
var soup = new JSSoup(data);
var div = soup.nextElement;
var a = div.nextElement;
var b = a.nextSibling;
var c = b.nextSibling;
c.nextSibling == undefined;
var soup = new JSSoup(data);
var a = soup.find("a");
a.nextSiblings
// [<b>2</b>, <c>3</c>]
var c = soup.find("c");
c.previousSiblings
// [<a>1</a>, <b>2</b>]
div.contents
// [<a>1</a>, <b>2</b>, <c>3</c>]
div.descendants
// [<a>1</a>, 1, <b>2</b>, 2, <c>3</c>, 3]
div.parent == soup
b.extract();
div.contents
// [<a>1</a>, <c>3</c>]
b.extract();
div.append(b)
div.contents
// [<a>1</a>, <c>3</c>, <b>2</b>]
d.prettify('', '')
// <d>4</d>
div.insert(1, d)
div.contents
// [<a>1</a>, <d>4</d>, <b>2</b>, <c>3</c>]
d.prettify('', '')
// <d>4</d>
b.replaceWith(d)
div.contents
// [<a>1</a>, <d>4</d>, <c>3</c>]
c.string.replaceWith('new')
div.contents
// [<a>1</a>, <d>4</d>, <c>new</c>]
var data = `
<div>
<div class="h1"></div>
<a>hello</a>
</div>
`
var soup = new JSSoup(data);
soup.findAll('a')
// [<a>hello</a>]
soup.findAll('div', 'h1')
// [<div class="h1"></div>]
var data = `
<div>
<p> hello </p>
<p> world </p>
</div>
`
var soup = new JSSoup(data);
soup.find('p')
// <p> hello </p>
var data = `
<div>
<span> test </span>
<div> div </div>
<p> hello </p>
<p> world </p>
</div>
`
var soup = new JSSoup(data);
var span = soup.find('span');
span.findNextSibling('p')
// <p> hello </p>
var data = `
<div>
<span> test </span>
<div> div </div>
<p> hello </p>
<p> world </p>
</div>
`
var soup = new JSSoup(data);
var span = soup.find('span');
span.findNextSiblings('p')
// <p> hello </p>
// <p> world </p>
var data = `
<div>
<p> hello </p>
<p> world </p>
<div> div </div>
<span> test </span>
</div>
`
var soup = new JSSoup(data);
var span = soup.find('span');
span.findPreviousSibling('p')
// <p> world </p>
var data = `
<div>
<p> hello </p>
<p> world </p>
<div> div </div>
<span> test </span>
</div>
`
var soup = new JSSoup(data);
var span = soup.find('span');
span.findPreviousSiblings('p')
// <p> hello </p>
// <p> world </p>
var soup = new JSSoup('<html><head>hello</head></html>');
soup.prettify()
// <html>
// <head>
// hello
// </head>
// </html>
div.text
// '123'
div.getText('|')
// '1|2|3'
b.string == '2';
var soup = new JSSoup('<html><head>hello</head></html>');
soup.string == 'hello';
npm test
There's a lot of work need to be done.
FAQs
JSSoup is a BeautifulSoup style HTML parser library.
The npm package jssoup receives a total of 10,948 weekly downloads. As such, jssoup popularity was classified as popular.
We found that jssoup demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Socket uncovered npm malware campaign mimicking popular Node.js libraries and packages from other ecosystems; packages steal data and execute remote code.
Research
Socket's research uncovers three dangerous Go modules that contain obfuscated disk-wiping malware, threatening complete data loss.
Research
Socket uncovers malicious packages on PyPI using Gmail's SMTP protocol for command and control (C2) to exfiltrate data and execute commands.