feat: add support for well known files

Related to #135

Author: ccoVeille

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
 }
 
@@ -52,6 +53,7 @@ var TomlFileType = FileType{
 var IniFileType = FileType{
 	Name:       "ini",
 	Extensions: misc.ArrToMap("ini"),
+	KnownFiles: misc.ArrToMap(".editorconfig", ".gitconfig", ".gitmodules", ".shellcheckrc", ".npmrc", "inputrc", ".inputrc", ".wgetrc", ".curlrc", ".nanorc"),
 	Validator:  validator.IniValidator{},
 }
 

pkg/finder/finder_test.go

@@ -133,6 +133,30 @@ func Test_fsFinderCustomTypes(t *testing.T) {
 	}
 }
 
+func Test_fsFinderKnownFiles(t *testing.T) {
+	jsonFileType := filetype.FileType{
+		Name:       "json",
+		Extensions: misc.ArrToMap("whatever"),
+		KnownFiles: misc.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.Errorf("Unable to find files")
+	}
+
+	if err != nil {
+		t.Errorf("Unable to find files")
+	}
+}
+
 func Test_fsFinderPathNoExist(t *testing.T) {
 	fsFinder := FileSystemFinderInit(
 		WithPathRoots("/bad/path"),

pkg/finder/fsfinder.go

@@ -128,13 +128,21 @@ func (fsf FileSystemFinder) findOne(pathRoot string) ([]FileMetadata, error) {
 				// 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), ".")
 
 				if _, ok := fsf.ExcludeFileTypes[walkFileExtension]; ok {
 					return nil
 				}
 				extensionLowerCase := strings.ToLower(walkFileExtension)
 				for _, fileType := range fsf.FileTypes {
+
+					if _, ok := fileType.KnownFiles[walkFileName]; ok {
+						fileMetadata := FileMetadata{dirEntry.Name(), path, fileType}
+						matchingFiles = append(matchingFiles, fileMetadata)
+						break
+					}
+
 					if _, ok := fileType.Extensions[extensionLowerCase]; ok {
 						fileMetadata := FileMetadata{dirEntry.Name(), path, fileType}
 						matchingFiles = append(matchingFiles, fileMetadata)

test/fixtures/.editorconfig

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