git.iko.soy/crush
on main help sign in
feat(lsp): add filetypes configuration (#666)

* feat(lsp): add filetypes configuration Signed-off-by: Carlos Alexandro Becker <caarlos0@users.noreply.github.com> * fix: simplify Signed-off-by: Carlos Alexandro Becker <caarlos0@users.noreply.github.com> * fix: test Signed-off-by: Carlos Alexandro Becker <caarlos0@users.noreply.github.com> * refactor: cleanup Signed-off-by: Carlos Alexandro Becker <caarlos0@users.noreply.github.com> * fix: improvements Signed-off-by: Carlos Alexandro Becker <caarlos0@users.noreply.github.com> * fix: accept fts and exts Signed-off-by: Carlos Alexandro Becker <caarlos0@users.noreply.github.com> --------- Signed-off-by: Carlos Alexandro Becker <caarlos0@users.noreply.github.com>

commit90097e9adb207608cfe94c45d9744c87fc49d02a authorCarlos Alexandro Becker <caarlos0@users.noreply.github.com> dateThu 14 Aug 2025, 14:09 (1 year ago) parentf8da476
7 files changed+194−19
compare with main
unifiedsplit
internal/app/lsp.go+6−5 internal/config/config.go+5−4 internal/config/load.go+35 internal/lsp/client.go+34−2 internal/lsp/client_test.go+93 internal/lsp/watcher/watcher.go+10−8 schema.json+11
internal/app/lsp.go+6−5
@@ -5,6 +5,7 @@ import (
55 "log/slog"
66 "time"
77
8+ "github.com/charmbracelet/crush/internal/config"
89 "github.com/charmbracelet/crush/internal/log"
910 "github.com/charmbracelet/crush/internal/lsp"
1011 "github.com/charmbracelet/crush/internal/lsp/watcher"
@@ -13,20 +14,20 @@ import (
1314// initLSPClients initializes LSP clients.
1415func (app *App) initLSPClients(ctx context.Context) {
1516 for name, clientConfig := range app.config.LSP {
16− go app.createAndStartLSPClient(ctx, name, clientConfig.Command, clientConfig.Args...)
17+ go app.createAndStartLSPClient(ctx, name, clientConfig)
1718 }
1819 slog.Info("LSP clients initialization started in background")
1920}
2021
2122// createAndStartLSPClient creates a new LSP client, initializes it, and starts its workspace watcher
22−func (app *App) createAndStartLSPClient(ctx context.Context, name string, command string, args ...string) {
23− slog.Info("Creating LSP client", "name", name, "command", command, "args", args)
23+func (app *App) createAndStartLSPClient(ctx context.Context, name string, config config.LSPConfig) {
24+ slog.Info("Creating LSP client", "name", name, "command", config.Command, "fileTypes", config.FileTypes, "args", config.Args)
2425
2526 // Update state to starting
2627 updateLSPState(name, lsp.StateStarting, nil, nil, 0)
2728
2829 // Create LSP client.
29− lspClient, err := lsp.NewClient(ctx, name, command, args...)
30+ lspClient, err := lsp.NewClient(ctx, name, config)
3031 if err != nil {
3132 slog.Error("Failed to create LSP client for", name, err)
3233 updateLSPState(name, lsp.StateError, err, nil, 0)
@@ -123,6 +124,6 @@ func (app *App) restartLSPClient(ctx context.Context, name string) {
123124 }
124125
125126 // Create a new client using the shared function.
126− app.createAndStartLSPClient(ctx, name, clientConfig.Command, clientConfig.Args...)
127+ app.createAndStartLSPClient(ctx, name, clientConfig)
127128 slog.Info("Successfully restarted LSP client", "client", name)
128129}
internal/config/config.go+5−4
@@ -117,10 +117,11 @@ type MCPConfig struct {
117117}
118118
119119type LSPConfig struct {
120− Disabled bool `json:"enabled,omitempty" jsonschema:"description=Whether this LSP server is disabled,default=false"`
121− Command string `json:"command" jsonschema:"required,description=Command to execute for the LSP server,example=gopls"`
122− Args []string `json:"args,omitempty" jsonschema:"description=Arguments to pass to the LSP server command"`
123− Options any `json:"options,omitempty" jsonschema:"description=LSP server-specific configuration options"`
120+ Disabled bool `json:"enabled,omitempty" jsonschema:"description=Whether this LSP server is disabled,default=false"`
121+ Command string `json:"command" jsonschema:"required,description=Command to execute for the LSP server,example=gopls"`
122+ Args []string `json:"args,omitempty" jsonschema:"description=Arguments to pass to the LSP server command"`
123+ Options any `json:"options,omitempty" jsonschema:"description=LSP server-specific configuration options"`
124+ FileTypes []string `json:"filetypes,omitempty" jsonschema:"description=File types this LSP server handles,example=go,example=mod,example=rs,example=c,example=js,example=ts"`
124125}
125126
126127type TUIOptions struct {
internal/config/load.go+35
@@ -328,12 +328,47 @@ func (c *Config) setDefaults(workingDir string) {
328328 c.LSP = make(map[string]LSPConfig)
329329 }
330330
331+ // Apply default file types for known LSP servers if not specified
332+ applyDefaultLSPFileTypes(c.LSP)
333+
331334 // Add the default context paths if they are not already present
332335 c.Options.ContextPaths = append(defaultContextPaths, c.Options.ContextPaths...)
333336 slices.Sort(c.Options.ContextPaths)
334337 c.Options.ContextPaths = slices.Compact(c.Options.ContextPaths)
335338}
336339
340+var defaultLSPFileTypes = map[string][]string{
341+ "gopls": {"go", "mod", "sum", "work"},
342+ "typescript-language-server": {"ts", "tsx", "js", "jsx", "mjs", "cjs"},
343+ "vtsls": {"ts", "tsx", "js", "jsx", "mjs", "cjs"},
344+ "bash-language-server": {"sh", "bash", "zsh", "ksh"},
345+ "rust-analyzer": {"rs"},
346+ "pyright": {"py", "pyi"},
347+ "pylsp": {"py", "pyi"},
348+ "clangd": {"c", "cpp", "cc", "cxx", "h", "hpp"},
349+ "jdtls": {"java"},
350+ "vscode-html-languageserver": {"html", "htm"},
351+ "vscode-css-languageserver": {"css", "scss", "sass", "less"},
352+ "vscode-json-languageserver": {"json", "jsonc"},
353+ "yaml-language-server": {"yaml", "yml"},
354+ "lua-language-server": {"lua"},
355+ "solargraph": {"rb"},
356+ "elixir-ls": {"ex", "exs"},
357+ "zls": {"zig"},
358+}
359+
360+// applyDefaultLSPFileTypes sets default file types for known LSP servers
361+func applyDefaultLSPFileTypes(lspConfigs map[string]LSPConfig) {
362+ for name, config := range lspConfigs {
363+ if len(config.FileTypes) != 0 {
364+ continue
365+ }
366+ bin := strings.ToLower(filepath.Base(config.Command))
367+ config.FileTypes = defaultLSPFileTypes[bin]
368+ lspConfigs[name] = config
369+ }
370+}
371+
337372func (c *Config) defaultModelSelection(knownProviders []catwalk.Provider) (largeModel SelectedModel, smallModel SelectedModel, err error) {
338373 if len(knownProviders) == 0 && c.Providers.Len() == 0 {
339374 err = fmt.Errorf("no providers configured, please configure at least one provider")
internal/lsp/client.go+34−2
@@ -30,6 +30,9 @@ type Client struct {
3030 // Client name for identification
3131 name string
3232
33+ // File types this LSP server handles (e.g., .go, .rs, .py)
34+ fileTypes []string
35+
3336 // Diagnostic change callback
3437 onDiagnosticsChanged func(name string, count int)
3538
@@ -60,8 +63,9 @@ type Client struct {
6063 serverState atomic.Value
6164}
6265
63−func NewClient(ctx context.Context, name, command string, args ...string) (*Client, error) {
64− cmd := exec.CommandContext(ctx, command, args...)
66+// NewClient creates a new LSP client.
67+func NewClient(ctx context.Context, name string, config config.LSPConfig) (*Client, error) {
68+ cmd := exec.CommandContext(ctx, config.Command, config.Args...)
6569 // Copy env
6670 cmd.Env = os.Environ()
6771
@@ -83,6 +87,7 @@ func NewClient(ctx context.Context, name, command string, args ...string) (*Clie
8387 client := &Client{
8488 Cmd: cmd,
8589 name: name,
90+ fileTypes: config.FileTypes,
8691 stdin: stdin,
8792 stdout: bufio.NewReader(stdout),
8893 stderr: stderr,
@@ -609,7 +614,34 @@ type OpenFileInfo struct {
609614 URI protocol.DocumentURI
610615}
611616
617+// HandlesFile checks if this LSP client handles the given file based on its
618+// extension.
619+func (c *Client) HandlesFile(path string) bool {
620+ // If no file types are specified, handle all files (backward compatibility)
621+ if len(c.fileTypes) == 0 {
622+ return true
623+ }
624+
625+ name := strings.ToLower(filepath.Base(path))
626+ for _, filetpe := range c.fileTypes {
627+ suffix := strings.ToLower(filetpe)
628+ if !strings.HasPrefix(suffix, ".") {
629+ suffix = "." + suffix
630+ }
631+ if strings.HasSuffix(name, suffix) {
632+ slog.Debug("handles file", "name", c.name, "file", name, "filetype", filetpe)
633+ return true
634+ }
635+ }
636+ slog.Debug("doesn't handle file", "name", c.name, "file", name)
637+ return false
638+}
639+
612640func (c *Client) OpenFile(ctx context.Context, filepath string) error {
641+ if !c.HandlesFile(filepath) {
642+ return nil
643+ }
644+
613645 uri := string(protocol.URIFromPath(filepath))
614646
615647 c.openFilesMu.Lock()
internal/lsp/client_test.gonew file+93
@@ -0,0 +1,93 @@
1+package lsp
2+
3+import (
4+ "testing"
5+
6+ "github.com/stretchr/testify/require"
7+)
8+
9+func TestHandlesFile(t *testing.T) {
10+ tests := []struct {
11+ name string
12+ fileTypes []string
13+ filepath string
14+ expected bool
15+ }{
16+ {
17+ name: "no file types specified - handles all files",
18+ fileTypes: nil,
19+ filepath: "test.go",
20+ expected: true,
21+ },
22+ {
23+ name: "empty file types - handles all files",
24+ fileTypes: []string{},
25+ filepath: "test.go",
26+ expected: true,
27+ },
28+ {
29+ name: "matches .go extension",
30+ fileTypes: []string{".go"},
31+ filepath: "main.go",
32+ expected: true,
33+ },
34+ {
35+ name: "matches go extension without dot",
36+ fileTypes: []string{"go"},
37+ filepath: "main.go",
38+ expected: true,
39+ },
40+ {
41+ name: "matches one of multiple extensions",
42+ fileTypes: []string{".js", ".ts", ".tsx"},
43+ filepath: "component.tsx",
44+ expected: true,
45+ },
46+ {
47+ name: "does not match extension",
48+ fileTypes: []string{".go", ".rs"},
49+ filepath: "script.sh",
50+ expected: false,
51+ },
52+ {
53+ name: "matches with full path",
54+ fileTypes: []string{".sh"},
55+ filepath: "/usr/local/bin/script.sh",
56+ expected: true,
57+ },
58+ {
59+ name: "case insensitive matching",
60+ fileTypes: []string{".GO"},
61+ filepath: "main.go",
62+ expected: true,
63+ },
64+ {
65+ name: "bash file types",
66+ fileTypes: []string{".sh", ".bash", ".zsh", ".ksh"},
67+ filepath: "script.sh",
68+ expected: true,
69+ },
70+ {
71+ name: "bash should not handle go files",
72+ fileTypes: []string{".sh", ".bash", ".zsh", ".ksh"},
73+ filepath: "main.go",
74+ expected: false,
75+ },
76+ {
77+ name: "bash should not handle json files",
78+ fileTypes: []string{".sh", ".bash", ".zsh", ".ksh"},
79+ filepath: "config.json",
80+ expected: false,
81+ },
82+ }
83+
84+ for _, tt := range tests {
85+ t.Run(tt.name, func(t *testing.T) {
86+ client := &Client{
87+ fileTypes: tt.fileTypes,
88+ }
89+ result := client.HandlesFile(tt.filepath)
90+ require.Equal(t, tt.expected, result)
91+ })
92+ }
93+}
internal/lsp/watcher/watcher.go+10−8
@@ -387,6 +387,10 @@ func (w *WorkspaceWatcher) WatchWorkspace(ctx context.Context, workspacePath str
387387 return
388388 }
389389
390+ if !w.client.HandlesFile(event.Name) {
391+ continue // client doesn't handle this filetype
392+ }
393+
390394 uri := string(protocol.URIFromPath(event.Name))
391395
392396 // Add new directories to the watcher
@@ -431,8 +435,11 @@ func (w *WorkspaceWatcher) WatchWorkspace(ctx context.Context, workspacePath str
431435 // Just send the notification if needed
432436 info, err := os.Stat(event.Name)
433437 if err != nil {
434− slog.Error("Error getting file info", "path", event.Name, "error", err)
435− return
438+ if !os.IsNotExist(err) {
439+ // Only log if it's not a "file not found" error
440+ slog.Debug("Error getting file info", "path", event.Name, "error", err)
441+ }
442+ continue
436443 }
437444 if !info.IsDir() && watchKind&protocol.WatchCreate != 0 {
438445 w.debounceHandleFileEvent(ctx, uri, protocol.FileChangeType(protocol.Created))
@@ -801,6 +808,7 @@ func shouldExcludeDir(dirPath string) bool {
801808func shouldExcludeFile(filePath string) bool {
802809 fileName := filepath.Base(filePath)
803810 cfg := config.Get()
811+
804812 // Skip dot files
805813 if strings.HasPrefix(fileName, ".") {
806814 return true
@@ -812,12 +820,6 @@ func shouldExcludeFile(filePath string) bool {
812820 return true
813821 }
814822
815− // Skip temporary files
816− if strings.HasSuffix(filePath, "~") {
817− return true
818− }
819−
820− // Check file size
821823 info, err := os.Stat(filePath)
822824 if err != nil {
823825 // If we can't stat the file, skip it
schema.json+11
@@ -65,6 +65,17 @@
6565 },
6666 "options": {
6767 "description": "LSP server-specific configuration options"
68+ },
69+ "filetypes": {
70+ "items": {
71+ "type": "string",
72+ "examples": [
73+ ".go",
74+ ".mod"
75+ ]
76+ },
77+ "type": "array",
78+ "description": "File extensions this LSP server handles (e.g. .go .rs .py)"
6879 }
6980 },
7081 "additionalProperties": false,