Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

gulp-banner

superRaytin1.9kMIT0.1.3

A gulp plugin to insert a comment (or other string) at the top of the file

gulp, banner, comment, gulp prepend, gulp plugin

readme

gulp-banner

A gulp plugin to insert a comment (or other string) at the top of the file.

Build Status NPM version Downloads

gulp-banner

Installation

npm install gulp gulp-banner --save-dev

Quick Start

var gulp = require('gulp');
var banner = require('gulp-banner');
var pkg = require('./package.json');

var comment = '/*\n' +
    ' * <%= pkg.name %> <%= pkg.version %>\n' +
    ' * <%= pkg.description %>\n' +
    ' * <%= pkg.homepage %>\n' +
    ' *\n' +
    ' * Copyright 2015, <%= pkg.author %>\n' +
    ' * Released under the <%= pkg.license %> license.\n' +
    '*/\n\n';

gulp.task('taskName', function() {
    gulp.src('path/to/example.js')
        .pipe(banner(comment, {
            pkg: pkg
        }))
        .pipe(gulp.dest('dist'));
});

Testing

npm test

License

MIT, see the LICENSE file for detail.