# gulp-ng-annotate

> Add angularjs dependency injection annotations with ng-annotate

Latest version **2.1.0** (published 2017-12-29) · CC0-1.0 license · 0 weekly downloads

## Install

```sh
npm install gulp-ng-annotate
pnpm add gulp-ng-annotate
yarn add gulp-ng-annotate
bun add gulp-ng-annotate
```

## Health

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

Positive: has types package; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.1.0 |
| Published | 2017-12-29 |
| First published | 2014-05-03 |
| Weekly downloads | 0 |
| License | CC0-1.0 |
| TypeScript types | separate (@types/gulp-ng-annotate) |
| Module format | CommonJS |
| Node | >=0.10.0 |
| Dependencies | 6 |
| Known vulnerabilities | 0 (+1 in 1 direct dependencies) |
| Install scripts | no |
| GitHub stars | 265 |
| Author | Kagami Hiiragi |
| Maintainers | kagami |
| Keywords | gulpplugin, angular, angularjs, annotate, ng-annotate |

## Links

- npm: https://www.npmjs.com/package/gulp-ng-annotate
- Repository: https://github.com/Kagami/gulp-ng-annotate
- Issues: https://github.com/Kagami/gulp-ng-annotate/issues
- npm.io page: https://npm.io/package/gulp-ng-annotate

## Dependencies (6)

- [merge](https://npm.io/package/merge.md) ^1.2.0
- [through2](https://npm.io/package/through2.md) ^2.0.1
- [ng-annotate](https://npm.io/package/ng-annotate.md) ^1.2.1
- [plugin-error](https://npm.io/package/plugin-error.md) ^0.1.2
- [bufferstreams](https://npm.io/package/bufferstreams.md) ^1.1.0
- [vinyl-sourcemaps-apply](https://npm.io/package/vinyl-sourcemaps-apply.md) ^0.2.1

## Recent versions

- 2.1.0 (latest) — 2017-12-29
- 2.0.0 — 2016-02-24
- 1.1.0 — 2015-07-27
- 1.0.0 — 2015-05-27
- 0.5.3 — 2015-05-03
- 0.5.2 — 2015-01-30
- 0.5.1 — 2015-01-30
- 0.5.0 — 2015-01-16
- 0.4.4 — 2015-01-15
- 0.4.3 — 2014-12-14
- 0.4.2 — 2014-12-08
- 0.4.1 — 2014-12-07
- 0.4.0 — 2014-11-30
- 0.3.6 — 2014-11-21
- 0.3.5 — 2014-11-12
- … 8 more at https://npm.io/package/gulp-ng-annotate/versions

## README

# [gulp](http://gulpjs.com)-ng-annotate [![Build Status](https://travis-ci.org/Kagami/gulp-ng-annotate.svg?branch=master)](https://travis-ci.org/Kagami/gulp-ng-annotate)

> Add angularjs dependency injection annotations with [ng-annotate](https://github.com/olov/ng-annotate)

## Install

```bash
$ npm install --save-dev gulp-ng-annotate
```

## Usage

```js
var gulp = require('gulp');
var ngAnnotate = require('gulp-ng-annotate');

gulp.task('default', function () {
	return gulp.src('src/app.js')
		.pipe(ngAnnotate())
		.pipe(gulp.dest('dist'));
});
```

## Options

You can pass any of the [ng-annotate options](https://github.com/olov/ng-annotate/blob/master/OPTIONS.md#library-api) as an object:
```js
{
	remove: true,
	add: true,
	single_quotes: true
}
```

`add: true` option is implied by default unless `remove` is set to true.

## FAQ

### I got an error `Error in plugin 'gulp-ng-annotate': error: couldn't process source due to parse error`

That's not a `gulp-ng-annotate` or `ng-annotate` error: you passed the invalid JavaScript code to the plugin. Check your source code near the specified place.

### I need the latest version of `ng-annotate`

Make sure you are using the latest version of `gulp-ng-annotate`. Also try to reinstall/update it to get the latest suitable version of `ng-annotate` from npm.

### I need a new annotating feature/annotations are incorrect

Report it to ng-annotate's [bugtracker](https://github.com/olov/ng-annotate/issues). `gulp-ng-annotate` is just a wrapper around `ng-annotate`.

## License

gulp-ng-annotate - Add angularjs dependency injection annotations with ng-annotate

Written in 2014-2015 by Kagami Hiiragi <kagami@genshiken.org> and gulp-ng-annotate contributors

To the extent possible under law, the author(s) have dedicated all copyright and related and neighboring rights to this software to the public domain worldwide. This software is distributed without any warranty.

You should have received a copy of the CC0 Public Domain Dedication along with this software. If not, see <http://creativecommons.org/publicdomain/zero/1.0/>.

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