gulp-useref-cdn
Advanced tools
Parse build blocks in HTML files to replace references and automatically upload to qiniu cdn.
Parse build blocks in HTML files to replace references and automatically upload to qiniu cdn.
Inspired by grunt-useref and gulp-useref. It can handle file concatenation but not minification. And it can upload the concatenated file to cdn automatically. Files are then passed down the stream. For minification of assets or other modifications, use gulp-if to conditionally handle specific types of assets.
Note: lot of code from gulp-useref. gulp-useref doesn't apply a way to manage html file analysis or a callback after html file analysis. This is why I don't make gulp-useref as lib dependency and rewrite based on it.
Install with npm
npm install --save-dev gulp-useref-cdn
The following example will parse the build blocks in the HTML, replace them, upload to cdn, and pass those files through. Assets inside the build blocks will be concatenated and passed through in a stream as well.
var gulp = require('gulp'),
useref = require('gulp-useref-cdn');
gulp.task('default', function () {
var assets = useref.assets();
return gulp.src('app/*.html')
.pipe(assets)
.pipe(assets.restore())
.pipe(useref())
.pipe(gulp.dest('dist'));
});
More details: https://github.com/jonkemp/gulp-useref. All gulp-useref's syntax and usage are supported by gulp-useref-cdn.
What's important here is that an extended syntax/usage is added!
<!-- build:<type>(alternate search path) <path> <attrs> -->
Before, type could be either js, css or remove. And the new cdn is added now.
When you use cdn as the type, no need to write js or css anymore. The plugin will detect it automatically, and it will do the work as expected when you use js|css.
And with the cdn type, the plugin will upload the concatenated file to qiniu cdn.
An example of this in completed form can be seen below:
<html>
<head>
<!-- build:cdn css/combined.css -->
<link href="css/one.css" rel="stylesheet">
<link href="css/two.css" rel="stylesheet">
<!-- endbuild -->
</head>
<body>
<!-- build:cdn scripts/combined.js <bucket='xxx'> <key='yyy'>-->
<script type="text/javascript" src="scripts/one.js"></script>
<script type="text/javascript" src="scripts/two.js"></script>
<!-- endbuild -->
</body>
</html>
import cdn from 'gulp-useref-cdn';
let assets = cdn.assets({
accessKey: 'ACCESS_KEY',
secretKey: 'SECRET_KEY',
domain: 'DOMAIN',
bucket: 'BUCKET', // could be replaced if you rewrite at html <bucket='xxx'>
keyPrefix: ''
});
gulp.src('test/fixtures/cdn.html')
.pipe(assets)
.on('error', (err) => {
done(err);
})
.pipe(assets.restore())
.pipe(cdn())
.pipe(gulp.dest('dist'));
The resulting HTML would be:
<html>
<head>
<link rel="stylesheet" href="http://7xkuzg.com1.z0.glb.clouddn.com/combined-f9ebd308.css"/>
</head>
<body>
<script src="http://7xkuzg.com1.z0.glb.clouddn.com/combined-ce2a0c47.js"></script>
</body>
</html>
And you will see combined-ce2a0c47.js and combined-f9ebd308.css in your qiniu cdn's bucket.
Returns a stream with the asset replaced resulting HTML files. Supports all options from useref.
Returns a stream with the concatenated asset files from the build blocks inside the HTML.
Type: String or Array
Default: none
Specify the location to search for asset files, relative to the current working directory. Can be a string or array of strings.
Type: Boolean
Default: false
Skip concatenation and add all assets to the stream instead.
Type: Boolean
Default: true
Set to false if you want to see messages except error.
Type: Number
Default: 8
Type: String
Default: gulp-useref-cdn/
The above two are all about key. Key is defined by Qiniu. Key can be set clearly via <key='yyy'> in comment.
When key is not offered, plugin will generate the key:
prefix + filename + '-' + md5 + '.' + filetype;
prefix --- options.keyPrefixmd5 --- the md5 string of the file, options.md5 specify md5's length(after cut).filename, filetype are offered by plugin.Brings back the previously filtered out HTML files.
Copyright (c) 2015 creeperyang. Licensed under the MIT license.
FAQs
Parse build blocks in HTML files to replace references and automatically upload to qiniu cdn.
The npm package gulp-useref-cdn receives a total of 2 weekly downloads. As such, gulp-useref-cdn popularity was classified as not popular.
We found that gulp-useref-cdn 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.
Security News
Research
Socket researchers have discovered malicious npm packages targeting crypto developers, stealing credentials and wallet data using spyware delivered through typosquats of popular cryptographic libraries.
Security News
Socket's package search now displays weekly downloads for npm packages, helping developers quickly assess popularity and make more informed decisions.
Security News
A Stanford study reveals 9.5% of engineers contribute almost nothing, costing tech $90B annually, with remote work fueling the rise of "ghost engineers."