package glob

import "github.com/gohugoio/hugo/hugofs/glob"

Index

Functions

func FilterGlobParts

func FilterGlobParts(a []string) []string

FilterGlobParts removes any string with glob wildcard.

func GetGlob

func GetGlob(pattern string) (glob.Glob, error)

func HasGlobChar

func HasGlobChar(s string) bool

HasGlobChar returns whether s contains any glob wildcards.

func NormalizePath

func NormalizePath(p string) string

func NormalizePathNoLower

func NormalizePathNoLower(p string) string

func Or

func Or(globs ...glob.Glob) glob.Glob

Or creates a new Glob from the given globs.

func ResolveRootDir

func ResolveRootDir(p string) string

ResolveRootDir takes a normalized path on the form "assets/**.json" and determines any root dir, i.e. any start path without any wildcards.

Types

type FilenameFilter

type FilenameFilter struct {
	// contains filtered or unexported fields
}

func MustNewFilenameFilter

func MustNewFilenameFilter(inclusions, exclusions []string) *FilenameFilter

MustNewFilenameFilter invokes NewFilenameFilter and panics on error.

func NewFilenameFilter

func NewFilenameFilter(inclusions, exclusions []string) (*FilenameFilter, error)

NewFilenameFilter creates a new Glob where the Match method will return true if the file should be included. Note that the inclusions will be checked first.

func NewFilenameFilterForInclusionFunc

func NewFilenameFilterForInclusionFunc(shouldInclude func(filename string) bool) *FilenameFilter

NewFilenameFilterForInclusionFunc create a new filter using the provided inclusion func.

func (*FilenameFilter) Append

func (f *FilenameFilter) Append(other *FilenameFilter) *FilenameFilter

Append appends a filter to the chain. The receiver will be copied if needed.

func (*FilenameFilter) Match

func (f *FilenameFilter) Match(filename string, isDir bool) bool

Match returns whether filename should be included.

type MatchesFunc

type MatchesFunc func(s string) bool

MatchesFunc is a convenience type to create a glob.Glob from a function.

func (MatchesFunc) Match

func (m MatchesFunc) Match(s string) bool

Source Files

filename_filter.go glob.go

Version
v0.144.2 (latest)
Published
Feb 19, 2025
Platform
linux/amd64
Imports
8 packages
Last checked
13 hours ago

Tools for package owners.