Skip to content

Commit 48c5fdb

Browse files
committed
Update README.md
1 parent 029ebd7 commit 48c5fdb

File tree

1 file changed

+14
-15
lines changed

1 file changed

+14
-15
lines changed

README.md

Lines changed: 14 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -2,30 +2,29 @@
22

33
[![Circle CI](https://circleci.com/gh/schmod/bablel-plugin-angularjs-annotate.svg?style=svg)](https://circleci.com/gh/schmod/bablel-plugin-angularjs-annotate)
44

5-
Experimental fork of [ng-annotate](https://github.com/olov/ng-annotate).
5+
Experimental fork of [ng-annotate](https://github.com/olov/ng-annotate).
66

7-
Work in progress. **Do not use this for anything serious.** My code is a mess, and this does not
8-
cover the full set of cases supported by ng-annotate. Stick with [ng-annotate](https://github.com/olov/ng-annotate)
7+
Work in progress. **Do not use this for anything serious.** Stick with [ng-annotate](https://github.com/olov/ng-annotate)
98
or [babel-ng-annotate](https://github.com/mchmielarski/babel-plugin-ng-annotate) for now.
109

1110
## Goals & Tasks
1211

13-
This project/experiment does _not_ seek to replace ng-annotate. However, it does seek to provide the same
14-
function for Angular 1.x developers who are already using Babel and/or ES6 in their toolchain.
12+
This project/experiment does _not_ seek to replace ng-annotate. However, it does seek to provide similar
13+
functionality for Angular 1.x developers who are already using Babel and/or coding in ES6.
1514

16-
Because of some of the limitations presented by Babel's transformation process, this project does not seek to
17-
achieve feature, or provide 1:1 equivalent output with ng-annotate. Most notably, whitespace will not be
18-
preserved.
15+
Because of some of the limitations presented by Babel's transformation process, this project does not aim to
16+
achieve feature parity, or provide identical output to ng-annotate. Notably, Babel does not preserve formatting
17+
and indentations like ng-annotate does.
1918

2019
Initially, I had hoped to make very few modifications to the upstream sources, in the hopes of eventually
2120
merging babel support directly into ng-annotate. Unfortunately, Babylon appears to have diverged too
22-
far from Esprima to make that goal realistic. (I would love to be proven wrong here!)
21+
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!)
2322

2423
That being said, this is my short-term todo list:
2524

26-
✓ Support the majority of invocations/annotations currently performed by ng-annotate
27-
✓ Split up ng-annotate's test suite to be more granular and tolerant of some of babel's other transforms.
28-
✓ Actually pass those tests.
25+
* ✓ Support the majority of invocations/annotations currently performed by ng-annotate
26+
* ✓ Split up ng-annotate's test suite to be more granular and tolerant of some of babel's other transforms.
27+
* ✓ Actually pass those tests.
2928
* Pass tests in conjunction with the ES2015 preset.
3029
* Cleanup. Remove vestigial functionality from the upstream project.
3130
* Support a (very) limited set of ES6-friendly annotation patterns.
@@ -47,19 +46,19 @@ To test this mess of an experiment, create a .babelrc file for your sources
4746
And try it out:
4847

4948
```
50-
babel original.js
49+
babel myCode.js
5150
```
5251

5352
### To run tests:
5453

5554
```
56-
node tests/tests.js
55+
npm test
5756
```
5857

5958

6059
## License
6160
`MIT`, see [LICENSE](LICENSE) file.
6261

63-
This project is a fork of ng-annotate, which was written by [Olov Lassus](https://github.com/olov) with the kind help by
62+
This project is a fork of [ng-annotate](https://github.com/olov/ng-annotate), which was written by [Olov Lassus](https://github.com/olov) with the kind help by
6463
[contributors](https://github.com/olov/ng-annotate/graphs/contributors).
6564
[Follow @olov](https://twitter.com/olov) on Twitter for updates about ng-annotate.

0 commit comments

Comments
 (0)