Adapt plugin to 1.1.0 related analysis logic

Author: ryyppy

CHANGELOG.md

@@ -2,6 +2,34 @@
 
 ## master
 
+**Improvements:**
+
+- Add support for the new `rescript` npm package. This version will handle both, `bs-platform` and `rescript` projects.
+  - Tip: Running `:RescriptInfo` will show you if the plugin is running in `legacy` (`bsc.exe` / `bsb.exe`) or `modern` (`rescript.exe`) mode
+- Updated vendored rescript-vscode to `1.1.0` (see changes [here](https://github.com/rescript-lang/rescript-vscode/blob/master/CHANGELOG.md#110))
+
+**Breaking Changes:**
+
+We slimmed down our vendored LSP code and changed the binary paths. Within your `CocConfig`, change your server path accordingly:
+
+```diff
+"languageserver": {
+  "rescript": {
+    "enable": true,
+-   "module": "~/.config/nvim/plugged/vim-rescript/rescript-vscode/extension/server/out/server.js",
++   "module": "~/.config/nvim/plugged/vim-rescript/server/out/server.js",
+    "args": ["--node-ipc"],
+    "filetypes": ["rescript"],
+    "rootPatterns": ["bsconfig.json"]
+  }
+}
+```
+
+We also renamed the following plugin commands:
+
+- `:RescriptBuildWorld` to `:RescriptBuildWithDeps`
+- `:RescriptCleanWorld` to `:RescriptBuildWithDeps`
+
 ## 1.4.0
 
 **Improvements:**

README.md

@@ -69,7 +69,7 @@ After the installation, open your coc config (`:CocConfig`) and add the followin
 "languageserver": {
   "rescript": {
     "enable": true,
-    "module": "~/.config/nvim/plugged/vim-rescript/rescript-vscode/extension/server/out/server.js",
+    "module": "~/.config/nvim/plugged/vim-rescript/server/out/server.js",
     "args": ["--node-ipc"],
     "filetypes": ["rescript"],
     "rootPatterns": ["bsconfig.json"]

autoload/rescript.vim

@@ -28,18 +28,22 @@ function! rescript#UpdateProjectEnv()
   " Looks for the nearest node_modules directory
   let l:res_bin_dir = finddir('node_modules/rescript/', ".;") . s:rescript_arch
 
+  " If 1, we are running with the old bsb / bsc binaries
+  let g:rescript_legacy_mode = 0
+
   if l:res_bin_dir == s:rescript_arch
     " look for bs-platform if rescript node module not found
     let l:res_bin_dir = finddir('node_modules/bs-platform/', ".;") . s:rescript_arch
+    let g:rescript_legacy_mode = 1
+  else
+    " Here we are handling a project that is based on the rescript npm package
+    " This package only uses a rescript.exe, no bsc, nor bsb
+    let g:rescript_exe = getcwd() . "/" . l:res_bin_dir . "/rescript.exe"
   endif
 
-  "if !exists("g:rescript_compile_exe")
+  " These variables are only used in legacy mode (bs-platform based projects)
   let g:rescript_compile_exe = getcwd() . "/" . l:res_bin_dir . "/bsc.exe"
-  "endif
-
-  "if !exists("g:rescript_build_exe")
   let g:rescript_build_exe = getcwd() . "/" . l:res_bin_dir . "/bsb.exe"
-  "endif
 
   " Note that this doesn't find bsconfig when the editor was started without a
   " specific file within the project
@@ -71,8 +75,8 @@ function! rescript#Init()
   let s:got_format_err = 0
   let s:got_build_err = 0
 
-  if !exists("g:rescript_editor_support_exe")
-    let g:rescript_editor_support_exe = s:rescript_plugin_dir . "/rescript-vscode/extension/server/" . s:rescript_arch . "/rescript-editor-support.exe"
+  if !exists("g:rescript_analysis_exe")
+    let g:rescript_analysis_exe = s:rescript_plugin_dir . "/server/analysis_binaries/" . s:rescript_arch . "-run.exe"
   endif
 
   call rescript#UpdateProjectEnv()
@@ -83,7 +87,7 @@ function! s:DeleteLines(start, end) abort
 endfunction
 
 function! rescript#GetRescriptVscodeVersion()
-  let l:out = readfile(s:rescript_plugin_dir . "/rescript-vscode/extension/package.json")
+  let l:out = readfile(s:rescript_plugin_dir . "/server/package.json")
 
   try
     let l:json = json_decode(l:out)
@@ -197,7 +201,10 @@ function! rescript#TypeHint()
     write
   endif
 
-  let l:command = g:rescript_editor_support_exe . " dump " . @%
+  let c_line = line(".")
+  let c_col = col(".")  
+
+  let l:command = g:rescript_analysis_exe . " hover " . @% . " " . (c_line - 1) . " " . (c_col - 1)
 
   let out = system(l:command)
 
@@ -210,57 +217,37 @@ function! rescript#TypeHint()
   try
     let l:json = json_decode(out)
   catch /.*/
-    echo "No type info due to build error"
+    echo "No type info (couldn't decode analysis result)"
     return
   endtry
 
-  let c_line = line(".")
-  let c_col = col(".")  
+  let l:match = l:json
 
-  for item in l:json
-    let start_line = item.range.start.line + 1
-    let end_line = item.range.end.line + 1
-    let start_col = item.range.start.character + 1
-    let end_col = item.range.end.character
-
-    if c_line >= start_line && c_line <= end_line
-      if c_col >= start_col && c_col <= end_col
-        let l:match = item
-        break
-      endif
-    endif
-  endfor
-
-  if exists("l:match")
-    " In case our hover involves a reference, resolve that first
-    let l:matches = matchlist(get(l:match, "hover", ""), '#\(\d\+\)')
-    if len(l:matches) > 0
-      let l:index = l:matches[1]
-      let l:match = get(l:json, l:index)
-    endif
-
-    if get(l:match, "hover", "") != ""
-      let md_content = l:match.hover
+  if get(l:match, "contents", "") != ""
+    let md_content = l:match.contents
 
-      let text = split(md_content, "\n")
-      let lines = extend(["Pos (l:c): " . c_line . ":" . c_col], text)
+    let text = split(md_content, "\n")
+    let lines = extend(["Pos (l:c): " . c_line . ":" . c_col], text)
 
-      call s:ShowInPreview("type-preview", "markdown", lines)
+    call s:ShowInPreview("type-preview", "markdown", lines)
 
-      " calculate pos for matchadd
-      let start_line = item.range.start.line + 1
-      let end_line = item.range.end.line + 1
-      let start_col = item.range.start.character + 1
-      let end_col = item.range.end.character
+    "TODO: Add back the highlighting at some point
+    "----
+    " calculate pos for matchadd
+    "let start_line = item.range.start.line + 1
+    "
+    "let end_line = item.range.end.line + 1
+    "let start_col = item.range.start.character + 1
+    "let end_col = item.range.end.character
 
-      let startPos = [start_line, start_col, end_col - start_col]
-      let endPos = [end_line, end_col]
+    "let startPos = [start_line, start_col, end_col - start_col]
+    "let endPos = [end_line, end_col]
 
-      let pos = [startPos, endPos]
+    "let pos = [startPos, endPos]
 
-      call rescript#highlight#HighlightWord(pos)
-      return
-    endif
+    "call rescript#highlight#HighlightWord(pos)
+    "------
+    return
   endif
   echo "No type info"
 endfunction
@@ -274,65 +261,53 @@ function! rescript#JumpToDefinition()
     write
   endif
 
-  let l:command = g:rescript_editor_support_exe . " dump " . @%
+  let c_line = line(".")
+  let c_col = col(".")  
+
+  let l:command = g:rescript_analysis_exe . " definition " . @% . " " . (c_line - 1) . " " . (c_col - 1)
 
   let out = system(l:command)
 
   if v:shell_error != 0
-    echohl Error | echomsg "Type Info failed with exit code '" . v:shell_error . "'" | echohl None
+    echohl Error | echomsg "Analysis binary failed with exit code '" . v:shell_error . "'" | echohl None
     return
   endif
 
   let l:json = []
   try
     let l:json = json_decode(out)
   catch /.*/
-    echo "No type info due to build error"
+    echo "No definition available (couldn't decode analysis result)"
     return
   endtry
 
   let c_line = line(".")
   let c_col = col(".")
 
-  for item in l:json
-    let start_line = item.range.start.line + 1
-    let end_line = item.range.end.line + 1
-    let start_col = item.range.start.character + 1
-    let end_col = item.range.end.character
-
-    if c_line >= start_line && c_line <= end_line
-      if c_col >= start_col && c_col <= end_col
-        let l:match = item
-        break
-      endif
-    endif
-  endfor
-
-  if exists("l:match")
-    if has_key(l:match, "definition")
-      let l:def = l:match.definition
-
-      if has_key(l:def, "uri")
-        execute ":e " . l:def.uri
-      endif
+  " Prevents errors when v:null was returned
+  if type(l:json) == v:t_dict 
+    let l:def = l:json
 
-      let start_line = l:def.range.start.line + 1
-      let start_col = l:def.range.start.character + 1
-      let end_line = l:def.range.end.line + 1
-      let end_col = l:def.range.end.character
-      call cursor(start_line, start_col)
+    if has_key(l:def, "uri")
+      execute ":e " . l:def.uri
+    endif
 
-      let startPos = [start_line, start_col, end_col - start_col]
-      let endPos = [end_line, end_col]
-      let pos = [startPos, endPos]
+    let start_line = l:def.range.start.line + 1
+    let start_col = l:def.range.start.character + 1
+    let end_line = l:def.range.end.line + 1
+    let end_col = l:def.range.end.character
+    call cursor(start_line, start_col)
 
-      " If pos doesn't point to start: 0,0 and end: 0,0
-      if pos != [[1, 1, -1], [1, 0]]
-        call rescript#highlight#HighlightWord(pos)
-      endif
+    let startPos = [start_line, start_col, end_col - start_col]
+    let endPos = [end_line, end_col]
+    let pos = [startPos, endPos]
 
-      return
+    " If pos doesn't point to start: 0,0 and end: 0,0
+    if pos != [[1, 1, -1], [1, 0]]
+      call rescript#highlight#HighlightWord(pos)
     endif
+
+    return
   endif
   echo "No definition found"
 endfunction
@@ -367,7 +342,7 @@ function! rescript#Complete(findstart, base)
   let l:tmpname = tempname() . "." . l:ext
   call writefile(getline(1, '$'), l:tmpname)
 
-  let l:command = g:rescript_editor_support_exe . " complete " . @% . ":" . ( c_line - 1) . ":" . (c_col - 1) . " " . l:tmpname
+  let l:command = g:rescript_analysis_exe . " complete " . @% . " " . ( c_line - 1) . " " . (c_col - 1) . " " . l:tmpname
 
   let out = system(l:command)
 
@@ -399,12 +374,60 @@ function! rescript#Complete(findstart, base)
   return l:ret
 endfunction
 
-function! rescript#BuildProject(...)
+" with_deps: bool ... if 1, clean deps as well
+function! rescript#Clean(...)
+  let l:with_deps = get(a:, 0, 0)
+
+  if g:rescript_legacy_mode ==? 1
+    if l:with_deps ==? 1
+      " bsb -clean-world
+      let l:cmd = g:rescript_build_exe . " -clean-world"
+    else
+      " bsb -clean
+      let l:cmd = g:rescript_build_exe . " -clean"
+    endif
+  else
+    if l:with_deps ==? 1
+      " rescript clean -with-deps
+      let l:cmd = g:rescript_exe . " clean -with-deps"
+    else
+      " rescript clean
+      let l:cmd = g:rescript_exe . " clean"
+    endif
+  endif
+
+  exe "lcd " . g:rescript_project_root
+  let out = system(l:cmd)
+  exe "lcd -"
+
+  if v:shell_error ==? 0
+    echo "Cleaning successful"
+  else
+    echo out
+  endif
+
+  return v:shell_error
+endfunction
+
+" with_deps: bool ... if 1, clean deps as well
+function! rescript#Build(...)
+  let with_deps = get(a:, 0, 0)
+
   call rescript#UpdateProjectEnv()
 
-  let l:cmd = g:rescript_build_exe
-  if a:0 ==? 1
-    let l:cmd = g:rescript_build_exe . " " . a:1
+  " If in legacy mode, run bsb
+  if g:rescript_legacy_mode ==? 1
+    let l:cmd = g:rescript_build_exe
+    if l:with_deps ==? 1
+      " bsb -make-world
+      let l:cmd = g:rescript_build_exe . " -make-world"
+    endif
+  else
+    " Otherwise we are in modern mode and use rescript.exe
+    let l:cmd = g:rescript_exe
+    if l:with_deps ==? 1
+      let l:cmd = g:rescript_exe . " -with-deps"
+    endif
   endif
 
   exe "lcd " . g:rescript_project_root
@@ -508,10 +531,23 @@ function! rescript#Info()
   let l:version = "ReScript version: " . rescript#DetectVersion()
 
   echo l:version
+
+  if g:rescript_legacy_mode ==? 1
+    echo "Editor mode: legacy (using bsc / bsb instead of rescript)"
+  else
+    echo "Editor mode: modern (using rescript.exe instead of bsc / bsb)"
+  endif
+
   echo "Detected Config File: " . g:rescript_project_config
   echo "Detected Project Root: " . g:rescript_project_root
-  echo "Detected rescript_editor_support_exe: " . g:rescript_editor_support_exe
-  echo "Detected rescript_compile_exe: " . g:rescript_compile_exe
-  echo "Detected rescript_build_exe: " . g:rescript_build_exe
+  echo "Detected rescript_analysis_exe: " . g:rescript_analysis_exe
+
+  if g:rescript_legacy_mode ==? 1
+    echo "Detected rescript_compile_exe: " . g:rescript_compile_exe
+    echo "Detected rescript_build_exe: " . g:rescript_build_exe
+  else
+    echo "Detected rescript_exe: " . g:rescript_exe
+  endif
+
   echo "Bundled rescript-vscode extension: " . rescript#GetRescriptVscodeVersion()
 endfunction

autoload/rescript/parsing.vim

@@ -1,7 +1,5 @@
-" Links to the reference implementation:
-" - https://github.com/rescript-lang/rescript-vscode/blob/master/server/src/utils.ts
-" - https://github.com/rescript-lang/rescript-vscode/blob/master/CONTRIBUTING.md
-"
+" Link to the reference implementation:
+" https://github.com/rescript-lang/rescript-vscode/blob/0dbf2eb9cdb0bd6d95be1aee88b73830feecb5cc/server/src/utils.ts#L129-L329
 
 
 " Parses all syntax errors from the output of the ReScript compiler /