grunt-ng-annotate-analyze
Grunt plugin to identify non annotated components
Getting Started
This plugin requires Grunt ~0.4.5
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-analyze --save-dev
Once the plugin has been installed, it may be enabled inside your Gruntfile with this line of JavaScript:
grunt;
The "ng_annotate_analyze" task
Overview
In your project's Gruntfile, add a section named ng_annotate_analyze
to the data object passed into grunt.initConfig()
.
grunt;
Options
options.fail
Type: Boolean
Default value: false
A boolean value that is used to identify if task should fail with warn message in case if any annotation adding required.
options.dest
Type: String
Default value: result.html
A string value that is used to identify where report should b stored.
options.short
Type: Boolean
Default value: false
A boolean value that is used to identify if short report should be generated (only with lines of code that were modified).
Also you can add native ng-annotation options
Usage Examples
Base configuration
grunt;
Contributing
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 and ESLint.
Release History
(Nothing yet)