Merge pull request #2045 from jparise/elixir-ls-umbrella

elixir-ls now recognizes umbrella projects

ale_linters/elixir/elixir_ls.vim

@@ -16,6 +16,6 @@ call ale#linter#Define('elixir', {
 \   'lsp': 'stdio',
 \   'executable_callback': 'ale_linters#elixir#elixir_ls#GetExecutable',
 \   'command_callback': 'ale_linters#elixir#elixir_ls#GetExecutable',
-\   'project_root_callback': 'ale#handlers#elixir#FindMixProjectRoot',
+\   'project_root_callback': 'ale#handlers#elixir#FindMixUmbrellaRoot',
 \   'lsp_config_callback': ale#VarFunc('elixir_elixir_ls_config'),
 \})

autoload/ale/handlers/elixir.vim

@@ -1,13 +1,28 @@
 " Author: Matteo Centenaro (bugant) - https://github.com/bugant
-"
+" Author: Jon Parise <jon@indelible.org>
-" Description: find the root directory for an elixir project that uses mix
+" Description: Functions for working with Elixir projects
 
+" Find the root directory for an elixir project that uses mix.
 function! ale#handlers#elixir#FindMixProjectRoot(buffer) abort
     let l:mix_file = ale#path#FindNearestFile(a:buffer, 'mix.exs')
 
     if !empty(l:mix_file)
-      return fnamemodify(l:mix_file, ':p:h')
+        return fnamemodify(l:mix_file, ':p:h')
     endif
 
     return '.'
 endfunction
+
+" Similar to ale#handlers#elixir#FindMixProjectRoot but also continue the
+" search upward for a potential umbrella project root. If an umbrella root
+" does not exist, the initial project root will be returned.
+function! ale#handlers#elixir#FindMixUmbrellaRoot(buffer) abort
+    let l:app_root = ale#handlers#elixir#FindMixProjectRoot(a:buffer)
+    let l:umbrella_root = fnamemodify(l:app_root, ':h:h')
+
+    if filereadable(l:umbrella_root . '/mix.exs')
+        return l:umbrella_root
+    endif
+
+    return l:app_root
+endfunction

test/command_callback/test_elixir_ls_command_callbacks.vader

@@ -22,12 +22,12 @@ Execute(should configure elixir-ls release location):
   AssertLinter 'boo/language_server.sh', 'boo/language_server.sh'
 
 Execute(should set correct LSP values):
-  call ale#test#SetFilename('mix_paths/wrapped_project/lib/app.ex')
+  call ale#test#SetFilename('elixir_paths/umbrella_project/apps/app1/lib/app.ex')
 
   AssertLSPLanguage 'elixir'
   AssertLSPOptions {}
   AssertLSPConfig {}
-  AssertLSPProject ale#path#Simplify(g:dir . '/mix_paths/wrapped_project')
+  AssertLSPProject ale#path#Simplify(g:dir . '/elixir_paths/umbrella_project')
 
 Execute(should accept configuration settings):
   AssertLSPConfig {}

test/command_callback/test_elixir_mix_command_callbacks.vader

@@ -18,9 +18,16 @@ Execute(The default mix command should be correct):
   \ . g:env_prefix
   \ . 'mix compile %s'
 
-Execute(The FindMixProjectRoot should detect the project root directory via mix.exs):                                                  
+Execute(FindMixProjectRoot should detect the project root directory via mix.exs):
-  silent execute 'file ' . fnameescape(g:dir . '/elixir_paths/mix_project/lib/app.ex')                                               
+  silent execute 'file ' . fnameescape(g:dir . '/elixir_paths/mix_project/lib/app.ex')
 
-  AssertEqual                                                                  
+  AssertEqual
-  \ ale#path#Simplify(g:dir . '/elixir_paths/mix_project'),     
+  \ ale#path#Simplify(g:dir . '/elixir_paths/mix_project'),
   \ ale#handlers#elixir#FindMixProjectRoot(bufnr(''))
+
+Execute(FindMixUmbrellaRoot should detect the umbrella root directory via mix.exs):
+  silent execute 'file ' . fnameescape(g:dir . '/elixir_paths/umbrella_project/apps/app1/lib/app.ex')
+
+  AssertEqual
+  \ ale#path#Simplify(g:dir . '/elixir_paths/umbrella_project'),
+  \ ale#handlers#elixir#FindMixUmbrellaRoot(bufnr(''))