gulp-rev-append
Advanced tools
gulp plugin for cache-busting files using file hash
$ npm install gulp-rev-append --save-dev
gulpfile.js
var rev = require('gulp-rev-append');
gulp.task('rev', function() {
gulp.src('./index.html')
.pipe(rev())
.pipe(gulp.dest('.'));
});
terminal
$ gulp rev
The gulp-rev-append task allows for appending a file hash to dependencies declared in html files defined using the following regex: (?:href|src)="(.*)[\?]rev=(.*)[\"]
That's fancy talk for any stylesheet or script declarations that are declared in an html file such as the following:
<!doctype html>
<html>
<head>
<link rel="stylesheet" type="text/css" href="style/style-one.css?rev=@@hash">
<script src="script/script-one.js?rev=@@hash"></script>
<script src="script/script-two.js"></script>
</head>
<body>
<div><p>hello, world!</p></div>
<script src="script/script-three.js?rev=@@hash"></script>
</body>
</html>
will turn into something similar as the following after running gulp-rev-append:
<!doctype html>
<html>
<head>
<link rel="stylesheet" type="text/css" href="style/style-one.css?rev=d65aaba987e9c1eefeb4be9cfd34e0de">
<script src="script/script-one.js?rev=17a5da6c8a2d875cf48aefb722eefa07"></script>
<script src="script/script-two.js"></script>
</head>
<body>
<div><p>hello, world!</p></div>
<script src="script/script-three.js?rev=5cadf43edba6a97980d42331f9fffd17"></script>
</body>
</html>
Any subsequent runs of the gulp-rev-append file will change the output only if the target file(s) delcared have changed. This is because the revision hash is computed using the target file contents.
The only requirement is that the dependency is declared with the appendage ?rev=. @@hash is not required, and any value will be overriden as the dependency file contents change.
I wanted to easily define dependencies that require cache-busting by appending the file declaration in an html file. The hash is based on file content, so any change to the dependency would result in a change to the generated and appended hash - effectively cahe-busting the dependency.
There are several gulp plugins that already support revisioning and cache-busting: https://www.npmjs.org/search?q=gulp-rev
I created this plugin as it fit my needs more clearly in:
If the intent of this plugin does not meet your needs, please checkout the other possible solutions made by some awesome developers.
$ npm run test
Copyright (c) 2014 Todd Anderson
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
Cache-busting plugin for gulp.
The npm package gulp-rev-append receives a total of 500 weekly downloads. As such, gulp-rev-append popularity was classified as not popular.
We found that gulp-rev-append 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
The Socket Research team breaks down a malicious npm package targeting the legitimate DOMPurify library. It uses obfuscated code to hide that it is exfiltrating browser and crypto wallet data.
Security News
ENISA’s 2024 report highlights the EU’s top cybersecurity threats, including rising DDoS attacks, ransomware, supply chain vulnerabilities, and weaponized AI.
Security News
NIST's new password guidelines remove periodic changes and special character requirements, focusing on longer, more secure passwords for better authentication practices.