Product
Introducing SSO
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
gulp-cheerio
Advanced tools
Readme
This is a plugin for gulp which allows you to manipulate HTML and XML files using cheerio.
There are two ways to use gulp-cheerio
: synchronous and asynchronous. See
the following usage examples:
var gulp = require('gulp'),
cheerio = require('gulp-cheerio');
gulp.task('sync', function() {
return gulp
.src(['src/*.html'])
.pipe(
cheerio(function($, file) {
// Each file will be run through cheerio and each corresponding `$` will be passed here.
// `file` is the gulp file object
// Make all h1 tags uppercase
$('h1').each(function() {
var h1 = $(this);
h1.text(h1.text().toUpperCase());
});
}),
)
.pipe(gulp.dest('dist/'));
});
gulp.task('async', function() {
return gulp
.src(['src/*.html'])
.pipe(
cheerio(function($, file, done) {
// The only difference here is the inclusion of a `done` parameter.
// Call `done` when everything is finished. `done` accepts an error if applicable.
done();
}),
)
.pipe(gulp.dest('dist/'));
});
Additional options can be passed by passing an object as the main argument
with your function as the run
option:
var gulp = require('gulp'),
cheerio = require('gulp-cheerio');
gulp.task('sync', function() {
return gulp
.src(['src/*.html'])
.pipe(
cheerio({
run: function($, file) {
// Each file will be run through cheerio and each corresponding `$` will be passed here.
// `file` is the gulp file object
// Make all h1 tags uppercase
$('h1').each(function() {
var h1 = $(this);
h1.text(h1.text().toUpperCase());
});
},
}),
)
.pipe(gulp.dest('dist/'));
});
gulp.task('async', function() {
return gulp
.src(['src/*.html'])
.pipe(
cheerio({
run: function($, file, done) {
// The only difference here is the inclusion of a `done` parameter.
// Call `done` when everything is finished. `done` accepts an error if applicable.
done();
},
}),
)
.pipe(gulp.dest('dist/'));
});
If you want to use custom parser options simply use the parserOptions
option:
cheerio({
run: function() {},
parserOptions: {
// Options here
},
});
When the xmlMode option is set to true cheerio's $.xml() method will be used to render:
cheerio({
run: function() {},
parserOptions: {
xmlMode: true,
},
});
This module includes cheerio version 0.*
. If you want to use your own
special build / version of cheerio
, you can pass it in as an option:
cheerio({
cheerio: require('my-cheerio'), // special version of `cheerio`
});
As of version 0.4.0
the parsed $
object returned from cheerio.load(...)
is cached to gulp's file
object as file.cheerio
. gulp-cheerio
will look
for file.cheerio
before attempting to use cheerio.load(...)
. This means
that if you use gulp-cheerio
multiple times in the same stream or with
another plugin that supports caching cheerio in this fashion (such as
gulp-svgstore
) each file will only be parsed once.
The MIT License
Copyright (c) 2014 Kenneth Powers
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
FAQs
Manipulate HTML and XML files with Cheerio in Gulp.
The npm package gulp-cheerio receives a total of 6,826 weekly downloads. As such, gulp-cheerio popularity was classified as popular.
We found that gulp-cheerio 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.
Product
Streamline your login process and enhance security by enabling Single Sign-On (SSO) on the Socket platform, now available for all customers on the Enterprise plan, supporting 20+ identity providers.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.