| | 1 | # API Notation Syntax for Vim |
| | 2 | |
| | 3 | This is a syntax for api notation, a simple notation I've been using for |
| | 4 | annotating module APIs in specs and other documents. |
| | 5 | |
| | 6 | *Using Neovim? Try [tree-sitter-api-notation][new] instead* |
| | 7 | |
| | 8 | ## Installing |
| | 9 | |
| | 10 | Install with pathogen: |
| | 11 | |
| | 12 | 1. Clone the repo or copy the files to your `.vim/bundle` dir |
| | 13 | 2. Reload the vim |
| | 14 | 3. Enjoy the vim |
| | 15 | |
| | 16 | ## API Notation Reference |
| | 17 | |
| | 18 | The most recent reference as of now is in this [text file][api-reference], so |
| | 19 | check that to be sure. But here's a reproduction of the notation. |
| | 20 | |
| | 21 | ``` |
| | 22 | NameOfClass.WithPossibleNamespace |
| | 23 | + class property |
| | 24 | - instance property |
| | 25 | ~> listened events (socket) |
| | 26 | +> listened events (class/module) |
| | 27 | -> listened events (instance) |
| | 28 | <~ dispatched events (socket) |
| | 29 | <+ dispatched events(class/module) |
| | 30 | <- dispatched events (instance) |
| | 31 | :: class method |
| | 32 | # instance method |
| | 33 | |
| | 34 | Other symbols |
| | 35 | => returns |
| | 36 | ->() callback return |
| | 37 | [xx] optional |
| | 38 | <xx> data type |
| | 39 | |
| | 40 | Recommended order: class first, then sockets, then instance. Internally: |
| | 41 | Properties, events, methods. |
| | 42 | |
| | 43 | // Anything after two forward slashes is a comment |
| | 44 | ``` |
| | 45 | |
| | 46 | ## What does it look like? |
| | 47 | |
| | 48 | Like this. |
| | 49 | |
| | 50 | ![Like this.][api-example] |
| | 51 | |
| | 52 | [api-reference]: https://www.unlimited.pizza/api.html |
| | 53 | [api-example]: https://i.imgur.com/OreLcmE.png |
| | 54 | [new]: https://git.sr.ht/~rbdr/tree-sitter-api-notation |
git.r.bdr.sh / rbdr / api-notation.vim / blame_incremental