Add, remove and rebuild AngularJS dependency injection annotations.
Add, remove and rebuild AngularJS dependency injection annotations. Based on ng-annotate.
This plugin requires Grunt.
If you haven't used Grunt before, be sure to check out the Getting Started guide, as it explains how to create a Gruntfile as well as install and use Grunt plugins. Once you're familiar with that process, you may install this plugin with this command:
npm install grunt-ng-annotate --save-dev
This project defines the
ngAnnotate task. In your project's Gruntfile, add a section named
ngAnnotate to the data object passed into
gruntinitConfigngAnnotate:options:// Task-specific options go here.your_target:// Target-specific file lists and/or options go here.
ngAnnotate task accepts a couple of options:
Tells if ngAnnotate should add annotations.
Tells if ngAnnotate should remove annotations.
Note that both
remove options can be set to true; in such a case
ngAnnotate first removes
annotations and then re-adds them (it can be used to check if annotations were provided correctly).
If provided, only strings matched by the regexp are interpreted as module names. You can provide both a regular expression and a string representing one. See README of ng-annotate for further details: https://npmjs.org/package/ng-annotate
Switches the quote type for strings in the annotations array to single ones; e.g.
'$scope' instead of
Concatenated files will be joined on this string.
Enables source map generation.
If set to a string, the string points to a file where to save the source map. If set to
true, an inline source map will be used.
If ngAnnotate supports a new option that is not directly supported via this Grunt task yet, you can pass it here. These options gets merged with the above specific to ngAnnotate. Options passed here have lower precedence to the direct ones described above.
gruntinitConfigngAnnotate:options:singleQuotes: trueapp1:files:'a.js': 'a.js''c.js': 'b.js''f.js': 'd.js' 'e.js'app2:files:expand: truesrc: 'f.js'ext: '.annotated.js' // Dest filepaths will have this extension.extDot: 'last' // Extensions in filenames begin after the last dotapp3:files:expand: truesrc: 'g.js'return src + '-annotated';;gruntloadNpmTasks'grunt-ng-annotate';
grunt ngAnnotate, you'll get file
a.js annotated and saved under the same name, file
annotated and saved as
c.js and files
e.js concatenated, annotated and saved as
will be saved using single quotes.
An annotated version of the
f.js file will be saved as
f.annotated.js and an annotated version of the
g.js file will be saved as
In lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code using Grunt.
Copyright (c) 2014 Michał Gołębiowski. Licensed under the MIT license.