diff --git a/ale_linters/toml/tombi.vim b/ale_linters/toml/tombi.vim index dd8437dace..132ac0e61c 100644 --- a/ale_linters/toml/tombi.vim +++ b/ale_linters/toml/tombi.vim @@ -32,11 +32,11 @@ function! ale_linters#toml#tombi#GetProjectRoot(buffer) abort return fnamemodify(l:pyproject_file . '/', ':p:h:h') endif - " Try to find nearest `git` directory - let l:gitdir = ale#path#FindNearestFile(a:buffer, '.git') + " Try to find the nearest VCS root. + let l:vcs_root = ale#path#FindVCSRoot(a:buffer) - if !empty(l:gitdir) - return fnamemodify(l:gitdir . '/', ':p:h:h') + if !empty(l:vcs_root) + return l:vcs_root endif return '' diff --git a/autoload/ale/path.vim b/autoload/ale/path.vim index e047f65f07..a3de6d5321 100644 --- a/autoload/ale/path.vim +++ b/autoload/ale/path.vim @@ -3,6 +3,12 @@ let s:is_windows = has('win32') || has('win64') || has('win32unix') +let s:vcs_root_marker_map = { +\ 'git': {'directories': ['.git'], 'files': ['.git']}, +\ 'got': {'directories': ['.got']}, +\ 'hg': {'directories': ['.hg']}, +\} + " simplify a path, and fix annoying issues with paths on Windows. " " Forward slashes are changed to back slashes so path equality works better @@ -94,6 +100,44 @@ function! ale#path#FindNearestFileOrDirectory(buffer, filename) abort return '' endfunction +function! s:NearestVCSRoot(nearest_root, marker_path) abort + if empty(a:marker_path) + return a:nearest_root + endif + + let l:root = ale#path#Simplify(ale#path#Dirname(a:marker_path)) + + return empty(a:nearest_root) || strlen(l:root) > strlen(a:nearest_root) + \ ? l:root + \ : a:nearest_root +endfunction + +" Given a buffer, find the nearest root directory for selected version control +" systems by searching for VCS marker files and directories. +function! ale#path#FindVCSRoot(buffer) abort + let l:nearest_root = '' + + for l:vcs in ale#Var(a:buffer, 'vcs_root') + let l:config = get(s:vcs_root_marker_map, l:vcs, {}) + + for l:directory in get(l:config, 'directories', []) + let l:nearest_root = s:NearestVCSRoot( + \ l:nearest_root, + \ ale#path#FindNearestDirectory(a:buffer, l:directory) + \) + endfor + + for l:file in get(l:config, 'files', []) + let l:nearest_root = s:NearestVCSRoot( + \ l:nearest_root, + \ ale#path#FindNearestFile(a:buffer, l:file) + \) + endfor + endfor + + return l:nearest_root +endfunction + " Given a buffer, a string to search for, and a global fallback for when " the search fails, look for a file in parent paths, and if that fails, " use the global fallback path instead. diff --git a/doc/ale.txt b/doc/ale.txt index 638d9b5b5e..1fa69dad8b 100644 --- a/doc/ale.txt +++ b/doc/ale.txt @@ -2355,6 +2355,17 @@ g:ale_root detect a project root. If this, too, yields no result, and the linter is an LSP linter, it will not run. + *ale-options.vcs_root* + *g:ale_vcs_root* + *b:ale_vcs_root* +vcs_root +g:ale_vcs_root + Type: |List| + Default: `['git', 'got', 'hg']` + + This option configures which version control systems ALE will check when + looking for project roots. Supported values are `'git'`, `'got'`, and `'hg'`. + *ale-options.save_hidden* *g:ale_save_hidden* save_hidden diff --git a/plugin/ale.vim b/plugin/ale.vim index ba702956d3..509e86f262 100644 --- a/plugin/ale.vim +++ b/plugin/ale.vim @@ -111,6 +111,13 @@ let g:ale_filename_mappings = get(g:, 'ale_filename_mappings', {}) " This Dictionary configures the default project roots for various linters. let g:ale_root = get(g:, 'ale_root', {}) +" A List of VCS root markers to use for project root detection. +let g:ale_vcs_root = get(g:, 'ale_vcs_root', [ +\ 'git', +\ 'got', +\ 'hg', +\]) + " These flags dictates if ale uses the quickfix or the loclist (loclist is the " default, quickfix overrides loclist). let g:ale_set_loclist = get(g:, 'ale_set_loclist', v:true) diff --git a/test/linter/test_toml_tombi.vader b/test/linter/test_toml_tombi.vader index 8d23efb65f..9311651f0d 100644 --- a/test/linter/test_toml_tombi.vader +++ b/test/linter/test_toml_tombi.vader @@ -2,7 +2,13 @@ Before: Save g:ale_toml_tombi_online call ale#assert#SetUpLinterTest('toml', 'tombi') + let g:tombi_vcs_root_temp_dir = ale#path#Simplify(tempname()) + call mkdir(g:tombi_vcs_root_temp_dir, 'p') + After: + call delete(g:tombi_vcs_root_temp_dir, 'rf') + unlet! g:tombi_vcs_root_temp_dir + call ale#assert#TearDownLinterTest() Execute(The default executable path should be correct): @@ -22,3 +28,11 @@ Execute(The project root should be detected correctly in Python projects): call ale#test#SetFilename('../test-files/toml/tombi/pyprojecttoml/subdir/file.ext') AssertLSPProject ale#path#Simplify(g:dir . '/../test-files/toml/tombi/pyprojecttoml') + +Execute(The project root should be detected correctly with a VCS root): + call mkdir(g:tombi_vcs_root_temp_dir . '/project/subdir', 'p') + call mkdir(g:tombi_vcs_root_temp_dir . '/project/.git') + call writefile([], g:tombi_vcs_root_temp_dir . '/project/subdir/file.ext') + call ale#test#SetFilename(g:tombi_vcs_root_temp_dir . '/project/subdir/file.ext') + + AssertLSPProject ale#path#Simplify(g:tombi_vcs_root_temp_dir . '/project') diff --git a/test/test_find_vcs_root.vader b/test/test_find_vcs_root.vader new file mode 100644 index 0000000000..4c4a79abbb --- /dev/null +++ b/test/test_find_vcs_root.vader @@ -0,0 +1,87 @@ +Before: + Save g:ale_vcs_root + Save b:ale_vcs_root + + call ale#test#SetDirectory('/testplugin/test') + + let g:vcs_root_temp_dir = ale#path#Simplify(tempname()) + call mkdir(g:vcs_root_temp_dir, 'p') + let g:ale_vcs_root = ['git', 'got', 'hg'] + +After: + call ale#test#RestoreDirectory() + call delete(g:vcs_root_temp_dir, 'rf') + unlet! g:vcs_root_temp_dir + + Restore + +Execute(FindVCSRoot should find a simple git directory): + call mkdir(g:vcs_root_temp_dir . '/simple/project/src', 'p') + call mkdir(g:vcs_root_temp_dir . '/simple/project/.git') + call writefile([], g:vcs_root_temp_dir . '/simple/project/src/file.toml') + call ale#test#SetFilename(g:vcs_root_temp_dir . '/simple/project/src/file.toml') + + AssertEqual + \ ale#path#Simplify(g:vcs_root_temp_dir . '/simple/project'), + \ ale#path#FindVCSRoot(bufnr('')) + +Execute(FindVCSRoot should find git worktree files): + call mkdir(g:vcs_root_temp_dir . '/with-worktree/project/src', 'p') + call mkdir(g:vcs_root_temp_dir . '/with-worktree/project/.git') + call mkdir(g:vcs_root_temp_dir . '/with-worktree/project/wt/src', 'p') + call writefile([], g:vcs_root_temp_dir . '/with-worktree/project/wt/.git') + call writefile([], g:vcs_root_temp_dir . '/with-worktree/project/wt/src/file.toml') + call ale#test#SetFilename(g:vcs_root_temp_dir . '/with-worktree/project/wt/src/file.toml') + + AssertEqual + \ ale#path#Simplify(g:vcs_root_temp_dir . '/with-worktree/project/wt'), + \ ale#path#FindVCSRoot(bufnr('')) + +Execute(FindVCSRoot should choose the deepest root with the same marker): + call mkdir(g:vcs_root_temp_dir . '/nested_same/outer/inner/src', 'p') + call mkdir(g:vcs_root_temp_dir . '/nested_same/outer/.git') + call mkdir(g:vcs_root_temp_dir . '/nested_same/outer/inner/.git') + call writefile([], g:vcs_root_temp_dir . '/nested_same/outer/inner/src/file.toml') + call ale#test#SetFilename(g:vcs_root_temp_dir . '/nested_same/outer/inner/src/file.toml') + + AssertEqual + \ ale#path#Simplify(g:vcs_root_temp_dir . '/nested_same/outer/inner'), + \ ale#path#FindVCSRoot(bufnr('')) + +Execute(FindVCSRoot should choose the deepest root with different markers): + call mkdir(g:vcs_root_temp_dir . '/nested_different/project/module/src', 'p') + call mkdir(g:vcs_root_temp_dir . '/nested_different/project/.got') + call mkdir(g:vcs_root_temp_dir . '/nested_different/project/module/.hg') + call writefile([], g:vcs_root_temp_dir . '/nested_different/project/module/src/file.toml') + call ale#test#SetFilename(g:vcs_root_temp_dir . '/nested_different/project/module/src/file.toml') + + AssertEqual + \ ale#path#Simplify(g:vcs_root_temp_dir . '/nested_different/project/module'), + \ ale#path#FindVCSRoot(bufnr('')) + +Execute(FindVCSRoot should obey the global marker selector): + let g:ale_vcs_root = ['git'] + + call mkdir(g:vcs_root_temp_dir . '/global_selector/outer/inner/src', 'p') + call mkdir(g:vcs_root_temp_dir . '/global_selector/outer/.git') + call mkdir(g:vcs_root_temp_dir . '/global_selector/outer/inner/.hg') + call writefile([], g:vcs_root_temp_dir . '/global_selector/outer/inner/src/file.toml') + call ale#test#SetFilename(g:vcs_root_temp_dir . '/global_selector/outer/inner/src/file.toml') + + AssertEqual + \ ale#path#Simplify(g:vcs_root_temp_dir . '/global_selector/outer'), + \ ale#path#FindVCSRoot(bufnr('')) + +Execute(FindVCSRoot should let buffer marker selectors override globals): + let g:ale_vcs_root = ['git'] + let b:ale_vcs_root = ['hg'] + + call mkdir(g:vcs_root_temp_dir . '/buffer_selector/outer/inner/src', 'p') + call mkdir(g:vcs_root_temp_dir . '/buffer_selector/outer/.git') + call mkdir(g:vcs_root_temp_dir . '/buffer_selector/outer/inner/.hg') + call writefile([], g:vcs_root_temp_dir . '/buffer_selector/outer/inner/src/file.toml') + call ale#test#SetFilename(g:vcs_root_temp_dir . '/buffer_selector/outer/inner/src/file.toml') + + AssertEqual + \ ale#path#Simplify(g:vcs_root_temp_dir . '/buffer_selector/outer/inner'), + \ ale#path#FindVCSRoot(bufnr(''))