diagnostics: Add file path-based configuration support (#313)

This commit implements file path-based filtering for diagnostic patterns
as discussed at
https://publish.obsidian.md/jetls/work/JETLS/diagnostic+Support+file+path+based+configuration,
allowing users to apply different diagnostic configurations to specific
files or directories using glob patterns.

Users can now add an optional `path` field to diagnostic pattern
configurations that accepts glob patterns (e.g., "test/**/*.jl"). When
specified, the diagnostic pattern only applies to files matching that
glob pattern. Patterns are matched against file paths relative to the
workspace root, with support for globstar (`**`) for recursive directory
matching.

Written with a help from Claude.

Author: aviatesk

Project.toml

@@ -8,6 +8,7 @@ projects = ["docs", "test"]
 
 [deps]
 Configurations = "5218b696-f38b-4ac9-8b61-a12ec717816d"
+Glob = "c27321d9-0574-5035-807b-f59d2c89b15c"
 JET = "c3a54625-cd67-489e-a8e7-0a5a0ff4e31b"
 JuliaLowering = "f3c80556-a63f-4383-b822-37d64f81a311"
 JuliaSyntax = "70703baa-626e-46a2-a12c-08ffd08c73b4"
@@ -20,13 +21,15 @@ REPL = "3fa0cd96-eef1-5676-8a61-b3b8758bbffb"
 TOML = "fa267f1f-6049-4f14-aa54-33bafae1ed76"
 
 [sources]
+Glob = {rev = "avi/globstar", url = "https://github.com/aviatesk/Glob.jl"}
 JET = {rev = "1e84376", url = "https://github.com/aviatesk/JET.jl"}
-JuliaLowering = {rev = "avi/JETLS-JSJL-head", url = "https://github.com/JuliaLang/julia", subdir="JuliaLowering"}
-JuliaSyntax = {rev = "avi/JETLS-JSJL-head", url = "https://github.com/JuliaLang/julia", subdir="JuliaSyntax"}
+JuliaLowering = {rev = "avi/JETLS-JSJL-head", subdir = "JuliaLowering", url = "https://github.com/JuliaLang/julia"}
+JuliaSyntax = {rev = "avi/JETLS-JSJL-head", subdir = "JuliaSyntax", url = "https://github.com/JuliaLang/julia"}
 LSP = {path = "LSP"}
 
 [compat]
 Configurations = "0.17.6"
+Glob = "1.3.1"
 JET = "0.10.6"
 JuliaLowering = "1"
 JuliaSyntax = "2"

docs/src/configuration.md

@@ -23,6 +23,7 @@ pattern = ""               # string, required
 match_by = ""              # string, required, "code" or "message"
 match_type = ""            # string, required, "literal" or "regex"
 severity = ""              # string or number, required, "error"/"warning"/"warn"/"information"/"info"/"hint"/"off" or 0/1/2/3/4
+path = ""                  # string (optional), glob pattern for file paths
 
 [testrunner]
 executable = "testrunner"  # string, default: "testrunner" (or "testrunner.bat" on Windows)
@@ -133,10 +134,11 @@ Each pattern is defined as a table array entry with the following fields:
 
 ```toml
 [[diagnostic.patterns]]
-pattern = "pattern-value"  # the pattern to match
-match_by = "code"          # "code" or "message"
-match_type = "literal"     # "literal" or "regex"
-severity = "hint"          # severity level
+pattern = "pattern-value"  # string: the pattern to match
+match_by = "code"          # string: "code" or "message"
+match_type = "literal"     # string: "literal" or "regex"
+severity = "hint"          # string or number: severity level
+path = "src/**/*.jl"       # string (optional): restrict to specific files
 ```
 
 - `pattern` (**Type**: string): The pattern to match. For code matching, use diagnostic
@@ -149,6 +151,11 @@ severity = "hint"          # severity level
   - `"literal"`: Exact string match
   - `"regex"`: Regular expression match
 - `severity` (**Type**: string or number): Severity level to apply
+- `path` (**Type**: string, optional): Glob pattern to restrict this
+  configuration to specific files.
+  Patterns are matched against _file paths relative to the workspace root_.
+  Supports globstar (`**`) for matching directories recursively.
+  If omitted, the pattern applies to all files.
 
 ##### Severity values
 
@@ -254,6 +261,22 @@ pattern = "Macro name `.*` not found"
 match_by = "message"
 match_type = "regex"
 severity = "off"
+
+# File path-based filtering: downgrade unused arguments in test files
+[[diagnostic.patterns]]
+pattern = "lowering/unused-argument"
+match_by = "code"
+match_type = "literal"
+severity = "hint"
+path = "test/**/*.jl"
+
+# Disable all diagnostics for generated files
+[[diagnostic.patterns]]
+pattern = ".*"
+match_by = "code"
+match_type = "regex"
+severity = "off"
+path = "gen/**/*.jl"
 ```
 
 See the [configuring diagnostics](@ref configuring-diagnostic) section for

docs/src/diagnostic.md

@@ -261,67 +261,56 @@ nothing # This is an internal comment for this documenation: # hide
 nothing # Use H5 for subsections in this section so that the `@contents` block above works as intended. # hide
 ```
 
-##### Quick example
+##### Common use cases
 
-```toml
-# Pattern matching against diagnostic code
-[[diagnostic.patterns]]
-pattern = "lowering/.*"
-match_by = "code"
-match_type = "regex"
-severity = "warning"
+Suppress specific macro expansion errors:
 
-# Pattern matching against diagnostic message
+```toml
 [[diagnostic.patterns]]
-pattern = "Macro name `@namespace` not found"
+pattern = "Macro name `MyPkg.@mymacro` not found"
 match_by = "message"
 match_type = "literal"
-severity = "info"
-
-# Disable specific diagnostic by code
-[[diagnostic.patterns]]
-pattern = "lowering/unused-argument"
-match_by = "code"
-match_type = "literal"
 severity = "off"
 ```
 
-##### Common use cases
-
-Disable unused variable warnings during prototyping:
+Apply different settings for test files:
 
 ```toml
+# Downgrade unused arguments to hints in test files
 [[diagnostic.patterns]]
 pattern = "lowering/unused-argument"
 match_by = "code"
 match_type = "literal"
-severity = "off"
+severity = "hint"
+path = "test/**/*.jl"
 
+# Disable all diagnostics for generated code
 [[diagnostic.patterns]]
-pattern = "lowering/unused-local"
+pattern = ".*"
 match_by = "code"
-match_type = "literal"
+match_type = "regex"
 severity = "off"
+path = "gen/**/*.jl"
 ```
 
-Make inference diagnostic less intrusive:
+Disable unused variable warnings during prototyping:
 
 ```toml
 [[diagnostic.patterns]]
-pattern = "inference/.*"
+pattern = "lowering/(unused-argument|unused-local)"
 match_by = "code"
 match_type = "regex"
-severity = "hint"
+severity = "off"
 ```
 
-Suppress specific macro expansion errors:
+Make inference diagnostic less intrusive:
 
 ```toml
 [[diagnostic.patterns]]
-pattern = "Macro name `MyPkg.@mymacro` not found"
-match_by = "message"
-match_type = "literal"
-severity = "off"
+pattern = "inference/.*"
+match_by = "code"
+match_type = "regex"
+severity = "hint"
 ```
 
 For complete configuration options, severity values, pattern matching syntax,

package.json

@@ -197,6 +197,10 @@
                           }
                         ],
                         "description": "Severity level to apply: 'error'/1 for critical issues, 'warning'/'warn'/2 for potential problems, 'information'/'info'/3 for informational messages, 'hint'/4 for suggestions, 'off'/0 to disable."
+                      },
+                      "path": {
+                        "type": "string",
+                        "description": "Optional glob pattern to restrict this configuration to specific files (e.g., 'test/**/*.jl'). Patterns are matched against file paths relative to the workspace root. Supports globstar (**) for matching directories recursively."
                       }
                     }
                   }

src/JETLS.jl

@@ -33,6 +33,7 @@ using Markdown: Markdown
 using TOML: TOML
 
 using Configurations: @option, Configurations, Maybe
+using Glob: Glob
 
 abstract type AnalysisEntry end # used by `Analyzer.LSAnalyzer`
 

src/diagnostics.jl

@@ -55,10 +55,10 @@ function parse_diagnostic_pattern(x::AbstractDict{String})
     end
 
     for key in keys(x)
-        if key ∉ ("pattern", "match_by", "match_type", "severity")
+        if key ∉ ("pattern", "match_by", "match_type", "severity", "path")
             throw(DiagnosticConfigError(
                 lazy"Unknown field \"$key\" in diagnostic pattern for pattern \"$pattern_value\". " *
-                "Valid fields are: pattern, match_by, match_type, severity"))
+                "Valid fields are: pattern, match_by, match_type, severity, path"))
         end
     end
 
@@ -107,7 +107,23 @@ function parse_diagnostic_pattern(x::AbstractDict{String})
     end
     severity = parse_diagnostic_severity(x["severity"], pattern_value)
 
-    return DiagnosticPattern(pattern, match_by, match_type, severity)
+    path_glob = if haskey(x, "path")
+        path_value = x["path"]
+        if !(path_value isa String)
+            throw(DiagnosticConfigError(
+                lazy"Invalid `path` value for pattern \"$pattern_value\". Must be a string, got $(typeof(path_value))"))
+        end
+        try
+            Glob.FilenameMatch(path_value)
+        catch e
+            throw(DiagnosticConfigError(
+                lazy"Invalid glob pattern \"$path_value\" for path: $(sprint(showerror, e))"))
+        end
+    else
+        nothing
+    end
+
+    return DiagnosticPattern(pattern, match_by, match_type, severity, path_glob)
 end
 
 # config application
@@ -153,7 +169,10 @@ function calculate_match_specificity(
     return specificity
 end
 
-function _apply_diagnostic_config(diagnostic::Diagnostic, manager::ConfigManager)
+function _apply_diagnostic_config(
+        diagnostic::Diagnostic, manager::ConfigManager, uri::URI,
+        root_path::Union{Nothing,String}
+    )
     code = diagnostic.code
     if !(code isa String)
         if JETLS_DEV_MODE
@@ -174,10 +193,20 @@ function _apply_diagnostic_config(diagnostic::Diagnostic, manager::ConfigManager
     patterns = get_config(manager, :diagnostic, :patterns)
     isempty(patterns) && return diagnostic
 
+    filepath = uri2filename(uri)
+    if root_path !== nothing && startswith(filepath, root_path)
+        path_for_glob = relpath(filepath, root_path)
+    else
+        path_for_glob = filepath
+    end
     message = diagnostic.message
     severity = nothing
     best_specificity = 0
     for pattern_config in patterns
+        globpath = pattern_config.path
+        if globpath !== nothing && !Glob.occursin(globpath, path_for_glob)
+            continue
+        end
         target = pattern_config.match_by == "message" ? message : code
         is_message_match = pattern_config.match_by == "message"
         specificity = calculate_match_specificity(
@@ -199,17 +228,20 @@ function _apply_diagnostic_config(diagnostic::Diagnostic, manager::ConfigManager
     end
 end
 
-function apply_diagnostic_config!(diagnostics::Vector{Diagnostic}, manager::ConfigManager)
+function apply_diagnostic_config!(
+        diagnostics::Vector{Diagnostic}, manager::ConfigManager, uri::URI,
+        root_path::Union{Nothing,String}
+    )
     get_config(manager, :diagnostic, :enabled) || return empty!(diagnostics)
     i = 1
     while i <= length(diagnostics)
-        applied = _apply_diagnostic_config(diagnostics[i], manager)
+        applied = _apply_diagnostic_config(diagnostics[i], manager, uri, root_path)
         if applied === missing
             deleteat!(diagnostics, i)
             continue
         end
         if applied !== nothing
-            diagnostics[i] = applied # changed
+            diagnostics[i] = applied
         end
         i += 1
     end
@@ -611,7 +643,8 @@ end
 
 function notify_diagnostics!(server::Server, uri2diagnostics::URI2Diagnostics)
     for (uri, diagnostics) in uri2diagnostics
-        apply_diagnostic_config!(diagnostics, server.state.config_manager)
+        root_path = isdefined(server.state, :root_path) ? server.state.root_path : nothing
+        apply_diagnostic_config!(diagnostics, server.state.config_manager, uri, root_path)
         send(server, PublishDiagnosticsNotification(;
             params = PublishDiagnosticsParams(;
                 uri,
@@ -724,7 +757,8 @@ function handle_DocumentDiagnosticRequest(server::Server, msg::DocumentDiagnosti
     else
         diagnostics = parsed_stream_to_diagnostics(file_info)
     end
-    apply_diagnostic_config!(diagnostics, server.state.config_manager)
+    root_path = isdefined(server.state, :root_path) ? server.state.root_path : nothing
+    apply_diagnostic_config!(diagnostics, server.state.config_manager, uri, root_path)
     return send(server,
         DocumentDiagnosticResponse(;
             id = msg.id,

src/types.jl

@@ -381,6 +381,7 @@ struct DiagnosticPattern <: ConfigSection
     match_by::String
     match_type::String
     severity::Int
+    path::Maybe{Glob.FilenameMatch{String}}
 end
 @define_eq_overloads DiagnosticPattern