compactor

Documentation

Index

• Variables
• func AddPlugin(plugin *Plugin)
• func Append(path string, root string) error
• func Index(path string) error
• func IndexBundles() error
• func IndexItems(root string) error
• func IndexRelated() error
• func Process(bundle *Bundle) error
• func Remove(path string)
• func RemovePlugin(namespace string)
• func SetBundles(bundles []*Bundle)
• func Update(path string) error
• type Bundle
  • func GetBundle(path string) *Bundle
  • func GetBundles() []*Bundle
  • func (b *Bundle) CleanPath(file string) string
  • func (b *Bundle) MatchPatterns(file string, patterns []string) bool
  • 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) 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
• type Compress
• type DeleteFunc
• type Destination
• type ExecuteFunc
• type InitFunc
• type Item
  • func Get(path string) *Item
  • func Matches(callback func(item *Item) bool) []*Item
• type OptimizeFunc
• type Plugin
  • func GetPlugin(extension string) *Plugin
• type Progressive
• type Related
• type RelatedFunc
• type ResolveFunc
• 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 AddPlugin

func AddPlugin(plugin *Plugin)

AddPlugin add a new plugin to the index

func Append

func Append(path string, root string) error

Append file path information to index

func Index

func Index(path string) error

Index add path files to the index, resolve related and create bundles

func IndexBundles

func IndexBundles() error

IndexBundles creates and retrieve every possible bundle with current index

func IndexItems

func IndexItems(root string) error

IndexItems walks on path and add files to the index

func IndexRelated

func IndexRelated() error

IndexRelated detect the related assets on the index

func Process

func Process(bundle *Bundle) error

Process execute bundle packaging by running plugin

func Remove

func Remove(path string)

Remove item information from index if match file path

func RemovePlugin

func RemovePlugin(namespace string)

RemovePlugin removes all plugins from index that match the given namespace

func SetBundles

func SetBundles(bundles []*Bundle)

SetBundles renew the index of bundles with a new list

func Update

func Update(path string) error

Update item information on index if match file path

Types

type Bundle

type Bundle struct {
	Extension   string
	Item        *Item
	Source      Source
	Destination Destination
	Compress    Compress
	SourceMap   SourceMap
	Progressive Progressive
}

Bundle struct

func GetBundle

func GetBundle(path string) *Bundle

GetBundle retrieve the related bundle for the file

func GetBundles

func GetBundles() []*Bundle

GetBundles retrieve all bundles in the index

func (*Bundle) CleanPath

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

CleanPath return the clean file, without source and destination path

func (*Bundle) MatchPatterns

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

MatchPatterns return if file match one of the given patterns

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) ToDestination

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

ToDestination transform and return the full destination path for file

func (*Bundle) ToExtension

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

ToExtension return a file converted to a specific extension

func (*Bundle) ToHashed

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

ToHashed return a file converted to a hashed name to avoid caching

func (*Bundle) ToNonHashed

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

ToNonHashed return a file converted back to a non hashed name

func (*Bundle) ToSource

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

ToSource transform and return the full source path for file

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
	Hashed bool
}

Destination struct

type ExecuteFunc

type ExecuteFunc = func(bundle *Bundle) error

Execute function

type InitFunc

type InitFunc = func(bundle *Bundle) error

Init function

type Item

type Item struct {
	Path       string      // Full path (root + location)
	Root       string      // Root location
	Location   string      // Location from root
	Folder     string      // Location folder
	File       string      // File name with extension
	Name       string      // File name
	Extension  string      // File Extension
	Content    string      // File content
	Permission fs.FileMode // File permissions
	Exists     bool        // File exists flag
	Checksum   string      // Current Checksum
	Previous   string      // Previous Checksum
	Related    []Related   // Related items
}

Item struct

func Get

func Get(path string) *Item

Get the item that match file path on index

func Matches

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

Matches run callback on index and append item if match

type OptimizeFunc

type OptimizeFunc = func(bundle *Bundle) error

Optimize function

type Plugin

type Plugin struct {
	Namespace  string
	Extensions []string
	Init       InitFunc
	Related    RelatedFunc
	Resolve    ResolveFunc
	Execute    ExecuteFunc
	Optimize   OptimizeFunc
	Delete     DeleteFunc
}

Plugin struct

func GetPlugin

func GetPlugin(extension string) *Plugin

GetPlugin retrieves the first found plugin for the given extension

type Progressive

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

Progressive struct

type Related

type Related struct {
	Type       string
	Dependency bool
	Source     string
	Path       string
	Item       *Item
}

Related struct

type RelatedFunc

type RelatedFunc = func(item *Item) ([]Related, error)

Related function

type ResolveFunc

type ResolveFunc = func(file string, item *Item) (string, error)

Resolve 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