~rbdr/api-notation.vim

API Notation Syntax Highlight Plugin for vim
d328110b — Ruben Beltran del Rio 9 months ago
Bold warning
b59ef936 — Ruben Beltran del Rio 9 months ago
Update README
83cf70a7 — Ruben Beltran del Rio 9 months ago
Add throw matcher

refs

main
browse  log 

clone

read-only
https://git.sr.ht/~rbdr/api-notation.vim
read/write
git@git.sr.ht:~rbdr/api-notation.vim

You can also use your local clone with git send-email.

#API Notation Syntax for Vim

This is a syntax for api notation, a simple notation I've been using for annotating module APIs in specs and other documents.

Using Neovim? Try tree-sitter-api-notation instead

#Installing

Install with pathogen:

  1. Clone the repo or copy the files to your .vim/bundle dir
  2. Reload the vim
  3. Enjoy the vim

#API Notation Reference

The most recent reference as of now is in this text file, so check that to be sure. But here's a reproduction of the notation.

NameOfClass.WithPossibleNamespace
   + class property
   - instance property
  ~> listened events (socket)
  +> listened events (class/module)
  -> listened events (instance)
  <~ dispatched events (socket)
  <+ dispatched events(class/module)
  <- dispatched events (instance)
  :: class method
   # instance method

Other symbols
  => returns
->() callback return
[xx] optional
<xx> data type

Recommended order: class first, then sockets, then instance. Internally:
Properties, events, methods.

// Anything after two forward slashes is a comment

#What does it look like?

Like this.

Like this.