finder

Finder

Finder is a simple Go package for searching files and directories based on patterns in a specified directory. It also supports excluding certain files or directories and provides flexible configuration options for the search.

Versions

Installation

If you are using Go modules, you can add this package to your project by running:

go get -u github.com/gouef/finder

Usage

Basic File and Directory Search

package main

import (
	"fmt"
	"github.com/gouef/finder"
)

func main() {
	// Search for all files in the current directory and its subdirectories
	files := finder.New().In(".").FindFiles("*.go").Get()

	// Print the found files
	for _, file := range files {
		fmt.Println(file.Name())
	}
}

Filtering Files by Pattern

You can search for files or directories by specifying patterns using FindFiles or FindDirectories:

// Search for .txt files in the current directory and subdirectories
files := finder.New().In(".").FindFiles("*.txt").Get()

Excluding Files and Directories

You can exclude specific files or directories from the search results using the Exclude function:

// Search for .txt files, but exclude "test1.txt"
files := finder.New().In(".").FindFiles("*.txt").Exclude("test1.txt").Get()

Searching for Directories

If you want to search for directories instead of files:

// Search for directories in the current directory and subdirectories
dirs := finder.New().In(".").FindDirectories("*").Get()

Functions

• New() – Creates a new instance of Finder.
• In(dirs ...string) – Specifies the directories to search in.
• Find(patterns ...string) – Searches for both files and directories based on the given patterns.
• FindFiles(patterns ...string) – Searches only for files matching the given patterns.
• FindDirectories(patterns ...string) – Searches only for directories matching the given patterns.
• Exclude(patterns ...string) – Excludes files and directories matching the given patterns from the search results.
• Get() – Retrieves the search results.

Example

package main

import (
	"fmt"
	"github.com/gouef/finder"
)

func main() {
	// Search for .go files and exclude "main.go"
	files := finder.FindFiles("*.go").In(".").Exclude("main.go").Get()

	// Print the found files
	for _, file := range files {
		fmt.Println(file.Name())
	}
}

Global Function

Match

Extending filepath.Match, but yout can use multiple patterns.

package main

import (
	"fmt"
	"github.com/gouef/finder"
)

func main() {
    files := finder.FindFiles("*.go").In(".").Exclude("main.go").Get()
}

DirectoryHash(path string) (string, error)

Get hash (md5) for directory, good for checking if something was changed.

package main

import (
	"fmt"
	"github.com/gouef/finder"
)

func main() {
	hash, err := finder.DirectoryHash("./directory")
	if err != nil {
		fmt.Println("Error:", err)
		return
	}
	fmt.Println("MD5 hash of directory:", hash)
}

DirectoryFilesHash(path string) (map[string]string, error)

Get hashes (md5) for every file in directory

package main

import (
	"fmt"
	"github.com/gouef/finder"
)

func main() {
	hashes, err := finder.DirectoryFilesHash("./directory")
	if err != nil {
		fmt.Println("Error:", err)
		return
	}
	
	for filePath, fileHash := range hashes {
		fmt.Println("MD5 hash of file:", filePath, " ", fileHash)
	}
}

FileHash(path string) (string, error)

Get hash (md5) for single file

package main

import (
	"fmt"
	"github.com/gouef/finder"
)

func main() {
	hash, err := finder.FileHash("./directory/file.txt")
	if err != nil {
		fmt.Println("Error:", err)
		return
	}
	
    fmt.Println("MD5 hash of file:", hash)
}

Contributing

Read Contributing

Contributors

Join our Discord Community! 🎉

Click above to join our community on Discord!