		var through = require('through2');
		var File = require('vinyl');
		var gutil = require('gulp-util');
		var PluginError = gutil.PluginError;

		function hashify (fileName) {
		function hashify (fileName, varName) {
		varName = varName \|\| 'views';

		if (!fileName) {
		throw new PluginError('gulp-hashify', 'Missing file option for gulp-hashify');
		throw new PluginError('gulp-hashify', 'Missing fileName option for gulp-hashify');
		}

		var views = {};

		var hasViews = false;
		@@ -42,11 +47,6 @@

		// Generate the views js file contents
		var jsScript = 'var views = ' +
		JSON.stringify(views) +
		';\nif (typeof module !== "undefined" && module.exports) { module.exports = views; }';

		// Push the views js file into the stream
		this.push(new File({
		path: fileName,
		contents: new Buffer(jsScript)
		contents: new Buffer(genScript(views, varName))
		}));
		@@ -60,2 +60,11 @@

		function genScript(views, varName) {
		var isProperty = ~varName.indexOf('.');

		return (isProperty ? '' : 'var ') +
		varName + '=' +
		JSON.stringify(views) +
		';\nif (typeof module !== "undefined" && module.exports) { module.exports = views; }';
		}

		module.exports = hashify;

package.json

		{
		"name": "gulp-hashify",
		"version": "0.0.1",
		"version": "0.0.2",
		"description": "A gulp plugin for turning a stream of files into a JavaScript object.",
		"main": "hashify.js",
		"scripts": {
		"test": "echo \"Error: no test specified\" && exit 1"
		"test": "mocha"
		},
		@@ -13,4 +13,13 @@ "author": "Chris Davies",
		"gulp": "^3.9.0",
		"through2": "^0.6.5"
		"jasmine-node": "^1.14.5",
		"mocha": "^2.2.5",
		"should": "^6.0.3",
		"stream-array": "^1.1.0",
		"stream-assert": "^2.0.2",
		"through2": "^0.6.5",
		"vinyl": "^0.4.6"
		},
		"dependencies": {
		"gulp-util": "^3.0.5"
		}
		}

readme.md

		# gulp-hashify

		A gulp plugin for turning a stream of files into a JavaScript object.
		A gulp plugin for turning a stream of files into a JavaScript object.

		## Installation

		```
		npm install --save-dev gulp-hashify
		```

		## Usage

		```javascript
		var hashify = require('gulp-hashify');

		gulp.task('hashify', function () {
		return gulp.src('./src/views/*/.html')
		.pipe(hashify('views.js'))
		.pipe(gulp.dest('./dist/js'));
		});
		```

		After running the `hashify` task, there will be a `./dist/js/views.js` file. Let's say that the
		`./src/views/` directory looked like this:

		```
		/views
		/errors
		404.html
		500.html
		index.html
		users.html
		```

		Then, `./dist/js/views.js` would end up looking like this:

		```javascript
		var views = {
		'errors/404': '<h1>Not found or whatever the content of /views/errors/404.html was</h1>',
		'errors/500': '<h1>Doh!</h1>',
		'index': 'The contents of /views/index.html',
		'users': 'The contents of /views/users.html'
		};

		if (typeof module !== "undefined" && module.exports) {
		module.exports = views;
		}
		```

		## Arguments

		The hashify function takes two arguments:

		- fileName = the name of the file to be output
		- varName = (optional) the name of the variable to be included in the output file. Defaults to views. If varName has a `.` in it, then it will not produce a variable declaration at all.

		### Example

		```javascript
		var hashify = require('gulp-hashify');

		gulp.task('hashify', function () {
		return gulp.src('./src/views/*/.html')
		.pipe(hashify('views.js', 'app.templates'))
		.pipe(gulp.dest('./dist/js'));
		});
		```

		Would produce a file that looked like this:

		```javascript
		app.templates = {
		'errors/404': '<h1>Not found or whatever the content of /views/errors/404.html was</h1>',
		'errors/500': '<h1>Doh!</h1>',
		'index': 'The contents of /views/index.html',
		'users': 'The contents of /views/users.html'
		};

		if (typeof module !== "undefined" && module.exports) {
		module.exports = views;
		}
		```

		---

		## License MIT

		Copyright (c) 2015 Chris Davies

		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.

gulp-hashify - npm Package Compare versions

New alerts

Fixed alerts

Improved metrics

Worsened metrics

Dependency changes