feat: export workspace markers

CONTRIBUTING.md

@@ -36,7 +36,8 @@ if vim.fn.has 'win32' == 1 then
 end
 ```
 
-* `filetypes`: a list for filetypes a 
+* `filetypes`: a list for filetypes that server supports.
+* `workspace_markers`: a list for file patterns that determines the root of the workspace folder that will be passed to the language server.
 * `root_dir`: a function (or function handle) which returns the root of the project used to determine if lspconfig should launch a new language server, or attach a previously launched server when you open a new buffer matching the filetype of the server. Note, lspconfig does not offer a dedicated single file mode (this is not codified in the spec). Do not add `vim.fn.cwd` or `util.path.dirname` in `root_dir`. A future version of lspconfig will provide emulation of a single file mode until this is formally codified in the specification. A good fallback is `util.find_git_ancestor`, see other configurations for examples.
 
 Additionally, the following options are often added:
@@ -56,7 +57,7 @@ if vim.fn.has 'win32' == 1 then
  cmd = { 'cmd.exe', '/C', bin_name, '--stdio' }
 end
 
-local root_files = {
+local workspace_markers = {
  'pyproject.toml',
  'setup.py',
  'setup.cfg',
@@ -77,7 +78,7 @@ return {
  default_config = {
  cmd = cmd,
  filetypes = { 'python' },
- root_dir = util.root_pattern(unpack(root_files)),
+ root_dir = util.root_pattern(unpack(workspace_markers)),
  single_file_support = true,
  settings = {
  python = {
@@ -101,6 +102,7 @@ https://github.com/microsoft/pyright
 
 `pyright`, a static type checker and language server for python
 ]],
+ workspace_markers = workspace_markers,
  },
 }
 ```

lua/lspconfig/server_configurations/als.lua

@@ -5,11 +5,13 @@ if vim.fn.has 'win32' == 1 then
  bin_name = 'ada_language_server.exe'
 end
 
+local workspace_markers = { 'Makefile', '.git', '*.gpr', '*.adc' }
+
 return {
  default_config = {
  cmd = { bin_name },
  filetypes = { 'ada' },
- root_dir = util.root_pattern('Makefile', '.git', '*.gpr', '*.adc'),
+ root_dir = util.root_pattern(unpack(workspace_markers)),
  },
  docs = {
  description = [[
@@ -31,7 +33,7 @@ require('lspconfig').als.setup{
 ```
 ]],
  default_config = {
- root_dir = [[util.root_pattern("Makefile", ".git", "*.gpr", "*.adc")]],
+ workspace_markers = workspace_markers,
  },
  },
 }

lua/lspconfig/server_configurations/anakin_language_server.lua

@@ -1,19 +1,17 @@
 local util = require 'lspconfig.util'
 
+local workspace_markers = {
+ 'pyproject.toml',
+ 'setup.py',
+ 'setup.cfg',
+ 'requirements.txt',
+ 'Pipfile',
+}
 return {
  default_config = {
  cmd = { 'anakinls' },
  filetypes = { 'python' },
- root_dir = function(fname)
- local root_files = {
- 'pyproject.toml',
- 'setup.py',
- 'setup.cfg',
- 'requirements.txt',
- 'Pipfile',
- }
- return util.root_pattern(unpack(root_files))(fname) or util.find_git_ancestor(fname)
- end,
+ root_dir = util.root_pattern(unpack(workspace_markers)),
  single_file_support = true,
  settings = {
  anakinls = {
@@ -74,5 +72,6 @@ Available options:
 * Initialization: https://github.com/muffinmad/anakin-language-server#initialization-option
 * Configuration: https://github.com/muffinmad/anakin-language-server#configuration-options
  ]],
+ workspace_markers = workspace_markers,
  },
 }

lua/lspconfig/server_configurations/angularls.lua

@@ -26,14 +26,16 @@ if vim.fn.has 'win32' == 1 then
  cmd = { 'cmd.exe', '/C', bin_name, unpack(args) }
 end
 
+local workspace_markers = { 'angular.json' }
+
 return {
  default_config = {
  cmd = cmd,
  filetypes = { 'typescript', 'html', 'typescriptreact', 'typescript.tsx' },
  -- Check for angular.json since that is the root of the project.
  -- Don't check for tsconfig.json or package.json since there are multiple of these
  -- in an angular monorepo setup.
- root_dir = util.root_pattern 'angular.json',
+ root_dir = util.root_pattern(unpack(workspace_markers)),
  },
  on_new_config = function(new_config, new_root_dir)
  local new_probe_dir = get_probe_dir(new_root_dir)
@@ -69,7 +71,7 @@ require'lspconfig'.angularls.setup{
 ```
  ]],
  default_config = {
- root_dir = [[root_pattern("angular.json")]],
+ workspace_markers = workspace_markers,
  },
  },
 }

lua/lspconfig/server_configurations/ansiblels.lua

@@ -7,6 +7,8 @@ if vim.fn.has 'win32' == 1 then
  cmd = { 'cmd.exe', '/C', bin_name, '--stdio' }
 end
 
+local workspace_markers = { 'ansible.cfg', '.ansible-lint' }
+
 return {
  default_config = {
  cmd = cmd,
@@ -28,7 +30,7 @@ return {
  },
  },
  filetypes = { 'yaml.ansible' },
- root_dir = util.root_pattern('ansible.cfg', '.ansible-lint'),
+ root_dir = util.root_pattern(unpack(workspace_markers)),
  single_file_support = true,
  },
  docs = {

lua/lspconfig/server_configurations/antlersls.lua

@@ -7,11 +7,13 @@ if vim.fn.has 'win32' == 1 then
  cmd = { 'cmd.exe', '/C', bin_name, '--stdio' }
 end
 
+local workspace_markers = { 'composer.json' }
+
 return {
  default_config = {
  cmd = cmd,
  filetypes = { 'html', 'antlers' },
- root_dir = util.root_pattern 'composer.json',
+ root_dir = util.root_pattern(unpack(workspace_markers)),
  },
  docs = {
  description = [[

lua/lspconfig/server_configurations/apex_ls.lua

@@ -1,9 +1,11 @@
 local util = require 'lspconfig.util'
 
+local workspace_markers = { 'sfdx-project.json' }
+
 return {
  default_config = {
  filetypes = { 'apexcode' },
- root_dir = util.root_pattern 'sfdx-project.json',
+ root_dir = util.root_pattern(unpack(workspace_markers)),
  on_new_config = function(config)
  if not config.cmd and config.apex_jar_path then
  config.cmd = {
@@ -40,7 +42,7 @@ require'lspconfig'.apex_ls.setup {
 ```
 ]],
  default_config = {
- root_dir = [[root_pattern('sfdx-project.json')]],
+ workspace_markers = workspace_markers,
  },
  },
 }

lua/lspconfig/server_configurations/arduino_language_server.lua

@@ -1,9 +1,11 @@
 local util = require 'lspconfig.util'
 
+local workspace_markers = { '*.ino' }
+
 return {
  default_config = {
  filetypes = { 'arduino' },
- root_dir = util.root_pattern '*.ino',
+ root_dir = util.root_pattern(unpack(workspace_markers)),
  },
  docs = {
  description = [[

lua/lspconfig/server_configurations/asm_lsp.lua

@@ -1,10 +1,12 @@
 local util = require 'lspconfig.util'
 
+local workspace_markers = { '.git' }
+
 return {
  default_config = {
  cmd = { 'asm-lsp' },
  filetypes = { 'asm', 'vmasm' },
- root_dir = util.find_git_ancestor,
+ root_dir = util.root_pattern(unpack(workspace_markers)),
  },
  docs = {
  description = [[

lua/lspconfig/server_configurations/astro.lua

@@ -13,11 +13,13 @@ local function get_typescript_server_path(root_dir)
  or ''
 end
 
+local workspace_markers = { 'package.json', 'tsconfig.json', 'jsconfig.json', '.git' }
+
 return {
  default_config = {
  cmd = cmd,
  filetypes = { 'astro' },
- root_dir = util.root_pattern('package.json', 'tsconfig.json', 'jsconfig.json', '.git'),
+ root_dir = util.root_pattern(unpack(workspace_markers)),
  init_options = {
  typescript = {
  serverPath = '',
@@ -44,7 +46,7 @@ npm install -g @astrojs/language-server
 ```
 ]],
  default_config = {
- root_dir = [[root_pattern("package.json", "tsconfig.json", "jsconfig.json", ".git")]],
+ workspace_markers = workspace_markers,
  },
  },
 }

lua/lspconfig/server_configurations/bashls.lua

@@ -7,6 +7,8 @@ if vim.fn.has 'win32' == 1 then
  cmd = { 'cmd.exe', '/C', bin_name, 'start' }
 end
 
+local workspace_markers = { '.git' }
+
 return {
  default_config = {
  cmd = cmd,
@@ -18,7 +20,7 @@ return {
  GLOB_PATTERN = vim.env.GLOB_PATTERN or '*@(.sh|.inc|.bash|.command)',
  },
  filetypes = { 'sh' },
- root_dir = util.find_git_ancestor,
+ root_dir = util.root_pattern(unpack(workspace_markers)),
  single_file_support = true,
  },
  docs = {
@@ -33,7 +35,7 @@ npm i -g bash-language-server
 Language server for bash, written using tree sitter in typescript.
 ]],
  default_config = {
- root_dir = [[util.find_git_ancestor]],
+ workspace_markers = workspace_markers,
  },
  },
 }

lua/lspconfig/server_configurations/beancount.lua

@@ -1,10 +1,12 @@
 local util = require 'lspconfig.util'
 
+local workspace_markers = { '.git' }
+
 return {
  default_config = {
  cmd = { 'beancount-language-server', '--stdio' },
  filetypes = { 'beancount', 'bean' },
- root_dir = util.find_git_ancestor,
+ root_dir = util.root_pattern(unpack(workspace_markers)),
  single_file_support = true,
  init_options = {
  -- this is the path to the beancout journal file
@@ -18,7 +20,7 @@ https://github.com/polarmutex/beancount-language-server#installation
 See https://github.com/polarmutex/beancount-language-server#configuration for configuration options
 ]],
  default_config = {
- root_dir = [[root_pattern(".git")]],
+ workspace_markers = workspace_markers,
  },
  },
 }

lua/lspconfig/server_configurations/bicep.lua

@@ -1,9 +1,11 @@
 local util = require 'lspconfig.util'
 
+local workspace_markers = { '.git' }
+
 return {
  default_config = {
  filetypes = { 'bicep' },
- root_dir = util.find_git_ancestor,
+ root_dir = util.root_pattern(unpack(workspace_markers)),
  init_options = {},
  },
  docs = {
@@ -41,7 +43,7 @@ To download the latest release and place in /usr/local/bin/bicep-langserver:
 ```
 ]=],
  default_config = {
- root_dir = [[util.find_git_ancestor]],
+ workspace_markers = workspace_markers,
  },
  },
 }

lua/lspconfig/server_configurations/blueprint_ls.lua

@@ -7,6 +7,8 @@ if vim.fn.has 'win32' == 1 then
  cmd = { 'cmd.exe', '/C', bin_name, 'start' }
 end
 
+local workspace_markers = { '.git' }
+
 return {
  default_config = {
  cmd = cmd,
@@ -18,7 +20,7 @@ return {
  GLOB_PATTERN = vim.env.GLOB_PATTERN or '*@(.blp)',
  },
  filetypes = { 'blueprint' },
- root_dir = util.find_git_ancestor,
+ root_dir = util.root_pattern(unpack(workspace_markers)),
  single_file_support = true,
  },
  docs = {
@@ -31,7 +33,7 @@ Language server for the blurprint markup language, written in python and part
 of the blueprint-compiler.
 ]],
  default_config = {
- root_dir = [[util.find_git_ancestor]],
+ workspace_markers = workspace_markers,
  },
  },
 }

lua/lspconfig/server_configurations/bsl_ls.lua

@@ -1,9 +1,11 @@
 local util = require 'lspconfig.util'
 
+local workspace_markers = { '.git' }
+
 return {
  default_config = {
  filetypes = { 'bsl', 'os' },
- root_dir = util.find_git_ancestor,
+ root_dir = util.root_pattern(unpack(workspace_markers)),
  },
  docs = {
  description = [[
@@ -13,7 +15,7 @@ return {
 
  ]],
  default_config = {
- root_dir = [[root_pattern(".git")]],
+ workspace_markers = workspace_markers,
  },
  },
 }

lua/lspconfig/server_configurations/bufls.lua

@@ -7,13 +7,13 @@ if vim.fn.has 'win32' == 1 then
  cmd = { 'cmd.exe', '/C', bin_name, 'start' }
 end
 
+local workspace_markers = { 'buf.work.yaml', '.git' }
+
 return {
  default_config = {
  cmd = cmd,
  filetypes = { 'proto' },
- root_dir = function(fname)
- return util.root_pattern('buf.work.yaml', '.git')(fname)
- end,
+ root_dir = util.root_pattern(unpack(workspace_markers)),
  },
  docs = {
  description = [[
@@ -27,7 +27,7 @@ go install github.com/bufbuild/buf-language-server/cmd/bufls@latest
 bufls is a Protobuf language server compatible with Buf modules and workspaces
 ]],
  default_config = {
- root_dir = [[root_pattern("buf.work.yaml", ".git")]],
+ workspace_markers = workspace_markers,
  },
  },
 }