feat: add support for well known files

Author: ccoVeille

CHANGELOG.md

@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+### Added
+
+- Support of well known files for configuration discovery
+
 ## [1.9.0] - 2025-11-14
 
 ### Added

pkg/filetype/file_type.go

@@ -12,6 +12,7 @@ import (
 type FileType struct {
 	Name       string
 	Extensions map[string]struct{}
+	KnownFiles map[string]struct{}
 	Validator  validator.Validator
 }
 
@@ -28,7 +29,13 @@ var JSONFileType = FileType{
 var YAMLFileType = FileType{
 	Name:       "yaml",
 	Extensions: tools.ArrToMap("yml", "yaml"),
-	Validator:  validator.YAMLValidator{},
+	KnownFiles: tools.ArrToMap(
+		".clang-format",
+		".clang-tidy",
+		".clangd",
+		".gemrc",
+	),
+	Validator: validator.YAMLValidator{},
 }
 
 // Instance of FileType object to
@@ -52,7 +59,21 @@ var TomlFileType = FileType{
 var IniFileType = FileType{
 	Name:       "ini",
 	Extensions: tools.ArrToMap("ini"),
-	Validator:  validator.IniValidator{},
+	KnownFiles: tools.ArrToMap(
+		".editorconfig",
+		".gitconfig",
+		".gitmodules",
+		".shellcheckrc",
+		".npmrc",
+		"inputrc",
+		".inputrc",
+		".wgetrc",
+		".curlrc",
+		".nanorc",
+		".flake8",
+		".pylintrc",
+	),
+	Validator: validator.IniValidator{},
 }
 
 // Instance of FileType object to

pkg/finder/finder_test.go

@@ -131,6 +131,30 @@ func Test_fsFinderCustomTypes(t *testing.T) {
 	}
 }
 
+func Test_fsFinderKnownFiles(t *testing.T) {
+	jsonFileType := filetype.FileType{
+		Name:       "json",
+		Extensions: tools.ArrToMap("whatever"),
+		KnownFiles: tools.ArrToMap(".editorconfig"),
+		Validator:  validator.JSONValidator{},
+	}
+	fsFinder := FileSystemFinderInit(
+		WithPathRoots("../../test/fixtures"),
+		WithExcludeDirs([]string{"subdir"}),
+		WithFileTypes([]filetype.FileType{jsonFileType}),
+	)
+
+	files, err := fsFinder.Find()
+
+	if len(files) < 1 {
+		t.Error("Unable to find files")
+	}
+
+	if err != nil {
+		t.Error("Unable to find files")
+	}
+}
+
 func Test_fsFinderPathNoExist(t *testing.T) {
 	fsFinder := FileSystemFinderInit(
 		WithPathRoots("/bad/path"),

pkg/finder/fsfinder.go

@@ -128,6 +128,8 @@ func (fsf FileSystemFinder) findOne(pathRoot string, seenMap map[string]struct{}
 			if !dirEntry.IsDir() {
 				// filepath.Ext() returns the extension name with a dot so it
 				// needs to be removed.
+
+				walkFileName := filepath.Base(path)
 				walkFileExtension := strings.TrimPrefix(filepath.Ext(path), ".")
 				extensionLowerCase := strings.ToLower(walkFileExtension)
 
@@ -136,20 +138,25 @@ func (fsf FileSystemFinder) findOne(pathRoot string, seenMap map[string]struct{}
 				}
 
 				for _, fileType := range fsf.FileTypes {
-					if _, isMatched := fileType.Extensions[extensionLowerCase]; isMatched {
-						absPath, err := filepath.Abs(path)
-						if err != nil {
-							return err
-						}
-
-						if _, seen := seenMap[absPath]; !seen {
-							fileMetadata := FileMetadata{dirEntry.Name(), absPath, fileType}
-							matchingFiles = append(matchingFiles, fileMetadata)
-							seenMap[absPath] = struct{}{}
-						}
-
-						return nil
+					_, isKnownFile := fileType.KnownFiles[walkFileName]
+					_, hasExtension := fileType.Extensions[extensionLowerCase]
+
+					if !isKnownFile && !hasExtension {
+						continue
+					}
+
+					absPath, err := filepath.Abs(path)
+					if err != nil {
+						return err
 					}
+
+					if _, seen := seenMap[absPath]; !seen {
+						fileMetadata := FileMetadata{dirEntry.Name(), absPath, fileType}
+						matchingFiles = append(matchingFiles, fileMetadata)
+						seenMap[absPath] = struct{}{}
+					}
+
+					return nil
 				}
 				fsf.ExcludeFileTypes[extensionLowerCase] = struct{}{}
 			}

test/fixtures/.editorconfig

@@ -0,0 +1,6 @@
+# https://editorconfig.org
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf