glob

README

glob

Glob utilities built on top of the well-tested gobwas/glob.

Features

• Supports wildcard globs like **
• Faster matching and walking by pulling out the non-wildcard parts of a glob (e.g. /posts/ in /posts/**)
• Supports globs like {posts/**,tags/**} by pre-expanding globs.

Install

go get github.com/matthewmueller/glob

Example

package main

import (
	"github.com/matthewmueller/glob"
)

func main() {
	files, _ := glob.Match("[A-Z]*.md")
	for _, file := range files {
		fmt.Println(file)
	}
	// Output:
	// Changelog.md
	// License.md
	// Readme.md
}

Contributors

• Matt Mueller (@mattmueller)

License

MIT

Documentation

Index

• func Base(pattern string) string
• func Match(glob string) (matches []string, err error)
• func MatchFS(fsys fs.FS, glob string) (matches []string, err error)
• func Walk(pattern string, fn fs.WalkDirFunc) error
• func WalkFS(fsys fs.FS, pattern string, fn fs.WalkDirFunc) error
• type Matcher
  • func Compile(pattern string, separators ...rune) (Matcher, error)

Examples

• Match

Functions

func Base

func Base(pattern string) string

Base gets the non-magical part of the glob

func Match

func Match(glob string) (matches []string, err error)

Match is conceptually similar to filepath.Glob, but it uses the glob package from github.com/gobwas/glob, which supports more advanced globbing patterns.

Example

package main

import (
	"fmt"

	"github.com/matthewmueller/glob"
)

func main() {
	files, err := glob.Match("[A-Z]*.md")
	if err != nil {
		fmt.Println(err)
	}

	for _, file := range files {
		fmt.Println(file)
	}

}

Output:

Changelog.md
License.md
Readme.md

func MatchFS

func MatchFS(fsys fs.FS, glob string) (matches []string, err error)

MatchFS matches a pattern against an abstract filesystem

func Walk

func Walk(pattern string, fn fs.WalkDirFunc) error

Walk the files

func WalkFS

func WalkFS(fsys fs.FS, pattern string, fn fs.WalkDirFunc) error

WalkFS walks an abstract abstract filesystem, matching on the pattern

Types

type Matcher

type Matcher = glob.Glob

func Compile

func Compile(pattern string, separators ...rune) (Matcher, error)

Comple a glob pattern into a matcher