compactor

Documentation

Index

• Variables
• func Append(path string) error
• func Index(path string) error
• func Map(files []string, dependencies []string, destination string)
• func Process(bundle *Bundle) error
• func Register(plugin *Plugin)
• func Remove(path string)
• func Unregister(extension string)
• func Update(path string) error
• type Bundle
  • func GetBundleFor(path string) *Bundle
  • func GetBundleFromMapper(mapper *Mapper) *Bundle
  • func GetBundles() []*Bundle
  • func NewBundle() *Bundle
  • func (b *Bundle) CleanPath(file string) string
  • func (b *Bundle) Deleted(path string)
  • func (b *Bundle) Ignored(path string)
  • func (b *Bundle) MatchPatterns(file string, patterns []string) bool
  • func (b *Bundle) Processed(path string)
  • func (b *Bundle) ShouldCompress(file string) bool
  • func (b *Bundle) ShouldGenerateProgressive(file string) bool
  • func (b *Bundle) ShouldGenerateSourceMap(file string) bool
  • func (b *Bundle) ShouldInclude(file string) bool
  • func (b *Bundle) ShouldOutputToMany() bool
  • func (b *Bundle) Skipped(path string)
  • func (b *Bundle) ToDestination(file string) string
  • func (b *Bundle) ToExtension(file string, extension string) string
  • func (b *Bundle) ToHashed(file string, hash string) string
  • func (b *Bundle) ToNonHashed(file string, hash string) string
  • func (b *Bundle) ToSource(file string) string
  • func (b *Bundle) Written(path string)
• type Compress
• type DeleteFunc
• type Destination
• type InitFunc
• type Item
  • func Get(path string) *Item
  • func Matches(callback func(item *Item) bool) []*Item
• type Logs
• type Mapper
• type Plugin
• type Progressive
• type ResolveFunc
• type RunFunc
• type Source
• type SourceMap

Variables

var Default = &Bundle{
	Destination: Destination{
		Hashed: true,
	},
	Compress: Compress{
		Enabled: true,
	},
	SourceMap: SourceMap{
		Enabled: true,
	},
	Progressive: Progressive{
		Enabled: true,
	},
}

Default bundle model

Functions

func Append

func Append(path string) error

Append file path information to indexer

func Index

func Index(path string) error

Index walks on path and add files to the indexer

func Map

func Map(files []string, dependencies []string, destination string)

Map add a new map registration

func Process

func Process(bundle *Bundle) error

Process package by running processors

func Register

func Register(plugin *Plugin)

Register add a new plugin to the index

func Remove

func Remove(path string)

Remove item information from indexer if match file path

func Unregister

func Unregister(extension string)

Unregister removes all plugins that match the given extension

func Update

func Update(path string) error

Update item information on indexer if match file path

Types

type Bundle

type Bundle struct {
	Extension   string
	Items       []*Item
	Source      Source
	Destination Destination
	Compress    Compress
	SourceMap   SourceMap
	Progressive Progressive
	Logs        Logs
}

Bundle struct

func GetBundleFor

func GetBundleFor(path string) *Bundle

GetBundleFor retrieve the related bundle for the file

func GetBundleFromMapper

func GetBundleFromMapper(mapper *Mapper) *Bundle

GetBundleFromMapper retrieve the final bundle from given mapper

func GetBundles

func GetBundles() []*Bundle

GetBundles retrieve every possible bundle with current indexer

func NewBundle

func NewBundle() *Bundle

NewBundle create and retrieve a new bundle

func (*Bundle) CleanPath

func (b *Bundle) CleanPath(file string) string

Return the clean file, without source and destination path

func (*Bundle) Deleted

func (b *Bundle) Deleted(path string)

Deleted append path to deleted list

func (*Bundle) Ignored

func (b *Bundle) Ignored(path string)

Ignored append path to ignored list

func (*Bundle) MatchPatterns

func (b *Bundle) MatchPatterns(file string, patterns []string) bool

MatchPatterns return if file match one of the given patterns

func (*Bundle) Processed

func (b *Bundle) Processed(path string)

Processed append path to processed list

func (*Bundle) ShouldCompress

func (b *Bundle) ShouldCompress(file string) bool

ShouldCompress return if compress should be enabled for given file

func (*Bundle) ShouldGenerateProgressive

func (b *Bundle) ShouldGenerateProgressive(file string) bool

ShouldGenerateProgressive return if progressive formats should be generated for given file

func (*Bundle) ShouldGenerateSourceMap

func (b *Bundle) ShouldGenerateSourceMap(file string) bool

ShouldGenerateSourceMap return if source map should be generated for given file

func (*Bundle) ShouldInclude

func (b *Bundle) ShouldInclude(file string) bool

ShouldInclude return if file should be included on the bundle

func (*Bundle) ShouldOutputToMany

func (b *Bundle) ShouldOutputToMany() bool

Detect if bundle should output to multiple destinations

func (*Bundle) Skipped

func (b *Bundle) Skipped(path string)

Skipped append path to skipped list

func (*Bundle) ToDestination

func (b *Bundle) ToDestination(file string) string

Transform and return the full destination path for file

func (*Bundle) ToExtension

func (b *Bundle) ToExtension(file string, extension string) string

Return a file converted to a specific extension

func (*Bundle) ToHashed

func (b *Bundle) ToHashed(file string, hash string) string

Return a file converted to a hashed name to avoid caching

func (*Bundle) ToNonHashed

func (b *Bundle) ToNonHashed(file string, hash string) string

Return a file converted back to a non hashed name

func (*Bundle) ToSource

func (b *Bundle) ToSource(file string) string

Transform and return the full source path for file

func (*Bundle) Written

func (b *Bundle) Written(path string)

Written append path to written list

type Compress

type Compress struct {
	Enabled bool
	Include []string
	Exclude []string
}

Compress struct

type DeleteFunc

type DeleteFunc = func(bundle *Bundle) error

Delete function

type Destination

type Destination struct {
	Path   string
	Folder string
	File   string
	Hashed bool
}

Destination struct

type InitFunc

type InitFunc = func(bundle *Bundle) error

Init function

type Item

type Item struct {
	Path       string
	Folder     string
	File       string
	Name       string
	Extension  string
	Content    string
	Permission fs.FileMode
	Exists     bool
	Checksum   string
	Previous   string
}

Item struct

func Get

func Get(path string) *Item

Get the item that match file path on indexer

func Matches

func Matches(callback func(item *Item) bool) []*Item

Matches run callback on indexer and append item if match

type Logs

type Logs struct {
	Processed []string
	Skipped   []string
	Ignored   []string
	Written   []string
	Deleted   []string
}

Logs struct

type Mapper

type Mapper struct {
	Files        []string
	Dependencies []string
	Destination  string
}

Mapper struct

type Plugin

type Plugin struct {
	Extensions []string
	Init       InitFunc
	Run        RunFunc
	Delete     DeleteFunc
	Resolve    ResolveFunc
}

Plugin struct

type Progressive

type Progressive struct {
	Enabled bool
	Include []string
	Exclude []string
}

Compress struct

type ResolveFunc

type ResolveFunc = func(file string) (string, error)

Resolve function

type RunFunc

type RunFunc = func(bundle *Bundle) error

Run function

type Source

type Source struct {
	Path    string
	Include []string
	Exclude []string
}

Source struct

type SourceMap

type SourceMap struct {
	Enabled bool
	Include []string
	Exclude []string
}

SourceMap struct