Create VimlParser vital-module

[haya14busa]

Create vital-module interface of vimlparser.
See https://github.com/vim-jp/vital.vim for vital-module.

By introducing vital-module, users can use vimlparser as vital-module and we can mitigate the migration problem of breaking changes.

[tyru]

s:numtoname() is used by vimlparser#test()

[haya14busa]

Thanks. Done

[tyru]

These functions are really needed to be exported?

[tyru]

Do we need to split some objects into each module?

• VimlParser
• VimlParser.StringReader
• VimlParser.Compiler
• ...

[haya14busa]

I don't want to introduce changes caused by making vimlparser vital-module. Users are expected to use import() method only.

[haya14busa]

Do we need to split some objects into each module?

We need to translate vimlparser.vim to python and javascript, so we cannot do this easily.

[tyru]

We need to translate vimlparser.vim to python and javascript

ah, I forgot that. thanks.

[codecov]

Codecov Report

Merging #74 into master will increase coverage by 0.36%.
The diff coverage is n/a.

@@            Coverage Diff            @@
##           master     #74      +/-   ##
=========================================
+ Coverage   66.93%   67.3%   +0.36%     
=========================================
  Files           1       1              
  Lines        3590    3569      -21     
=========================================
- Hits         2403    2402       -1     
+ Misses       1187    1167      -20

Impacted Files	Coverage Δ
autoload/vital/__vimlparser__/VimLParser.vim	67.3% <ø> (ø)

---

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update ae76039...67cead6. Read the comment docs.

[haya14busa]

Test finally passed in travis CI! (Thanks to @thinca 👍)

It's ready to review and merge. Can you take a look at this p-r? @mattn @tyru

[tyru]

• Change to autoload/vital/__vimlparser__/VimlParser.vim ? or remove them?

vim-vimlparser/scripts/update_builtin_commands.vim

Line 132 in 8c63d1a

verbose echo 's:VimLParser.builtin_commands in autoload/vimlparser.vim is up-to-date.'

vim-vimlparser/scripts/update_builtin_commands.vim

Line 134 in 8c63d1a

verbose echo "Append following lines to s:VimLParser.builtin_commands in autoload/vimlparser.vim\n"

• is it confusing that module name is VimlParser, but class(object) name is VimLParser?

[haya14busa]

Thanks! Done.

[mattn]

Currently, VimLParser seems to export following functions. Is this your expected?

isalnum
Node
ExArg
islower
isnamec
iswordc1
isdigit
iswhite
import
isvarname
isalpha
Err
isnamec1
isargname
isupper
isxdigit
iswordc
isodigit
isidc

[haya14busa]

Yes, it's expected. I don't want to introduce changes caused by making it vital-module as much as possible.
Also, the changes will be translated into other languages too and i feel a bit weird to add _ prefix to all script local functions.

s:import() should be only public API. I'll add comment.

[haya14busa]

s:import() should be only public API. I'll add comment.

Done. 67cead6

[ujihisa]

Should the L24 below updated like this?

before:

let s:vimlparser = vimlparser#import()

after:

let s:V = vital#yourpluginname#new()
let s:vimlparser = s:V.import('VimLParser')

with vitalize

[tyru]

👍 for writing vital API instead of autoload API.

And your "after" code should be:

let s:vimlparser = vital#yourpluginname#import('VimLParser').import()

According to https://github.com/vim-jp/vim-vimlparser/pull/74/files#diff-ec29e185fa61087ecf991ff8811a8acaR6

[tyru]

In the first place, current example code is wrong...

-let r = s:StringReader.new(code)
-let p = s:VimLParser.new()
-let c = s:Compiler.new()
+let r = s:vimlparser.StringReader.new(code)
+let p = s:vimlparser.VimLParser.new()
+let c = s:vimlparser.Compiler.new()

[ujihisa]

🍣

[ujihisa]

Besides that I believe this LGTM 🍣 as a vim-jp org but I prefer listening to other core devs voices.