Replace babel-plugin-angularjs-annotate with babel-plugin-inject-args #2700
Conversation
It is confusing to have a Babel plugin with an Angular-related name and Angular-sounding annotations (`@ngInject`) in the code, even though we're not using AngularJS. Although we're not using AngularJS any more, we still have services that are instantiated by a dependency injection container. The container reads dependency names from a `$inject` property on service functions/classes. This `$inject` property is added by `babel-plugin-angularjs-annotate`. This commit replaces the `angularjs-annotate` Babel plugin with one maintained by us [1]. The new plugin provides only the functionality that we need (eg. only processes explicitly annotated functions) and uses a more generic `@inject` annotation. [1] https://github.com/hypothesis/babel-plugin-inject-args
Codecov Report
@@ Coverage Diff @@
## master #2700 +/- ##
=======================================
Coverage 97.73% 97.73%
=======================================
Files 200 200
Lines 7497 7497
Branches 1647 1647
=======================================
Hits 7327 7327
Misses 170 170
Continue to review full report at Codecov.
|
There was a problem hiding this comment.
Cool. I can build this and it works.
My only feedback is that@inject, while totally accurate and appropriate, is not particularly unique. For example, as a dev, I could see myself being like "what magic does this perform" and trying to google for inject in the code/dependencies. If it had a more specific, albeit cumbersome, name, like @babel-inject, it might be easier to track back the magic to its source. I know you've already had a naming runaround, though...
That's a fair point. |
It is confusing to have a Babel plugin with an Angular-related name and
Angular-sounding annotations (
@ngInject) in the code, even thoughwe're not using AngularJS. Although we're not using AngularJS any more,
we still have services that are instantiated by a dependency injection
container. The container reads dependency names from a
$injectproperty on service functions/classes. This
$injectproperty is addedby
babel-plugin-angularjs-annotate.This commit replaces the
angularjs-annotateBabel plugin with onemaintained by us [1]. The new plugin provides only the functionality that we
need (eg. only processes explicitly annotated functions) and uses a more generic
@injectannotation.[1] https://github.com/hypothesis/babel-plugin-inject-args