feat(slang_server): add slang_server support

Author: NicolasDerumigny

ale_linters/verilog/slang_server.vim

@@ -0,0 +1,37 @@
+" Author: Nicolas Derumigny <https://github.com/nicolasderumigny>
+" Description: Slang-server LSP for verilog
+
+call ale#Set('verilog_slang_server_options', '')
+call ale#Set('verilog_slang_server_executable', 'slang-server')
+call ale#Set('verilog_slang_server_config', {})
+
+function! ale_linters#verilog#slang_server#GetProjectRoot(buffer) abort
+    let l:project_file = ale#path#FindNearestFile(a:buffer, 'filelist.f')
+
+    if !empty(l:project_file)
+        return fnamemodify(l:project_file, ':p:h')
+    else
+        return fnamemodify('', ':h')
+    endif
+endfunction
+
+function! ale_linters#verilog#slang_server#GetCommand(buffer) abort
+    let l:command = ale#Escape(ale#Var(a:buffer, 'verilog_slang_server_executable'))
+    let l:options = ale#Var(a:buffer, 'verilog_slang_server_options')
+
+    if l:options isnot# ''
+        let l:command .= ' ' . l:options
+    endif
+
+    return l:command
+endfunction
+
+
+call ale#linter#Define('verilog', {
+\   'name': 'slang_server',
+\   'lsp': 'stdio',
+\   'lsp_config': {b -> ale#Var(b, 'verilog_slang_server_config')},
+\   'executable': {b -> ale#Var(b, 'verilog_slang_server_executable')},
+\   'command': function('ale_linters#verilog#slang_server#GetCommand') ,
+\   'project_root': function('ale_linters#verilog#slang_server#GetProjectRoot'),
+\})

doc/ale-verilog.txt

@@ -14,6 +14,9 @@ ALE can use eight different linters for Verilog HDL:
   slang:
     Using `slang -Weverything`
 
+  slang_server:
+    Using `slang-server`
+
   verible_ls
     Using `verible-verilog-ls`
 
@@ -89,6 +92,39 @@ g:ale_verilog_slang_options
 
   This variable can be changed to modify 'slang' command arguments.
 
+===============================================================================
+slang_server                                         *ale-verilog-slang-server*
+
+                                   *ale-config.verilog_slang_server_executable*
+                                        *g:ale_verilog_slang_server_executable*
+                                        *b:ale_verilog_slang_server_executable*
+verilog_slang_server_executable
+g:ale_verilog_slang_server_executable
+  Type: |String|
+  Default: `'slang-server'`
+
+  This variable can be modifies to change the executable path for `slang_server`
+
+                                       *ale-config.verilog_slang_server_config*
+                                            *g:ale_verilog_slang_server_config*
+                                            *b:ale_verilog_slang_server_config*
+verilog_slang_server_config
+g:ale_verilog_slang_server_config
+  Type: |Dictionary|
+  Default: `{}`
+
+  Dictionary with configuration settings for `slang_server`
+
+                                      *ale-config.verilog_slang_server_options*
+                                           *g:ale_verilog_slang_server_options*
+                                           *b:ale_verilog_slang_server_options*
+verilog_slang_server_options
+g:ale_verilog_slang_server_options
+  Type: |String|
+  Default: `''`
+
+  Additional flags for `slang_server`
+
 ===============================================================================
 verible_ls                                             *ale-verilog-verible-ls*
 

doc/ale.txt

@@ -4046,6 +4046,7 @@ documented in additional help files.
     hdl-checker...........................|ale-verilog-hdl-checker|
     iverilog..............................|ale-verilog-iverilog|
     slang.................................|ale-verilog-slang|
+    slang_server..........................|ale-verilog-slang-server|
     verible_ls............................|ale-verilog-verible-ls|
     verible_format........................|ale-verilog-verible-format|
     verilator.............................|ale-verilog-verilator|

test/linter/test_verilog_slang_server.vader

@@ -0,0 +1,28 @@
+Before:
+  call ale#assert#SetUpLinterTest('verilog', 'slang_server')
+
+After:
+  call ale#assert#TearDownLinterTest()
+
+Execute(The default executable path and arguments should be correct):
+  AssertLinter 'slang-server', ale#Escape('slang-server')
+
+Execute(The project root should be detected correctly in empty directory):
+  AssertLSPProject '.'
+
+Execute(The project root should be detected correctly with filelist.f):
+  call ale#test#SetFilename('../test-files/verilog/slang_server/module.sv')
+  AssertLSPProject ale#path#Simplify(g:dir . '/../test-files/verilog/slang_server')
+
+Execute(The LSP values should be set correctly):
+  call ale#test#SetFilename('../test-files/verilog/slang_server/module.sv')
+
+  AssertLSPLanguage 'verilog'
+  AssertLSPOptions {}
+  AssertLSPConfig {}
+  AssertLSPProject ale#path#Simplify(g:dir . '/../test-files/verilog/slang_server')
+
+
+Execute(The verible LSP callback should allow custom options):
+  let g:ale_verilog_slang_server_options = '--foo --bar'
+  AssertLinter 'slang-server', ale#Escape('slang-server') . ' --foo --bar'

test/test-files/verilog/slang_server/filelist.f

@@ -0,0 +1 @@
+./module.sv

test/test-files/verilog/slang_server/module.sv

@@ -119,7 +119,7 @@ Execute(The defaults for the zsh filetype should be correct):
 Execute(The defaults for the verilog filetype should be correct):
   " This filetype isn't configured with default, so we can test loading all
   " available linters with this.
-  AssertEqual ['hdl_checker', 'iverilog', 'slang', 'verible_ls', 'verilator', 'vlog', 'xvlog', 'yosys'], GetLinterNames('verilog')
+  AssertEqual ['hdl_checker', 'iverilog', 'slang', 'slang_server', 'verible_ls', 'verilator', 'vlog', 'xvlog', 'yosys'], GetLinterNames('verilog')
 
   let g:ale_linters_explicit = 1