filenameslinter

README

filenameslinter

Questo progetto è un pacchetto Go (e relativa CLI) per il controllo sistematico dei nomi dei file. Ulteriori informazioni sono disponibili presso la nostra wiki.

Documentation

Index

• func CheckDir(synta *synta.Synta, fs fs.FS, dirPath string, opts *Options) []error
• func CheckName(synta synta.Synta, name string, isDir bool) (err error)
• func ReadDir(fsys fs.FS, name string) ([]fs.DirEntry, error)
• type Options
• type RegexMatchError
  • func (e RegexMatchError) Error() string

Functions

func CheckDir

func CheckDir(synta *synta.Synta, fs fs.FS, dirPath string, opts *Options) []error

func CheckName

func CheckName(synta synta.Synta, name string, isDir bool) (err error)

func ReadDir

func ReadDir(fsys fs.FS, name string) ([]fs.DirEntry, error)

ReadDir uses the `readDir` method if the filesystem implements `fs.ReadDirFS`, otherwise opens the path and parses it using the `ReadDirFile` interface.

Types

type Options

type Options struct {
	Recursive         bool
	EnsureKebabCasing bool
	IgnoreDotfiles    bool
	FailFast          bool
}

type RegexMatchError

type RegexMatchError struct {
	Regexp   string
	Filename string
	Path     string
}

func (RegexMatchError) Error

func (e RegexMatchError) Error() string