gulp-footer

Gulp extension to add footer to file(s) in the pipeline.

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
gulp-footer
922.1.02 years ago11 years agoMinified + gzip package size for gulp-footer in KB

Readme

The canonical location of this project is now gulp-community/gulp-footer.
gulp-footer NPM version Build Status
gulp-footer is a Gulp extension to add a footer to file(s) in the pipeline. Gulp is a streaming build system utilizing node.js.
var footer = require('gulp-footer');

API

footer(text, data)

text

Type: String
Default: ''
The template text.

data

Type: Object
Default: {}
The data object used to populate the text.

Usage

var footer = require('gulp-footer');

gulp.src('./foo/*.js')
  .pipe(footer('Hello'))
  .pipe(gulp.dest('./dist/')

gulp.src('./foo/*.js')
  .pipe(footer('Hello <%= name %>\n', { name : 'World'} ))
  .pipe(gulp.dest('./dist/')

gulp.src('./foo/*.js')
  .pipe(footer('Hello ${name}\n', { name : 'World'} ))
  .pipe(gulp.dest('./dist/')


//
var pkg = require('./package.json');
var banner = ['/**',
  ' * <%= pkg.name %> - <%= pkg.description %>',
  ' * @version v<%= pkg.version %>',
  ' * @link <%= pkg.homepage %>',
  ' * @license <%= pkg.license %>',
  ' */',
  ''].join('\n');

//passing in the text
gulp.src('./foo/*.js')
  .pipe(footer(banner, { pkg : pkg } ))
  .pipe(gulp.dest('./dist/')

//reading from a file for the text
var bannerText = fs.readFileSync('banner.js');

/*********************************************/
//If you want the text from a file...
var fs = require('fs');
var banner = fs.readFileSync('banner.txt');