etylsarin/gulp-ssi

Server Side Includes parser plugin for gulp

gulp-ssi

Server Side Includes parser plugin for gulp

Works with both include types

<!--#include file="includes/navigation.html" -->

<!--#include virtual="../templates/navigation.html" -->

And now also correctly interprets directives from the root of a site

<!--#include file="/includes/navigation.html" -->

Usage

First, install gulp-ssi as a development dependency:

npm install --save-dev gulp-ssi

Then, add it to your gulpfile.js:

var ssi = require("gulp-ssi");

gulp.src("./src/*.ext")
	.pipe(ssi())
	.pipe(gulp.dest("./dist"));

Options

var ssi = require("gulp-ssi");

gulp.src("./src/*.ext")
	.pipe(ssi({root:'/some/path'}))
	.pipe(gulp.dest("./dist"));

root (optional)

Type: String
Default: File directory

Set the location where the linked files are hosted. I've preserved this feature to prevent breaking existing clients. It works fine, but it makes assumptions that all relative links eventually resolve to the root of the root directory. So...

With a root of /myroot and an include that looks like <!--#include file="../../deeper/one.inc" --> ssi will look for a file at this path:
/myroot/deeper/one.inc. See the tests for more information. I look forward to better ideas about this.

License

MIT License

gulp-ssi's Issues

Regex parsing doesn't work when include tag has other attributes

Example NGINX include statement:

<!--# block name="empty" --><!--# endblock -->
<!--# include file="/dir/file.html" stub="empty" -->

Stub provides the default value when file is missing.

gulp-util is deprecated

gulp-util has been deprecated recently. Continuing to use this dependency may prevent the use of your library with the latest release of Gulp 4 so it is important to replace gulp-util.

The README.md lists alternatives for all the components so a simple replacement should be enough.

Your package is popular but still relying on gulp-util, it would be good to publish a fixed version to npm as soon as possible.

See:

• https://medium.com/gulpjs/gulp-util-ca3b1f9f9ac5
• gulpjs/gulp-util#143