🔀 Merge pull request #133 from sansmoraxz/feat/dynamic-ignore

gwennlbh · web-flow · commit aaf4c46b1c06 · 2025-11-24T21:11:14.000+01:00
diff --git a/README.md b/README.md
@@ -76,11 +76,53 @@ vim.api.nvim_create_autocmd({'BufEnter', 'BufWinEnter'}, {
 						name = "hyprlang",
 						cmd = {"hyprls"},
 						root_dir = vim.fn.getcwd(),
-				}
+						settings = {
+							hyprls = {
+								preferIgnoreFile = true, -- set to false to prefer `hyprls.ignore`
+								ignore = {"hyprlock.conf", "hypridle.conf"}
+							}
+						}
+					}
 		end
 })
 ```
 
+You can control whether HyprLS prefers a workspace `.hyprlsignore` file or the editor settings with the `hyprls.preferIgnoreFile` option. Example configurations:
+
+- Using `vim.lsp.start` (example above) — set `settings.hyprls.preferIgnoreFile` to `false` to force the server to use `settings.hyprls.ignore`.
+
+- Using `nvim-lspconfig`:
+
+```lua
+local lspconfig = require('lspconfig')
+lspconfig.hyprlang.setup{
+	cmd = {"hyprls"},
+	settings = {
+		hyprls = {
+			preferIgnoreFile = false,
+			ignore = {"hyprlock.conf", "hypridle.conf"}
+		}
+	}
+}
+```
+
+When `preferIgnoreFile` is `true` (the default), HyprLS will read `.hyprlsignore` from your workspace root. When it's `false`, it will use the `hyprls.ignore` array from your editor configuration instead.
+
+Example `.hyprlsignore` (create this file at the workspace root):
+
+```
+# ignore session-specific files
+hyprlock.conf
+hypridle.conf
+# ignore any file named workspace-specific.ignore
+workspace-specific.ignore
+```
+
+Notes for Neovim users:
+
+- If you set `preferIgnoreFile = true`, HyprLS will use the workspace `.hyprlsignore` file and ignore any `settings.hyprls.ignore` values passed from Neovim.
+- If you set `preferIgnoreFile = false`, HyprLS will use the `ignore` list you provide in `settings.hyprls` (see `nvim-lspconfig` example above).
+
 ### With Emacs
 Language server support is provided by the [lsp-bridge](https://github.com/manateelazycat/lsp-bridge).
 
diff --git a/go.sum b/go.sum
@@ -1,8 +1,6 @@
 github.com/MakeNowJust/heredoc/v2 v2.0.1 h1:rlCHh70XXXv7toz95ajQWOWQnN4WNLt0TdpZYIR/J6A=
 github.com/MakeNowJust/heredoc/v2 v2.0.1/go.mod h1:6/2Abh5s+hc3g9nbWLe9ObDIOhaRrqsyY9MWy+4JdRM=
 github.com/PuerkitoBio/goquery v1.5.1/go.mod h1:GsLWisAFVj4WgDibEWF4pvYnkVQBpKBKeU+7zCJoLcc=
-github.com/PuerkitoBio/goquery v1.10.3 h1:pFYcNSqHxBD06Fpj/KsbStFRsgRATgnf3LeXiUkhzPo=
-github.com/PuerkitoBio/goquery v1.10.3/go.mod h1:tMUX0zDMHXYlAQk6p35XxQMqMweEKB7iK7iLNd4RH4Y=
 github.com/PuerkitoBio/goquery v1.11.0 h1:jZ7pwMQXIITcUXNH83LLk+txlaEy6NVOfTuP43xxfqw=
 github.com/PuerkitoBio/goquery v1.11.0/go.mod h1:wQHgxUOU3JGuj3oD/QFfxUdlzW6xPHfqyHre6VMY4DQ=
 github.com/anaskhan96/soup v1.2.5 h1:V/FHiusdTrPrdF4iA1YkVxsOpdNcgvqT1hG+YtcZ5hM=
@@ -75,8 +73,6 @@ golang.org/x/net v0.15.0/go.mod h1:idbUs1IY1+zTqbi8yxTbhexhEEk5ur9LInksu6HrEpk=
 golang.org/x/net v0.21.0/go.mod h1:bIjVDfnllIU7BJ2DNgfnXvpSvtn8VRwhlsaeUTyUS44=
 golang.org/x/net v0.25.0/go.mod h1:JkAGAh7GEvH74S6FOH42FLoXpXbE/aqXSrIQjXgsiwM=
 golang.org/x/net v0.33.0/go.mod h1:HXLR5J+9DxmrqMwG9qjGCxZ+zKXxBru04zlTvWlWuN4=
-golang.org/x/net v0.39.0 h1:ZCu7HMWDxpXpaiKdhzIfaltL9Lp31x/3fCP11bc6/fY=
-golang.org/x/net v0.39.0/go.mod h1:X7NRbYVEA+ewNkCNyJ513WmMdQ3BineSwVtN2zD/d+E=
 golang.org/x/net v0.47.0 h1:Mx+4dIFzqraBXUugkia1OOvlD6LemFo1ALMHjrXDOhY=
 golang.org/x/net v0.47.0/go.mod h1:/jNxtkgq5yWUGYkaZGqo27cfGZ1c5Nen03aYrrKpVRU=
 golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM=
@@ -97,8 +93,6 @@ golang.org/x/sys v0.12.0/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg=
 golang.org/x/sys v0.17.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
 golang.org/x/sys v0.20.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
 golang.org/x/sys v0.28.0/go.mod h1:/VUhepiaJMQUp4+oa/7Zr1D23ma6VTLIYjOOTFZPUcA=
-golang.org/x/sys v0.32.0 h1:s77OFDvIQeibCmezSnk/q6iAfkdiQaJi4VzroCFrN20=
-golang.org/x/sys v0.32.0/go.mod h1:BJP2sWEmIv4KK5OTEluFJCKSidICx8ciO85XgH3Ak8k=
 golang.org/x/sys v0.38.0 h1:3yZWxaJjBmCWXqhN1qh02AkOnCQ1poK6oF+a7xWL6Gc=
 golang.org/x/sys v0.38.0/go.mod h1:OgkHotnGiDImocRcuBABYBEXf8A9a87e/uXjp9XT3ks=
 golang.org/x/telemetry v0.0.0-20240228155512-f48c80bd79b2/go.mod h1:TeRTkGYfJXctD9OcfyVLyj2J3IxLnKwHJR8f4D8a3YE=
@@ -119,8 +113,6 @@ golang.org/x/text v0.13.0/go.mod h1:TvPlkZtksWOMsz7fbANvkp4WM8x/WCo/om8BMLbz+aE=
 golang.org/x/text v0.14.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU=
 golang.org/x/text v0.15.0/go.mod h1:18ZOQIKpY8NJVqYksKHtTdi31H5itFRjB5/qKTNYzSU=
 golang.org/x/text v0.21.0/go.mod h1:4IBbMaMmOPCJ8SecivzSH54+73PCFmPWxNTLm+vZkEQ=
-golang.org/x/text v0.24.0 h1:dd5Bzh4yt5KYA8f9CJHCP4FB4D51c2c6JvN37xJJkJ0=
-golang.org/x/text v0.24.0/go.mod h1:L8rBsPeo2pSS+xqN0d5u2ikmjtmoJbDBT1b7nHvFCdU=
 golang.org/x/text v0.31.0 h1:aC8ghyu4JhP8VojJ2lEHBnochRno1sgL6nEi9WGFGMM=
 golang.org/x/text v0.31.0/go.mod h1:tKRAlv61yKIjGGHX/4tP1LTbc13YSec1pxVEWXzfoeM=
 golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ=
diff --git a/handler.go b/handler.go
@@ -2,6 +2,7 @@ package hyprls
 
 import (
 	"context"
+	"fmt"
 	"os"
 	"strings"
 
@@ -26,23 +27,69 @@ func NewHandler(ctx context.Context, server protocol.Server, logger *zap.Logger)
 
 const ignoreFile = ".hyprlsignore"
 
+var preferIgnoreFile = true
+
+func (h *Handler) hasIgnoreFile() bool {
+	f := ignoreFile
+	stat, err := os.Stat(f)
+	if err != nil {
+		return false // assume failure means no file
+	}
+	if stat.IsDir() {
+		return false
+	}
+
+	return true
+}
+
+func (h *Handler) parseIgnoresFile(uri protocol.URI) ([]string, error) {
+	if !preferIgnoreFile {
+		return []string{}, fmt.Errorf("preferIgnoreFile is false")
+	}
+	f := uri.Filename()
+	if h.hasIgnoreFile() {
+		b, err := os.ReadFile(f)
+		if err != nil {
+			h.Logger.Error("Failed to read ignore file", zap.String("file", f), zap.Error(err))
+			return []string{}, err
+		}
+		contd := string(b)
+		ignores := strings.Split(contd, "\n")
+		// drop all comments and empty lines
+		var filteredIgnores = make([]string, 0, len(ignores))
+		for _, ig := range ignores {
+			ig = strings.TrimSpace(ig)
+			if ig == "" || strings.HasPrefix(ig, "#") || strings.HasPrefix(ig, "//") {
+				continue
+			}
+			filteredIgnores = append(filteredIgnores, ig)
+		}
+		ignores = filteredIgnores
+		h.Logger.Info("Loaded ignores from file", zap.String("file", f), zap.Strings("ignores", ignores))
+		return ignores, nil
+	} else {
+		h.Logger.Info("Ignore file does not exist", zap.String("file", f))
+		return []string{}, fmt.Errorf("ignore file does not exist")
+	}
+}
+
 func (h Handler) Initialize(ctx context.Context, params *protocol.InitializeParams) (*protocol.InitializeResult, error) {
 	logger = h.Logger
 	workspaceFolders := params.WorkspaceFolders
 	logger.Info("Loading", zap.Any("workspace", workspaceFolders))
 
+	igs := defaultIgnores
+
 	for _, workspaceFolder := range workspaceFolders {
-		f := protocol.URI(workspaceFolder.URI + "/" + ignoreFile).Filename()
-		if info, err := os.Stat(f); err == nil && !info.IsDir() {
-			logger.Debug("Loading ignore file" + ignoreFile)
-			b, err := os.ReadFile(f)
-			if err == nil {
-				contd := string(b)
-				ignores = strings.Split(contd, "\n")
-			}
+		f := protocol.URI(workspaceFolder.URI + "/" + ignoreFile)
+		loadedIgs, err := h.parseIgnoresFile(f)
+		if err == nil {
+			igs = loadedIgs
+			break
 		}
 	}
-	logger.Debug("Ignoring files", zap.Any("ignores", ignores))
+	Ignores = igs
+	logger.Info("Ignoring files", zap.Any("ignores", Ignores))
 
 	return &protocol.InitializeResult{
 		Capabilities: protocol.ServerCapabilities{
@@ -57,6 +104,12 @@ func (h Handler) Initialize(ctx context.Context, params *protocol.InitializePara
 				OpenClose: true,
 				Change:    protocol.TextDocumentSyncKindFull,
 			},
+			Workspace: &protocol.ServerCapabilitiesWorkspace{
+				WorkspaceFolders: &protocol.ServerCapabilitiesWorkspaceFolders{
+					Supported:           true,
+					ChangeNotifications: true,
+				},
+			},
 		},
 		ServerInfo: &protocol.ServerInfo{
 			Name:    "hyprls",
diff --git a/main.go b/main.go
@@ -28,6 +28,7 @@ func StartServer(logger *zap.Logger, logClientIn string) {
 
 	conn.Go(ctx, protocol.ServerHandler(handler, jsonrpc2.MethodNotFoundHandler))
 	<-conn.Done()
+	logger.Info("server stopped")
 }
 
 type readWriteCloser struct {
diff --git a/state.go b/state.go
@@ -1,7 +1,6 @@
 package hyprls
 
 import (
-	"context"
 	"os"
 	"path/filepath"
 	"slices"
@@ -16,15 +15,12 @@ import (
 var logger *zap.Logger
 
 var openedFiles = make(map[protocol.URI]string)
-var ignores = []string{"hyprlock.conf", "hypridle.conf"}
+var defaultIgnores = []string{"hyprlock.conf", "hypridle.conf"}
+var Ignores = defaultIgnores
 
 type state struct {
 }
 
-func (h Handler) state(ctx context.Context) state {
-	return ctx.Value("state").(state)
-}
-
 func parse(uri protocol.URI) (parser.Section, error) {
 	contents, err := file(uri)
 	if err != nil {
@@ -105,5 +101,5 @@ func currentLine(uri protocol.URI, position protocol.Position) (string, error) {
 
 func isFileIgnored(uri protocol.URI) bool {
 	n := filepath.Base(uri.Filename())
-	return slices.Contains(ignores, n)
+	return slices.Contains(Ignores, n)
 }
diff --git a/unimplemented.go b/unimplemented.go
@@ -39,14 +39,6 @@ func (h Handler) Declaration(ctx context.Context, params *protocol.DeclarationPa
 	return nil, errors.New("unimplemented")
 }
 
-func (h Handler) DidChangeConfiguration(ctx context.Context, params *protocol.DidChangeConfigurationParams) error {
-	return errors.New("unimplemented")
-}
-
-func (h Handler) DidChangeWatchedFiles(ctx context.Context, params *protocol.DidChangeWatchedFilesParams) error {
-	return errors.New("unimplemented")
-}
-
 func (h Handler) DidChangeWorkspaceFolders(ctx context.Context, params *protocol.DidChangeWorkspaceFoldersParams) error {
 	return errors.New("unimplemented")
 }
diff --git a/vscode/README.md b/vscode/README.md
@@ -3,3 +3,23 @@
 ## Installation
 
 Requires [installing `hyprls`](https://github.com/ewen-lbh/hyprls) and having in on your PATH.
+
+## Ignore file preference
+
+By default HyprLS will prefer a `.hyprlsignore` file in your workspace to list filenames or patterns that the language server should ignore. This behavior can be overridden by a configuration option exposed by the VSCode extension.
+
+- **Config key:** `hyprls.preferIgnoreFile` (boolean)
+- **Default:** `true` — prefer the `.hyprlsignore` file over the extension setting `hyprls.ignore`.
+
+How to set it in VSCode:
+
+```json
+// In your Workspace or User settings (settings.json)
+{
+	"hyprls.preferIgnoreFile": false,
+	"hyprls.ignore": [
+		"hyprlock.conf",
+		"hypridle.conf"
+	]
+}
+```
diff --git a/vscode/package.json b/vscode/package.json
@@ -12,7 +12,7 @@
   "categories": [],
   "keywords": [],
   "engines": {
-    "vscode": "^1.999.0"
+    "vscode": "^1.106.0"
   },
   "contributes": {
     "languages": [
@@ -35,7 +35,31 @@
         "title": "Restart language server",
         "command": "vscode-hyprls.restart-lsp"
       }
-    ]
+    ],
+    "configuration": {
+      "type": "object",
+      "title": "HyprLS",
+      "properties": {
+        "hyprls.ignore": {
+          "type": [
+            "array"
+          ],
+          "items": {
+            "type": "string"
+          },
+          "description": "List of files or patterns to ignore",
+          "default": [
+            "hyprlock.conf",
+            "hypridle.conf"
+          ]
+        },
+        "hyprls.preferIgnoreFile": {
+          "type": "boolean",
+          "description": "Whether to prefer .hyprignore file over 'hyprls.ignore' setting",
+          "default": true
+        }
+      }
+    }
   },
   "activationEvents": [
     "onLanguage:hyprlang"
diff --git a/vscode/src/extension.ts b/vscode/src/extension.ts
@@ -4,6 +4,7 @@
  * ------------------------------------------------------------------------------------------ */
 
 import { commands, ExtensionContext, workspace } from "vscode"
+import * as path from "path"
 
 import {
   LanguageClient,
@@ -25,7 +26,10 @@ export function activate(context: ExtensionContext) {
       transport: TransportKind.stdio,
     },
     debug: {
-      command: "/home/uwun/projects/hyprls/hyprlang-lsp",
+      command: "./hyprlang-lsp",
+      options: {
+        cwd: path.join(context.extensionPath, ".."),
+      },
       transport: TransportKind.stdio,
     },
   }
@@ -36,7 +40,8 @@ export function activate(context: ExtensionContext) {
     documentSelector: [{ scheme: "file", language: "hyprlang" }],
     outputChannelName: "HyprLS",
     synchronize: {
-      fileEvents: workspace.createFileSystemWatcher("*.hl"),
+      fileEvents: workspace.createFileSystemWatcher("**/.hyprlsignore"),
+      configurationSection: "hyprls",
     },
   }
 
diff --git a/workspace.go b/workspace.go

Original file line number	Diff line number	Diff line change
`@@ -28,6 +28,7 @@ func StartServer(logger *zap.Logger, logClientIn string) {`
`28`	`28`
`29`	`29`	`conn.Go(ctx, protocol.ServerHandler(handler, jsonrpc2.MethodNotFoundHandler))`
`30`	`30`	`<-conn.Done()`
	`31`	`+ logger.Info("server stopped")`
`31`	`32`	`}`
`32`	`33`
`33`	`34`	`type readWriteCloser struct {`
Original file line number	Diff line number	Diff line change
`@@ -39,14 +39,6 @@ func (h Handler) Declaration(ctx context.Context, params *protocol.DeclarationPa`
`39`	`39`	`return nil, errors.New("unimplemented")`
`40`	`40`	`}`
`41`	`41`
`42`		`-func (h Handler) DidChangeConfiguration(ctx context.Context, params *protocol.DidChangeConfigurationParams) error {`
`43`		`- return errors.New("unimplemented")`
`44`		`-}`
`45`		`-`
`46`		`-func (h Handler) DidChangeWatchedFiles(ctx context.Context, params *protocol.DidChangeWatchedFilesParams) error {`
`47`		`- return errors.New("unimplemented")`
`48`		`-}`
`49`		`-`
`50`	`42`	`func (h Handler) DidChangeWorkspaceFolders(ctx context.Context, params *protocol.DidChangeWorkspaceFoldersParams) error {`
`51`	`43`	`return errors.New("unimplemented")`
`52`	`44`	`}`