globs

README

globs - glob pattern matching utilities

globs provides simple utilties for working with glob-style pattern matching.

Installation

> go get github.com/go-corelibs/globs@latest

Examples

Parse, Match, Find

func main() {
    list, err := Parse("*.go", "*.txt")
    // err == nil
    // list.String() == `["*.go"]`
    if matched, _ := list[0].Match("source.go"); matched {
        // specifically matched with the first glob in the list
    }
    if matched := list.Match("source.go"); matched {
        // one of the globs in the list has matched
    }
    if matched := list.Find("sournce.go"); matched != nil {
        // matched is the *glob.Glob instance that matched the input
    }
}

Go-CoreLibs

Go-CoreLibs is a repository of shared code between the Go-Curses and Go-Enjin projects.

License

Copyright 2024 The Go-CoreLibs Authors

Licensed under the Apache License, Version 2.0 (the "License");
you may not use file except in compliance with the License.
You may obtain a copy of the license at

 http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Documentation

Overview

Package globs provides glob pattern matching utilities

Index

• type Globs
  • func Parse(patterns ...string) (globs Globs, err error)
  • func (s Globs) Find(input string) (matched *glob.Glob)
  • func (s Globs) Match(input string) (matched bool)
  • func (s Globs) String() (list string)

Types

type Globs

type Globs []*glob.Glob

Globs is a slice of compiled glob patterns

func Parse

func Parse(patterns ...string) (globs Globs, err error)

Parse creates and tests new glob instances for each pattern given, stopping and returning upon first error encountered

func (Globs) Find

func (s Globs) Find(input string) (matched *glob.Glob)

Find returns the first glob that matches the given input

func (Globs) Match

func (s Globs) Match(input string) (matched bool)

Match returns true if one of the globs matches the given input

func (Globs) String

func (s Globs) String() (list string)

String implements the fmt.Stringer interface, outputting the list of globs in a JSON string array format