# gulp-banner

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

Latest version **0.1.3** (published 2015-12-26) · MIT license · 0 weekly downloads

## Install

```sh
npm install gulp-banner
pnpm add gulp-banner
yarn add gulp-banner
bun add gulp-banner
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.3 |
| Published | 2015-12-26 |
| First published | 2015-12-23 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 5 |
| Author | Leon Shi |
| Maintainers | superraytin |
| Keywords | gulp, banner, comment, gulp prepend, gulp plugin |

## Links

- npm: https://www.npmjs.com/package/gulp-banner
- Repository: https://github.com/superRaytin/gulp-banner
- Issues: https://github.com/superRaytin/gulp-banner/issues
- npm.io page: https://npm.io/package/gulp-banner

## Dependencies (3)

- [through2](https://npm.io/package/through2.md) ~2.0.0
- [gulp-util](https://npm.io/package/gulp-util.md) ~3.0.7
- [underscore.template](https://npm.io/package/underscore.template.md) ~0.1.2

## Recent versions

- 0.1.3 (latest) — 2015-12-26
- 0.1.2 — 2015-12-24
- 0.1.1 — 2015-12-23
- 0.1.0 — 2015-12-23

## README

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

[![Build Status](https://travis-ci.org/superRaytin/gulp-banner.svg?branch=master)](https://travis-ci.org/superRaytin/gulp-banner)
[![NPM version][npm-image]][npm-url]
[![Downloads][downloads-image]][npm-url]

[![gulp-banner](https://nodei.co/npm/gulp-banner.png)](https://npmjs.org/package/gulp-banner)

[npm-url]: https://npmjs.org/package/gulp-banner
[downloads-image]: http://img.shields.io/npm/dm/gulp-banner.svg
[npm-image]: http://img.shields.io/npm/v/gulp-banner.svg

# Installation

```
npm install gulp gulp-banner --save-dev
```

# Quick Start

```js
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](/LICENSE) file for detail.

---
_Source: https://npm.io/package/gulp-banner · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._