yamlfmt

Jan 10, 2025

Changes in this version

+ const DefaultPatternFile

+ type MatchType string

+ const MatchTypeDoublestar

+ const MatchTypeGitignore

+ const MatchTypeStandard

+ type PatternFileCollector struct

+ func NewPatternFileCollector(files ...string) (*PatternFileCollector, error)

+ func NewPatternFileCollectorFS(r io.Reader, fs fs.FS) *PatternFileCollector

+ func (c *PatternFileCollector) CollectPaths() ([]string, error)

Jun 24, 2024

Changes in this version

type Formatter

+ ConfigMap func() (map[string]any, error)

type Operation

+ const OperationPrintConfig

May 3, 2024

Changes in this version

+ type Operation int

+ const OperationDry

+ const OperationFormat

+ const OperationLint

+ const OperationStdin

Feb 10, 2024

Changes in this version

+ func ExcludeWithGitignore(gitignorePath string, paths []string) ([]string, error)

Apr 2, 2023

Changes in this version

+ const MetadataIdentifier

+ var ErrMalformedMetadata = errors.New("metadata: malformed string")

+ var ErrUnrecognizedMetadata = errors.New("metadata: unrecognized type")

+ func IsMetadataType(mdValueStr string) bool

+ func ReadMetadata(content []byte, path string) (collections.Set[Metadata], collections.Errors)

+ type BasicContentAnalyzer struct

+ RegexPatterns []*regexp.Regexp

+ func NewBasicContentAnalyzer(patterns []string) (BasicContentAnalyzer, error)

+ func (a BasicContentAnalyzer) ExcludePathsByContent(paths []string) ([]string, []string, error)

+ type ContentAnalyzer interface

+ ExcludePathsByContent func(paths []string) ([]string, []string, error)

+ type Metadata struct

+ LineNum int

+ Type MetadataType

+ type MetadataError struct

+ func (e *MetadataError) Error() string

+ func (e *MetadataError) Unwrap() error

+ type MetadataType string

+ const MetadataIgnore

Mar 18, 2023

Changes in this version

+ type Engine interface

+ DryRun func(paths []string) (*EngineOutput, error)

+ Format func(paths []string) error

+ FormatContent func(content []byte) ([]byte, error)

+ Lint func(paths []string) (*EngineOutput, error)

+ type EngineOutput struct

+ Files FileDiffs

+ Message string

+ Quiet bool

+ func (eo *EngineOutput) String() string

+ type FileDiff struct

+ Diff *FormatDiff

+ Path string

+ func (fd *FileDiff) Apply() error

+ func (fd *FileDiff) StrOutput() string

+ func (fd *FileDiff) StrOutputQuiet() string

+ type FileDiffs map[string]*FileDiff

+ func (fds FileDiffs) Add(diff *FileDiff) error

+ func (fds FileDiffs) ApplyAll() error

+ func (fds FileDiffs) ChangedCount() int

+ func (fds FileDiffs) StrOutput() string

+ func (fds FileDiffs) StrOutputQuiet() string

+ type FormatDiff struct

+ Formatted string

+ LineSep string

+ Original string

+ func (d *FormatDiff) Changed() bool

+ func (d *FormatDiff) MultilineDiff() (string, int)

Jan 8, 2023

Changes in this version

+ type DoublestarCollector struct

+ Exclude []string

+ Include []string

+ func (c *DoublestarCollector) CollectPaths() ([]string, error)

+ type FilepathCollector struct

+ Exclude []string

+ Extensions []string

+ Include []string

+ func (c *FilepathCollector) CollectPaths() ([]string, error)

+ type PathCollector interface

+ CollectPaths func() ([]string, error)

Sep 22, 2022

Changes in this version

type Factory

+ NewFormatter func(config map[string]interface{}) (Formatter, error)

+ type LineBreakStyle string

+ func (s LineBreakStyle) Separator() (string, error)

+ type UnsupportedLineBreakError struct

+ func (e UnsupportedLineBreakError) Error() string

Sep 19, 2022

Changes in this version

+ type Feature struct

+ AfterAction FeatureFunc

+ BeforeAction FeatureFunc

+ Name string

+ type FeatureApplyError struct

+ func (e *FeatureApplyError) Error() string

+ func (e *FeatureApplyError) Unwrap() error

+ type FeatureApplyMode string

+ var FeatureApplyAfter FeatureApplyMode = "after"

+ var FeatureApplyBefore FeatureApplyMode = "before"

+ type FeatureFunc func([]byte) ([]byte, error)

+ type FeatureList []Feature

+ func (fl FeatureList) ApplyFeatures(input []byte, mode FeatureApplyMode) ([]byte, error)

Aug 27, 2022

Changes in this version

+ const LineBreakStyleCRLF

+ const LineBreakStyleLF

Aug 22, 2022

Changes in this version

+ type Factory interface

+ NewDefault func() Formatter

+ NewWithConfig func(config map[string]interface{}) (Formatter, error)

+ Type func() string

+ type Formatter interface

+ Format func(yamlContent []byte) ([]byte, error)

+ Type func() string

+ type Registry struct

+ func NewFormatterRegistry(defaultFactory Factory) *Registry

+ func (r *Registry) Add(f Factory)

+ func (r *Registry) GetDefaultFactory() (Factory, error)

+ func (r *Registry) GetFactory(fType string) (Factory, error)