Skip to content

Fix crash with file globbing matching micro option names #4044

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

Open
JoeKar wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Fix crash with file globbing matching micro option names #4044

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bcd6c81
settings: Don't return maps with `ParsedSettings()`
JoeKar Mar 16, 2026
fbbedc7
settings: Add `glob:` as prefix for file globbing maps
JoeKar Mar 14, 2026
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
20 changes: 16 additions & 4 deletions internal/config/settings.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,11 +186,19 @@ func validateParsedSettings() error {
}
}
} else {
if _, e := glob.Compile(k); e != nil {
err = errors.New("Error with glob setting " + k + ": " + e.Error())
tk := strings.TrimPrefix(k, "glob:")
if _, e := glob.Compile(tk); e != nil {
err = errors.New("Error with glob setting " + tk + ": " + e.Error())
delete(parsedSettings, k)
continue
}
if !strings.HasPrefix(k, "glob:") {
// Support non-prefixed glob settings but internally convert
// them to prefixed ones for simplicity.
delete(parsedSettings, k)
k = "glob:" + k
parsedSettings[k] = v
}
for k1, v1 := range v.(map[string]any) {
if _, ok := defaults[k1]; ok {
if e := verifySetting(k1, v1, defaults[k1]); e != nil {
Expand Down Expand Up @@ -256,6 +264,9 @@ func ReadSettings() error {
func ParsedSettings() map[string]any {
s := make(map[string]any)
for k, v := range parsedSettings {
if strings.HasPrefix(reflect.TypeOf(v).String(), "map") {
continue
}
s[k] = v
}
return s
Expand Down Expand Up @@ -309,8 +320,9 @@ func InitGlobalSettings() error {
// Must be called after ReadSettings
func UpdatePathGlobLocals(settings map[string]any, path string) {
for k, v := range parsedSettings {
if strings.HasPrefix(reflect.TypeOf(v).String(), "map") && !strings.HasPrefix(k, "ft:") {
g, _ := glob.Compile(k)
if strings.HasPrefix(reflect.TypeOf(v).String(), "map") && strings.HasPrefix(k, "glob:") {
tk := strings.TrimPrefix(k, "glob:")
g, _ := glob.Compile(tk)
if g.MatchString(path) {
for k1, v1 := range v.(map[string]any) {
settings[k1] = v1
Expand Down
18 changes: 18 additions & 0 deletions runtime/help/options.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -669,6 +669,21 @@ all files except Go files, and `tabsize` 4 for all files except Ruby files:

Or similarly you can match with globs:

```json
{
"glob:*.go": {
"tabstospaces": false
},
"glob:*.rb": {
"tabsize": 2
},
"tabstospaces": true,
"tabsize": 4
}
```

The old non-prefixed glob format is still supported (but internally converted):
Copy link
Collaborator

@dmaluka dmaluka Mar 19, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This wording sounds like the reader already knows what "old non-prefixed format" this is referring to. As always, put yourself in a position of a reader who is not already familiar with the stuff we are documenting.

And what exactly is the reader supposed to do with "but internally converted"?

...How about:

You can also omit the `glob:` prefix before globs:

...

But it is generally more recommended to use the `glob:` prefix, as it avoids
potential conflicts with option names.


```json
{
"*.go": {
Expand All @@ -681,3 +696,6 @@ Or similarly you can match with globs:
"tabsize": 4
}
```

Although it is less verbose, `glob:` is generally more reliable since it avoids
conflicts with option names.
Loading