Experimental fork of ng-annotate. Adds Angular 1.x DI annotations to ES5/ES6 code being processed by babel, with support for explicit annotations (/* @ngInject */) and implicit annotations of idiomatic Angular code.
Work in progress. Test thoroughly before using this in production. If stability is a priority, consider ng-annotate or babel-ng-annotate, which are both excellent alternatives to this plugin.
This plugin currently supports matching and transforming all of the patterns currently recognized by ng-annotate (explicit and implicit), and passes the relevant portions of ng-annotate's test suite. ES6 support will be expanded in future releases -- contributions are welcome!
See ng-annotate's documentation for more details.
Use like any other Babel plugin.
Most users will want to run
$ npm install babel-plugin-angularjs-annotate --save-devand add the plugin to your .babelrc file:
{
"presets": ["es2015"],
"plugins": ["path/to/babel-ng-annotate"]
}This project/experiment does not seek to replace ng-annotate. However, it does seek to provide similar functionality for Angular 1.x developers who are already using Babel and/or coding in ES6.
Because of some of the limitations presented by Babel's transformation process, this project does not aim to achieve feature parity, or provide identical output to ng-annotate. Notably, Babel does not preserve formatting and indentations like ng-annotate does, and this project does not seek to replicate the features of ng-annotate that remove or transform existing annotations.
Initially, I had hoped to make very few modifications to the upstream sources, in the hopes of eventually merging babel support directly into ng-annotate. Unfortunately, Babylon appears to have diverged too far from Acorn to make that goal realistic. (I would love to be wrong here, and would welcome contributions that close the gap between the two projects!)
That being said, this is my short-term todo list:
- ✓ Support the majority of invocations/annotations currently performed by ng-annotate
- ✓ Split up ng-annotate's test suite to be more granular and tolerant of some of babel's other transforms.
- ✓ Actually pass those tests.
- ✓ Pass tests in conjunction with the ES2015 preset. (almost)
- ✓ Cleanup. Remove vestigial functionality from the upstream project.
- Support a (very) limited set of ES6-friendly annotation patterns.
- ✓ Publish to npm, make a release, etc.
npm test
MIT, see LICENSE file.
This project is a fork of ng-annotate, which was written by Olov Lassus with the kind help by contributors. Follow @olov on Twitter for updates about ng-annotate.