README
¶
beego-pipeline
Asset compilation and compression for golang beego framework inspired by django-pipeline.
Requirements
- NodeJS
- Less - Globally installed
sudo npm -g install lessc - Yuglify - Globally installed
sudo npm -g install yuglify
Configuration
The configuration is stored in a pipeline.json file located in the conf/ folder in your
beego application. Example usage:
{
"css": {
"base": {
"root": "static/",
"sources": [
"css/base.css",
"css/mixins.css"
],
"output": "dist/app.css"
},
"output": {
"sources": [
"css/base.css",
"css/less1.less",
"css/less2.less"
],
"output": "dist/output.css"
}
},
"js": {}
}
We can specify the following keys: css, js. Each mapping inside represents the output of compiled/compressed/versioned file.
The root key can be omited and will default to "static/". This is the location where your assets reside if they are different from the default.
Sources configuration supports wild card asset discovery. e.g: css/*.css
IMPORTANT: Watch out so that any source file doesn't have the same path/name as the output file. The app will complain if you mistakenly override a source file with an output file.
Configuration in the code
You must include the pipeline and any compilers/compressor in the code. At the moment
there is only yuglify support for compressor cause this supports both css and js.
In main.go import pipeline and any compiler/compressor that you require:
package main
import (
...
"github.com/astaxie/beego"
_ "github.com/bogh/beego-pipeline"
_ "github.com/bogh/beego-pipeline/compilers/less"
_ "github.com/bogh/beego-pipeline/compressors/yuglify"
)
func main() {
beego.Run()
}
Override command parameters
WIP
Usage
Pipeline will automatically register to template functions pipeline_css and
pipeline_js. Using this you can load the groups by name in your templates. E.g.:
<!doctype html>
<html>
<head>
<title>Beego pipeline example</title>
{{ pipeline_css "app" }}
</head>
<body>
...
{{ pipeline_js "app" }}
</body>
</html>
If you run in dev mode then the assets won't be compressed and they will be added
idividually. Assets that don't need compilation (e.g.: basic .css files) and any file
that has no matching compiler.
<link href="/static/css/base.css">
<link href="/static/css/mixins.css">
In case of a compiled file. If the extension is .less a file with the same name
but correct asset extension will be generated. e.g. app.less => app.css. In
the same folder.
If you run in any other mode the assets will be compressed into the output setting
of the group and the file named will be appended with a hash generated from the
file contents. e.g.: css/app.css => app.9fa8429f0f816065.css.
The output of the helpers would be:
<link href="/static/app.9fa8429f0f816065.css">
Pipeline will automatically watch the source files for changes and regenerate
that group in dev mode.
TODO
- Sass compiler
- TypeScript compiler
Documentation
¶
Index ¶
- Variables
- func PipelineCss(name string) (template.HTML, error)
- func PipelineJs(name string) (template.HTML, error)
- func RegisterCompiler(c Compiler)
- func RegisterCompressor(c Compressor)
- type Asset
- type AutoCloseReader
- type Collection
- type Collections
- type Compiler
- type Compressor
- type Config
- type ErrOverridingPath
- type Executor
- type Group
- func (g *Group) AbsPath(path string) string
- func (g *Group) NormAsset(path string, asset Asset) string
- func (g *Group) NormAssets(paths []string, asset Asset) ([]string, error)
- func (g *Group) OutputPath() string
- func (g *Group) ResultPaths(asset Asset) ([]string, error)
- func (g *Group) RootedPath(paths ...string) string
- func (g *Group) SourcePaths() ([]string, error)
- func (g *Group) VersionedPath() string
- type NopCompiler
- type Processor
- func (p *Processor) Compile(group *Group, write bool) (io.Reader, error)
- func (p *Processor) Compress(in io.Reader) (io.Reader, error)
- func (p *Processor) GetAsset() string
- func (p *Processor) GetCompiler(path string) Compiler
- func (p *Processor) GetCompressor() Compressor
- func (p *Processor) Process() error
- func (p *Processor) ProcessGroup(group *Group) error
- func (p *Processor) Watch() error
- func (p *Processor) Write(path string, r io.Reader) error
Constants ¶
This section is empty.
Variables ¶
var ( ErrNoCompiler = errors.New("No compiler found") ErrAssetNotFound = errors.New("No asset found.") )
var (
DefaultCompiler = new(NopCompiler)
)
Functions ¶
func RegisterCompiler ¶
func RegisterCompiler(c Compiler)
func RegisterCompressor ¶
func RegisterCompressor(c Compressor)
Types ¶
type Asset ¶
type Asset string
Used for constants to define the asset type set
const ( AssetCss Asset = "css" AssetJs = "js" )
type AutoCloseReader ¶
type AutoCloseReader struct {
io.ReadCloser
}
Reader that closes it self when reaches EOF
type Collections ¶
type Collections map[Asset]Collection
type Compressor ¶
type Compressor interface {
Match(Asset) bool
// Should compress and concatenate the file in paths and save them in the
// output
Compress(io.Reader) (io.Reader, error)
}
Define compressor interface
type Config ¶
type Config struct {
Collections
Watcher *fsnotify.Watcher
}
Hold a map of asset types each containing a collection
func (*Config) GetAssetGroup ¶
func (*Config) GetAssetTpl ¶
type ErrOverridingPath ¶
type ErrOverridingPath struct {
Path string
}
func (*ErrOverridingPath) Error ¶
func (e *ErrOverridingPath) Error() string
type Executor ¶
func NewExecutor ¶
type Group ¶
type Group struct {
// Location inside the AppPath directory
// specify this in case the root of static folder is not the default "/static"
Root string `json:",omitempty"`
Sources []string
Output string
// contains filtered or unexported fields
}
Keep configuration for an asset output
func (*Group) NormAsset ¶
Returns a path for a source that will change the extension to match the asset If the path is the same error is returned. File shouldn't be overriden
func (*Group) NormAssets ¶
func (*Group) ResultPaths ¶
Determine the Result path and return the value TODO: This method will calculate the version hash
func (*Group) RootedPath ¶
func (*Group) SourcePaths ¶
func (*Group) VersionedPath ¶
type NopCompiler ¶
type NopCompiler struct{}
func (*NopCompiler) RequireCompile ¶
func (n *NopCompiler) RequireCompile() bool
func (*NopCompiler) String ¶
func (n *NopCompiler) String() string
type Processor ¶
type Processor struct {
Asset Asset
Collection Collection
}
func NewProcessor ¶
func NewProcessor(asset Asset, collection Collection) *Processor
func (*Processor) GetCompiler ¶
func (*Processor) GetCompressor ¶
func (p *Processor) GetCompressor() Compressor
Source Files
Directories