Skip to content

feat(gh_actions_ls): use root_dir to decide whether to attach #3558

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 4 commits into from
Jan 13, 2025
Merged

feat(gh_actions_ls): use root_dir to decide whether to attach #3558

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
e814848
feat(gh_actions_ls): use `root_dir` to decide whether to attach
chrisgrieser Jan 13, 2025
bb67599
refactor: simplify `root_dir` func
chrisgrieser Jan 13, 2025
b8d5ba6
chore: comment explaining use of root_dir to selectively attach LSP
chrisgrieser Jan 13, 2025
5222570
chore: further improve comment
chrisgrieser Jan 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 12 additions & 13 deletions lua/lspconfig/configs/gh_actions_ls.lua
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,9 +3,18 @@ local util = require 'lspconfig.util'
return {
default_config = {
cmd = { 'gh-actions-language-server', '--stdio' },
filetypes = { 'yaml.github' },
root_dir = util.root_pattern('.github'),
single_file_support = true,
filetypes = { 'yaml' },

-- Only attach to yaml files that are GitHub workflows instead of all yaml
-- files. (A nil root_dir and no single_file_support results in the LSP not
-- attaching.) For details, see #3558
root_dir = function(filename)
return filename:find('/%.github/workflows/.+%.ya?ml') and util.root_pattern('.github') or nil
end,
-- Disabling "single file support" is a hack to avoid enabling this LS for
-- every random yaml file, so `root_dir()` can control the enablement.
single_file_support = false,

capabilities = {
workspace = {
didChangeWorkspaceFolders = {
Expand All @@ -20,16 +29,6 @@ https://github.com/lttb/gh-actions-language-server

Language server for GitHub Actions.

The server is registered for the special `yaml.github` filetype. You need to configure this filetype pattern for GitHub workflow files.

```lua
vim.filetype.add({
pattern = {
['.*/%.github[%w/]+workflows[%w/]+.*%.ya?ml'] = 'yaml.github',
},
})
```

`gh-actions-language-server` can be installed via `npm`:

```sh
Expand Down
Loading