beegoAssets

README

Description

Rails-style assets for golang beego web framework.

Installation

To install library, create config in ./conf/asset-pipeline.conf and enter into the console:

go get github.com/gtforge/beego-assets

Usage

Add following lines to your main file

import (
	_ "github.com/gtforge/beego-assets"
)

Put basic config to ./conf/asset-pipeline.conf

Use functions javascript_include_tag and stylesheet_include_tag in your templates

{{ asset_js "application" }}
{{ asset_css "application" }}

Preprocessors

Library support preprocessors, like sass, less, scss and coffeescript. It use Node.js and corresponding libraries, so, you should install them before using it.

Installation

First, install corresponding node modules

Less: npm install less -g
Scss/Sass: npm install node-sass -g
Coffeescript: npm install coffee-script -g

After that you can use less by adding following line to your imports

Less: import _ "github.com/gtforge/beego-assets/less"
Sass: import _ "github.com/gtforge/beego-assets/sass"
Scss: import _ "github.com/gtforge/beego-assets/scss"
Coffeescript: import _ "github.com/gtforge/beego-assets/coffee"

Asset format

Asset extension sholud be .js or .css. Depends on include_tag function
Current version of library support only "require" method.

CSS asset example

/*= require css/file1
/*= require css/file1

JS asset example

//= require js/file1
//= require js/file2

Config

The configuration file is ./conf/asset-pipeline.conf have basic INI format.

Root params

• assets_dir - paths to assets files(You can specify many directories, separated by commas)
• public_dirs - paths, where library will search for files for assets.(You can specify many directories, separated by commas)
• temp_dir - path to store compiled asset files.

Sections

You can define different parameters for different runmodes, which are defined in ./conf/app.conf. Name of section is the value of runmode. If there is no such section, all the parameters will be false

Parameters

• minify_js - Flag to minify javascript assets
• minify_css - Flag to minify stylesheet assets
• combine_js - Flag to combine multiple javascript files into one file
• combine_css - Flag to combine multiple stylesheet files into one file
• production_mode - It this flag is FALSE, assets will be recompiled each page request

Config example:

#paths where assets stored(Devided by comma)
assets_dirs = assets/javascripts,assets/stylesheets
#path to js/css
public_dirs = static
#where to put compiled assets files
temp_dir = static/assets

[production]
minify_js = true
minify_css = true

combine_js = true
combine_css = true

production_mode = false

[dev]
minify_js = false
minify_css = false

combine_js = false
combine_css = false

production_mode = false

API

• SetAssetFileExtension - add your own extension to files finder

  • extension string - Extension name, with point.(Ex. ".js")
  • asset_type AssetType - beegoAssets.AssetStylesheet / beegoAssets.AssetJavascript

• SetPreLoadCallback - define pre-load callback for assets. "cb" will be executed before loading assets files to memory.

  • asset_type AssetType
  • cb preLoadCallback - callback, which will be executed before asset compilation

• SetPreBuildCallback - define pre-build callback for assets. "cb" will be executed before building of asset

  • asset_type AssetType
  • cb pre_afterBuildCallback - callback, which will be executed before asset compilation

• SetAfterBuildCallback - define after-build callback for assets. "cb" will be executed after asset was built

  • asset_type AssetType
  • cb pre_afterBuildCallback - callback, which will be executed after asset compilation

Documentation

Index

• Constants
• Variables
• func Error(format string, v ...interface{})
• func GetAssetFileHash(body *string) string
• func MinifyJavascript(body string) (string, error)
• func MinifyStylesheet(body string) (string, error)
• func SetAfterBuildCallback(assetType assetsType, cb preAfterBuildCallback)
• func SetAssetFileExtension(extension string, assetType assetsType)
• func SetMinifyCallback(extension string, cb minifyFileCallback)
• func SetPreBuildCallback(assetType assetsType, cb preAfterBuildCallback)
• func SetPreLoadCallback(assetType assetsType, cb preLoadCallback)
• func Warning(format string, v ...interface{})
• type Asset

Constants

const (
	//AssetJavascript type
	AssetJavascript assetsType = iota
	//AssetStylesheet type
	AssetStylesheet
)

Variables

var Config assetPipelineConfig

Config - assets pipeline configuration

Functions

func Error

func Error(format string, v ...interface{})

Error - print Error in log

func GetAssetFileHash

func GetAssetFileHash(body *string) string

GetAssetFileHash - get hash(fingerprint) file by body

func MinifyJavascript

func MinifyJavascript(body string) (string, error)

MinifyJavascript - Minify js file

func MinifyStylesheet

func MinifyStylesheet(body string) (string, error)

MinifyStylesheet - Minify css file

func SetAfterBuildCallback

func SetAfterBuildCallback(assetType assetsType, cb preAfterBuildCallback)

SetAfterBuildCallback - set callback on after build assets

func SetAssetFileExtension

func SetAssetFileExtension(extension string, assetType assetsType)

SetAssetFileExtension - add new Asset type

func SetMinifyCallback

func SetMinifyCallback(extension string, cb minifyFileCallback)

SetMinifyCallback -

func SetPreBuildCallback

func SetPreBuildCallback(assetType assetsType, cb preAfterBuildCallback)

SetPreBuildCallback - set callback on PreBuild assets

func SetPreLoadCallback

func SetPreLoadCallback(assetType assetsType, cb preLoadCallback)

SetPreLoadCallback - set callback on preload assets

func Warning

func Warning(format string, v ...interface{})

Warning - print Warning in log

Types

type Asset

type Asset struct {
	IncludeFiles []string
	// contains filtered or unexported fields
}

Asset - Asset type can be any asset(js,css,sass etc)