\n\n## Usage\n\n```javascript\nvar gutil = require('gulp-util');\n\ngutil.log('stuff happened', 'Really it did', gutil.colors.magenta('123'));\n\ngutil.replaceExtension('file.coffee', '.js'); // file.js\n\nvar opt = {\n name: 'todd',\n file: someGulpFile\n};\ngutil.template('test <%= name %> <%= file.path %>', opt) // test todd /js/hi.js\n```\n\n### log(msg...)\n\nLogs stuff. Already prefixed with [gulp] and all that. If you pass in multiple arguments it will join them by a space.\n\nThe default gulp coloring using gutil.colors.:\n```\nvalues (files, module names, etc.) = cyan\nnumbers (times, counts, etc) = magenta\n```\n\n### colors\n\nIs an instance of [chalk](https://github.com/sindresorhus/chalk).\n\n### replaceExtension(path, newExtension)\n\nReplaces a file extension in a path. Returns the new path.\n\n### isStream(obj)\n\nReturns true or false if an object is a stream.\n\n### isBuffer(obj)\n\nReturns true or false if an object is a Buffer.\n\n### template(string[, data])\n\nThis is a lodash.template function wrapper. You must pass in a valid gulp file object so it is available to the user or it will error. You can not configure any of the delimiters. Look at the [lodash docs](http://lodash.com/docs#template) for more info.\n\n## new File(obj)\n\nThis is just [vinyl](https://github.com/wearefractal/vinyl)\n\n```javascript\nvar file = new gutil.File({\n base: path.join(__dirname, './fixtures/'),\n cwd: __dirname,\n path: path.join(__dirname, './fixtures/test.coffee')\n});\n```\n\n## noop()\n\nReturns a stream that does nothing but pass data straight through.\n\n```javascript\n// gulp should be called like this :\n// $ gulp --type production\ngulp.task('scripts', function() {\n gulp.src('src/**/*.js')\n .pipe(concat('script.js'))\n .pipe(gutil.env.type === 'production' ? uglify() : gutil.noop())\n .pipe(gulp.dest('dist/'));\n});\n```\n\n## buffer(cb)\n\nThis is similar to es.wait but instead of buffering text into one string it buffers anything into an array (so very useful for file objects).\n\nReturns a stream that can be piped to.\n\nThe stream will emit one data event after the stream piped to it has ended. The data will be the same array passed to the callback.\n\nCallback is optional and receives two arguments: error and data\n\n```javascript\ngulp.src('stuff/*.js')\n .pipe(gutil.buffer(function(err, files) {\n \n }));\n```\n\n## new PluginError(pluginName, message[, options])\n\n- pluginName should be the module name of your plugin\n- message can be a string or an existing error\n- By default the stack will not be shown. Set `options.showStack` to true if you think the stack is important for your error.\n- If you pass an error in as the message the stack will be pulled from that, otherwise one will be created.\n- Note that if you pass in a custom stack string you need to include the message along with that.\n- Error properties will be included in `err.toString()`. Can be omitted by including `{showProperties: false}` in the options.\n\nThese are all acceptable forms of instantiation:\n\n```javascript\nvar err = new gutil.PluginError('test', {\n message: 'something broke'\n});\n\nvar err = new gutil.PluginError({\n plugin: 'test',\n message: 'something broke'\n});\n\nvar err = new gutil.PluginError('test', 'something broke');\n\nvar err = new gutil.PluginError('test', 'something broke', {showStack: true});\n\nvar existingError = new Error('OMG');\nvar err = new gutil.PluginError('test', existingError, {showStack: true});\n```\n\n[npm-url]: https://www.npmjs.com/package/gulp-util\n[npm-image]: https://badge.fury.io/js/gulp-util.svg\n[travis-url]: https://travis-ci.org/gulpjs/gulp-util\n[travis-image]: https://img.shields.io/travis/gulpjs/gulp-util.svg?branch=master\n[coveralls-url]: https://coveralls.io/r/gulpjs/gulp-util\n[coveralls-image]: https://img.shields.io/coveralls/gulpjs/gulp-util.svg\n[depstat-url]: https://david-dm.org/gulpjs/gulp-util\n[depstat-image]: https://david-dm.org/gulpjs/gulp-util.svg\n",
"readmeFilename": "README.md",
"repository": {
"type": "git",
"url": "git+https://github.com/gulpjs/gulp-util.git"
},
"scripts": {
"coveralls": "istanbul cover _mocha --report lcovonly && istanbul-coveralls",
"test": "jshint *.js lib/*.js test/*.js && mocha"
},
"version": "3.0.8"
}