A recursive injection of partials based on their path name for gulp. 

A recursive injection of partials based on their path name for gulp

meeroslav

gulp-inject-partials

  "description": "A recursive injection of partials based on their path name for gulp",

  "homepage": "https://github.com/meeroslav/gulp-inject-partials",

  "bugs": "https://github.com/meeroslav/gulp-inject-partials/issues",

    "url": "git://github.com/meeroslav/gulp-inject-partials.git"

    "test": "mocha -R spec src/**/*.spec.js"

[![NPM version](https://img.shields.io/npm/v/gulp-inject-partials.svg)](https://npmjs.org/package/gulp-inject-partials)

[![Build Status](https://travis-ci.org/meeroslav/gulp-inject-partials.svg?branch=master)](https://travis-ci.org/meeroslav/gulp-inject-partials)

[![Dependency Status](https://david-dm.org/meeroslav/gulp-inject-partials.svg)](https://david-dm.org/meeroslav/gulp-inject-partials)

[![Code Climate](https://codeclimate.com/github/meeroslav/gulp-inject-partials/badges/gpa.svg)](https://codeclimate.com/github/meeroslav/gulp-inject-partials)

> A recursive injection of partials based on their path name for [gulp](https://github.com/wearefractal/gulp).

**Gulp-inject-partials** parses target file, located defined placeholders and injects file contents based on their relative path. See [Basic usage](#basic-usage) and [More examples](#more-examples) below.

Gulp-inject-partials is based/inspired by [`gulp-inject`](https://github.com/klei/gulp-inject).

**Note:** NodeJs v4 or above is required.

Install `gulp-inject-partials` as a development dependancy:

npm install --save-dev gulp-inject-partials

Each pair of comments are the injection placeholders (aka. tags, see [`options.start`](#optionsstart) and [`options.end`](#optionsend)).

var injectPartials = require('gulp-inject-partials');

Nesting partials works same way as single level injection. When injecting partials, `gulp-inject-partials` will parse parent file in search for partials to inject. Once it finds a partial will then recursively parse child partial.

### Setting the custom `start` and/or `end` tag

It's possible to change start and end tag by setting [`option.start`](#optionsstart) and [`options.end`](#optionsend) respectivelly.

For production purposes we would like inject tags to be removed and have a clean html. This is possible with [`options.removeTags`](#optionsremovetags).

  - `path` - relative path to source file 

Used to dynamically set starting placeholder tag, which might contain relative `path` to source file. Even thou this parameter is optional, whithout it no file would be injected.

Used to dynamically set ending placeholder tag, which might contain relative `path` to source file.

When `true` the start and end tags will be removed when injecting files.

When `true` gulp task will not render any information to console.

[MIT](http://en.wikipedia.org/wiki/MIT_License) © [Miroslav Jonas](mailto:meeroslav@yahoo.com)

var escapeStringRegexp = require('escape-string-regexp');

var PLUGIN_NAME = 'gulp-inject-partials';

var DEFAULT_START = '';

var FILE_PATH_REGEX = "((\/|\\.\/)?((\\.\\.\/)+)?((\\w|\\-)(\\.(\\w|\\-))?)+((\/((\\w|\\-)(\\.(\\w|\\-))?)+)+)?)";

var PATH_REGEX = /\\\{\\\{path\\\}\\\}/; // ugly I know

	opt.start = defaults(opt, 'start', DEFAULT_START);

	opt.end = defaults(opt, 'end', DEFAULT_END);

	opt.removeTags = bool(opt, 'removeTags', false);

	function handleStream(target, encoding, cb){

			return cb(error(target.path + ': Streams not supported for target templates!'));

			target.contents = processContent(target, opt, tagsRegExp, [target.path]);

function processContent(target, opt, tagsRegExp, listOfFiles){

	var targetContent = String(target.contents);

	var files = extractFilePaths(targetContent, targetPath, opt, tagsRegExp);

		if (listOfFiles.indexOf(fileData.file.path) !== -1) {

			throw error("Circular definition found. File: " + fileData.file.path + " referenced in a child file.");

		var content = processContent(fileData.file, opt, tagsRegExp, listOfFiles);

		targetContent = inject(targetContent, String(content), opt, fileData.tags);

	if (listOfFiles.length === 1 && !opt.quiet) {

	if (listOfFiles.length === 1 && !opt.quiet && files.length) {

		log(cyan(files.length) + ' partials injected into ' + magenta(targetPath) + '.');

 * Inject tags into target content between given

function inject(targetContent, sourceContent, opt, tagsRegExp){

	while ((startMatch = startTag.exec(targetContent)) !== null) {

			throw error('Missing end tag for start tag: ' + startMatch[0]);

		var newContents = targetContent.slice(0, startMatch.index);

			startTag.lastIndex -= startMatch[0].length;

			// <startMatch> + partial body + <endMatch>

		var previousInnerContent = targetContent.substring(startTag.lastIndex, endMatch.index);

		var indent = getLeadingWhitespace(previousInnerContent);

		newContents += targetContent.slice(endTag.lastIndex);

 * Prepare regular expressions for parsing template

 * Replace {{path}} with regular expression for matching relative path 

		return new RegExp(escapeStringRegexp(tag).replace(PATH_REGEX, replacement || FILE_PATH_REGEX), 'g');

 * Parse content and get all partials to be injected

function extractFilePaths(content, targetPath, opt, tagsRegExp) {

	tagMatches = content.match(tagsRegExp.start);

			var fileUrl = tagsRegExp.startex.exec(tagMatch)[1];

			var filePath = setFullPath(targetPath, fileUrl);

				var fileContent = fs.readFileSync(filePath);

						base: path.resolve(__dirname, 'expected', path.dirname(filePath)),

				throw error(filePath + " not found.");

	return str.match(LEADING_WHITESPACE_REGEXP)[0];

function defaults(options, prop, defaultValue) {

function bool(options, prop, defaultVal) {

	return typeof options[prop] === 'undefined' ? defaultVal : Boolean(options[prop]);

	return new gutil.PluginError(PLUGIN_NAME, message);

	gutil.log(magenta(PLUGIN_NAME), message);

		{
		"name": "gulp-inject-partials",
		"version": "0.0.3",
		"version": "1.0.0",
		"description": "A recursive injection of partials based on their path name for gulp",
		@@ -5,0 +5,0 @@ "keywords": [

		@@ -5,3 +5,2 @@ # gulp-inject-partials
		[![Build Status](https://travis-ci.org/meeroslav/gulp-inject-partials.svg?branch=master)](https://travis-ci.org/meeroslav/gulp-inject-partials)
		[![Dependency Status](https://david-dm.org/meeroslav/gulp-inject-partials.svg)](https://david-dm.org/meeroslav/gulp-inject-partials)
		[![Code Climate](https://codeclimate.com/github/meeroslav/gulp-inject-partials/badges/gpa.svg)](https://codeclimate.com/github/meeroslav/gulp-inject-partials)
		@@ -101,3 +100,3 @@
		<!-- partial:_mypartial3.html -->
		<!-- partial -->
		<!-- partial -->
		</div>
		@@ -117,3 +116,3 @@ ```
		```
		gulpfile.js
		gulpfile.js
		```javascript
		@@ -149,3 +148,3 @@ var gulp = require('gulp');
		</div>
		<!-- partial -->
		<!-- partial -->
		</div>
		@@ -269,3 +268,3 @@ <!-- partial -->
		Param (optional):
		- `path` - relative path to source file
		- `path` - relative path to source file

		@@ -272,0 +271,0 @@ Default: `<!-- partial:{{path}} -->`

		@@ -33,7 +33,7 @@ 'use strict';
		}


		if (target.isStream()) {
		return cb(error(target.path + ': Streams not supported for target templates!'));
		}


		try {
		@@ -75,6 +75,6 @@ var tagsRegExp = getRegExpTags(opt);
		listOfFiles.pop();


		targetContent = inject(targetContent, String(content), opt, fileData.tags);
		});
		if (listOfFiles.length === 1 && !opt.quiet) {
		if (listOfFiles.length === 1 && !opt.quiet && files.length) {
		log(cyan(files.length) + ' partials injected into ' + magenta(targetPath) + '.');
		@@ -109,5 +109,5 @@ }
		var toInject = [sourceContent];
		// content part before start tag
		// content part before start tag
		var newContents = targetContent.slice(0, startMatch.index);


		if (opt.removeTags) {
		@@ -137,4 +137,4 @@ // Take care of content length change
		* Prepare regular expressions for parsing template
		* Replace {{path}} with regular expression for matching relative path
		* or with exact file path
		* Replace {{path}} with regular expression for matching relative path
		* or with exact file path
		*
		@@ -141,0 +141,0 @@ * @param {Object} opt

Fixed alerts

Improved metrics

Worsened metrics