Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gahabeen/jsonframe-cheerio
simple multi-level scraper json input/output for Cheerio
https://github.com/gahabeen/jsonframe-cheerio
frame json parsed-data scraper scraping selector
Last synced: 13 days ago
JSON representation
simple multi-level scraper json input/output for Cheerio
- Host: GitHub
- URL: https://github.com/gahabeen/jsonframe-cheerio
- Owner: gahabeen
- License: mit
- Created: 2017-01-27T08:51:23.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2023-01-13T11:13:48.000Z (almost 2 years ago)
- Last Synced: 2024-10-06T21:05:49.355Z (about 1 month ago)
- Topics: frame, json, parsed-data, scraper, scraping, selector
- Language: JavaScript
- Homepage:
- Size: 107 KB
- Stars: 198
- Watchers: 7
- Forks: 24
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# This repository is deprecated. Use it at your own risk!
---
[](https://nodei.co/npm/jsonframe-cheerio/)
jsonframe
simple multi-level scraper json input/output
## **2.0.5x** features
😍 **JSON Syntax**: input json, output the same structured json including with scraped data
🌈 **Simple patterns**: simple inline `selectors`, `extractors`, `filters` and `parser`.
💪 **Reliable & fast**: used in production within crawlers
[See the full changelog](#changelog)
## Example
```js
let cheerio = require('cheerio')
let $ = cheerio.load(`
I love jsonframe!
Email: [email protected]
`)
let jsonframe = require('jsonframe-cheerio')
jsonframe($) // initializing the plugin
let frame = {
"title": "h1", // this is an inline selector
"email": "span[itemprop=email] < email" // output an extracted email
}
console.log( $('body').scrape(frame, { string: true } ))
/*=>
{
"title": "I love jsonframe!",
"email": "[email protected]"
}
/*
```
## Use
**Install the plugin** to your Node.js app through **NPM**
```
npm i jsonframe-cheerio --save
```
## API
### Loading
Start by `loading Cheerio`.
```js
let cheerio = require('cheerio')
let $ = cheerio.load("HTML DOM to load") // See Cheerio API
```
Then `load the jsonframe plugin`.
```js
let jsonframe = require('jsonframe-cheerio') // require from npm package
jsonframe($) // apply the plugin to the current Cheerio instance
```
### Scraper
Once the plugin is loaded, you've first got to set the **frame** of your data.
Let's take the following `HTML example`:
```html
Pricing
A Link
We are the 04/02/2017
Some inner content
-
Hacker
Free
-
Pro
$39
Phone USA: (912) 148-456
Phone FR: +332 38 30 37 90
Email: [email protected]
```
#### $( selector ).scrape( frame , {options})
`selector` is defined in [Cheerio's documentation](https://github.com/cheeriojs/cheerio#-selector-context-root-)
`frame` is a JSON or Javascript Object
`{options}` are detailed [later in its own section](#options)
```js
let frame = {
"title": "h2" // CSS selector
}
```
We then pass the frame to the function:
```js
let result = $('body').scrape(frame, { string: true })
console.log( result )
//=> {"title": "Pricing"}
```
### Frame
#### Inline Selector
Most common selector, `inline line` by specifying nothing more than the data name property and the selector as its value.
```js
...
let frame = { "title": "h2" }
let result = $('body').scrape(frame, { string: true })
console.log( result )
/* output =>
{ "title": "Pricing" }
*/
...
```
#### New : Inline attribute / extractor / parser
You can now declare everything in line. You should just be careful to always use them in the following order when combining them : `@ (attribute), | (extractor), || (parse)`.
_See examples for each of them above._
#### Attribute
`_a: "attributeName"` allows you to retrieve `any attribute data`
`@` inside the selector `_s` allows you to do it inline
```js
...
let frame = {
"proPrice": ".planName:contains('Pro') + span@price"
}
let result = $('body').scrape(frame, { string: true })
console.log( result )
/* output =>
{ "proPrice": "39.00" }
*/
...
```
#### Extractor
`<` inside the selector `_s` allows you to do it inline
It currently supports `email` (also `mail`), `telephone` (also `phone`), `date`, `fullName` (or `firstName`, `lastName`, `initials`, `suffix`, `salutation`) and `html` (to get the inner html) and by default (no declaration), we get the `inner text`.
```js
...
let frame = {
"email": "[itemprop=email] < phone",
"frphone": "[itemprop=frphone] < phone"
}
let result = $('body').scrape(frame, { string: true })
console.log( result )
/* output =>
{
"email": "[email protected]",
"frphone": "33238303790"
}
*/
...
```
#### Filter
`|` inside the selector `_s` allows you to do it inline
It currently supports `trim` (remove spaces at beginning and end), `lowercase or lcase`, `uppercase or ucase`, `capitalize or cap`, `words or w`, `noescapchar or nec`, `compact or cmp` and `number or nb`.
```js
...
let frame = {
"email1": "[itemprop=email] < phone | uppercase",
"email2": "[itemprop=email] < phone | capitalize"
}
let result = $('body').scrape(frame, { string: true })
console.log( result )
/* output =>
{
"email1": "[email protected]",
"email2": "EXAMPLE GOOGLE NET"
}
*/
...
```
#### Parse / Regex
`||` inside the selector `_s` allows you to use regexes in line
`_p: /regex/` allows you to extract data based on **regular expressions**
```js
...
let frame = {
"data": ".date || \\d{1,2}/\\d{1,2}/\\d{2,4}"
}
// or use the longer version for proper regex entry
let frame = {
"data": {
_s: ".date",
_p: /\d{1,2}\/\d{1,2}\/\d{2,4}/ // n[n]/n[n]/nn[nn] format here
}
}
let result = $('body').scrape(frame, { string: true })
console.log( result )
/* output =>
{
"date": "04/02/2017"
}
*/
...
```
#### List / Array
`_d: [{ }]` allows you to get an `array / list of data`
`_d: ["selector"]` will retrieves a list based on the selector inbetween quotes.
`_d: ["firstSelector", "secondSelector"]` works too and merge the results into one array
You could even shorten it more by listing right from the selector as follows:
`"selectorName": [".selector"]` which returns an array of strings
```js
...
let frame = {
"pricing": {
_s: "#pricing .item",
_d: [{
"name": ".planName",
"price": ".planPrice"
}]
}
}
let result = $('body').scrape(frame, { string: true })
console.log( result )
/* output =>
{
"pricing": [
{
"name": "Hacker",
"price": "Free"
},
{
"name": "Pro",
"price": "$39"
}
]
}
*/
// Or a shorter way which works for simple string arrays
let frame = {
"pricingNames": ["#pricing .item .planName"]
}
let result = $('body').scrape(frame, { string: true })
console.log( result )
/* output =>
{
"pricingNames": ["Hacker", "Pro"]
}
*/
...
```
#### Grouped
`"_g": { _s: "", _d: {} }` allows you to group some data selectors by a parent selector without naming the parent. You can also extends the group property to add some meaning or simply have several groups at the same level.
Group property name must be `_g` or `_group` followed by `_` and whatever string you want.
ex: `_g_head : {}` or `_g_body : {}`
```js
...
let frame = {
_g: {
_s: "#pricing .item",
_d: {
"name": ".planName",
"price": ".planPrice"
}
},
_g_second: {
_s: "#pricing .item",
_d: {
"secondName": ".planName",
"secondPrice": ".planPrice"
}
}
}
let result = $('body').scrape(frame, { string: true })
console.log( result )
/* output =>
{
"name": "Hacker",
"price": "Free",
"secondName": "Hacker",
"secondPrice": "Free"
}
*/
...
```
#### Nested
`"parent": { _s: "parentSelector", _d: {} }` allows you to segment your data by `setting a parent section` from which the child data will be scraped.
You can also use `"parent": { }` when you only want to nest data into objects without setting a parent selector.
```js
...
let frame = {
"pricing": {
_s: "#pricing .item",
_d: {
"name": ".planName",
"price": ".planPrice"
}
}
}
let result = $('body').scrape(frame, { string: true })
console.log( result )
/* output =>
{
"pricing":{
"name": "Hacker",
"price": "Free"
}
}
*/
...
```
> Note here that we get the first returned result (#pricing .item).
#### Example
See how you can properly `structure your data`, ready for the output!
```js
...
let frame = {
"pricing": {
_s: "#pricing .item",
_d: [{
"name": ".planName",
"price": ".planPrice @ price",
"image": {
"url": "img @ src",
"link": "a @ href"
}
}]
}
}
let result = $('body').scrape(frame, { string: true })
console.log( result )
/* output =>
{
"pricing":[
{
"name": "Hacker",
"price": "0",
"image": {
"url": "./img/hacker.png",
"link": "/hacker"
}
},
{
"name": "Pro",
"price": "39.00",
"image": {
"url": "./img/pro.png",
"link": "/pro"
}
}
]
}
*/
...
```
> Note here that we get the first returned result (#pricing .item).
### Options
```js
...
let frame = {
"proPrice": {
_s: ".planName:contains('Pro') + span",
_a: "price"
}
}
let result = $('body')
.scrape(frame, {
timestats: true, // default: false
string: true // default: false
})
console.log(result)
/* output =>
{
"proPrice": {
"value":"39.00",
"_timestats": "1" // ms
}
}
*/
...
```
## Tests
One shot tests
```bash
npm run test
```
Watching test on updates
```bash
npm run test-watch
```
## Changelog
⚠ Careful if you've been using **jsonframe** from the **version 1.x.x**, some things changed to make it more **flexible**, **faster to use (inline parameters)** and **more meaningful in the syntax**.
**2.0.52** (28/02/2017)
- Update the email regex
- Update the website regex
- Fix array into array results
- Improving script efficiency getting data from node(s)
- Fix date extractor when no date to extract
**2.0.51** (27/02/2017)
- Fix a fatal error (argh) which was just a typo about the new chained extractors
**2.0.50** (27/02/2017)
- Extractors chaining is now possible. For ex: `.selector < html email` would work
**2.0.49** (27/02/2017)
- Fixing issue when attribute doesn't exists (@ attributeNmae)
- Improving array of object management (need to find a way to avoid empty objects still)
**2.0.48** (27/02/2017)
- Add Filter `Split(char)` to split string based on character (default to whitespace)
- Add Extractor `numbers or nb` (return potentially an array)
- Update Filter `numbers or nb` (simply filter the string to output only numbers)
- Add Filter `between(string1&&string2)` to filter data by starting and finishing string
- Add Filter `before(string)` to get data before a string
- Add Filter `after(string)` to get data after a string
- Add array support to Filter `left(nb)` and `right(nb)` (slice the array elements)
- Add Filter `fromto(startNb,endNb)` to either slice an array or a string from index to index
- Add Filter `get(nb)` to extract either an array item or a character from a string
**2.0.46** (26/02/2017)
- Rebuild of the Unstructured scraper with breaks (_b) - Works like a charm now!
**2.0.45** (25/02/2017)
- Fix weird fullName parsing in some cases
- Update Handle of Regex - Is now able to capture a group with a regex
**2.0.44** (24/02/2017)
- Inline array for extractors like `"mails": [".parentSelector < email"]`
- Adds french words: `prenom` and `nom` to humanname extractor
- Add filters: `right(number)`, `left(number)`
- Set a stricter regex for email extractor `/([a-zA-Z0-9._-]{0,30}@[a-zA-Z0-9._-]{0,15}\.[a-zA-Z0-9._-]{0,15})/gmi`
**2.0.3** (23/02/2017)
- Possibility to scrape unstructured data with breaks (`_b`). More about this soooon in the readme.
- New filters: `words or w`, `noescapchar or nec` and `compact or cmp`
- Multi-filters is available now. Ex: `.selector | words compact`. Simply separated by spaces.
- Disabling google libphonenumber for now
**2.0.2** (15/02/2017)
- String option to get a stringified output right away
- Multi-groups possibility at same level (several _g wouldn't work as same property name) in frame like _g_head and _g_body for example
- Joined arrays/lists with ["firstlist.selector", "secondlist.selector", "..."] when inline
- Better handling of img node - automatic src attribute is output (if nothing else set)
**2.0.1** (14/02/2017)
- Fixed the non-passing tests and added all the new ones for 2.x.x updates
- Refactoring the way data is processed for future multiple occurences
**2.0.0** (12/02/2017)
- ⚠ Changing ~~`Type`~~ for `Extractor` with shortcode `<` instead of `|`
- ⚠ `filters` with the shortcode `|`
- Inline parameters support for `"attribute"`, `"extractor"` and `"parse"`
- Simple string arrays from inline selector
- Group property to group data selectors whitout naming the group (childs take the place of the group property `"_g"` or `"_group"` )
**1.1.1** (05/02/2017)
- Short & functionnal parameters ( `_s`, `_t`, `_a`) instead of `"selector"`, `"extractor"`, `"attr"`. Idea behind being to easily differentiate **retrieved data name** to **functionnal data**.
- Automatic handler for `img` selected element (automatically retrieve the img src link)
- `_parent_` selector to target the **parent content**
- A **regex parser** with the functionnal parameter **parse**: `_p` (`_parse` works too)
- **Extractor** `_t: "html"` feature to get back **inner html of a selector**
- Added **timestats** to measure time spent on each node via `.scrape(frame, {timestats: true})`
- Refactorization of the whole code to make it evolutive (DRY)
- Update of the tests cases accordingly
**1.0.0** (27/01/2017)
- Stable version release with basic features
## Contributing 🤝
> Feel free to follow the procedure to make it even more awesome!
1. Create an `issue` so we `get the discussion started`
2. Fork it!
3. Create your feature branch: `git checkout -b my-new-feature`
4. Commit your changes: `git commit -am 'Add some feature'`
5. Push to the branch: `git push origin my-new-feature`
6. Submit a pull request :D
## License
[Gabin Desserprit](mailto:[email protected]) - [datascraper.pro](datascraper.pro)
Released under MIT License