https://github.com/influx6/assets
asset is a small go library providing useful utilites for gathering asset files(templates) from directories
https://github.com/influx6/assets
Last synced: 7 months ago
JSON representation
asset is a small go library providing useful utilites for gathering asset files(templates) from directories
- Host: GitHub
- URL: https://github.com/influx6/assets
- Owner: influx6
- Created: 2015-09-22T15:00:17.000Z (about 10 years ago)
- Default Branch: master
- Last Pushed: 2015-12-24T09:25:46.000Z (almost 10 years ago)
- Last Synced: 2025-01-21T07:08:26.018Z (9 months ago)
- Language: Go
- Size: 2 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
#Assets
[](http://godoc.org/github.com/influx6/assets)
[](https://travis-ci.org/influx6/assets)
Provides a convenient set of tools for handling template files and turning assets into embeddable go files
##Example
- Emdedding
*Note to run the tests in ./test/* sub directories, first run `go test` in the root directory to generate the needed files*
- To embed a given directory but in development mode(loading from disk) but also gzipping output
```go
bf, err := NewBindFS(&BindFSConfig{
InDir: "./",
OutDir: "./tests/debug",
Package: "debug",
File: "debug",
Gzipped: true,
NoDecompression: true,
Production: false,
})
if err != nil {
panic("directory path is not valid")
}
//to get this to create and embed the files,simple call .Record()
err = bf.Record() // you can call this as many times as you want to update go file
```
- Loading a generated asset file
```go
//a genetate file called `debug.go` will exists in ./tests/debug/
//to use simply loadup
import (
"github.com/influx6/assets/tests/debug"
"net/http"
)
func main(){
//to retrieve a directory,simply do:
fixtures,err := debug.RootDirectory.GetDir("/fixtures/")
//to retrieve a file,simply do:
basic,err := debug.RootDirectory.GetFile("/fixtures/base/basic.tmpl")
// create a http.FileServer from the global RootDirectory listing
rootFs := http.FileServer(debug.RootDirectory)
// or use the root VirtualDirectory as a http.FileSystem
rootFs2 := http.FileServer(debug.RootDirectory.Root())
//or use any sub-directory you want
fixturesFs := http.FileServer(debug.RootDirectory.Get("/fixtures/"))
}
```
- To embed a given directory but in development mode,where files are loaded directory from disk
```go
bf, err := NewBindFS(&BindFSConfig{
InDir: "./",
OutDir: "./tests/debug",
Package: "debug",
File: "debug",
Gzipped: false,
Production: false,
})
if err != nil {
panic("directory path is not valid")
}
//to get this to create and embed the files,simple call .Record()
err = bf.Record() // you can call this as many times as you want to update go file
```
- To embed files in production mode,i.e all assets are embedded into the generated go file and have all output ungzipped
```go
bf, err := NewBindFS(&BindFSConfig{
InDir: "./",
OutDir: "./tests/prod",
Package: "prod",
File: "prod",
Gzipped: true,
Production: true,
})
if err != nil {
panic("directory path is not valid")
}
err = bf.Record() // you can call this as many times as you want to update go file
```
- To embed a given directory in production mode but also enforcing no decompression of output
```go
bf, err := NewBindFS(&BindFSConfig{
InDir: "./",
OutDir: "./tests/debug",
Package: "debug",
File: "debug",
Gzipped: true,
NoDecompression: true,
Production: true,
})
if err != nil {
panic("directory path is not valid")
}
//to get this to create and embed the files,simple call .Record()
err = bf.Record() // you can call this as many times as you want to update go file
```
- Templates
```go
dir := NewTemplateDir(&TemplateConfig{
Dir: "./fixtures",
Extension: ".tmpl",
})
dirs := []string{"base"}
asst, _ := dir.Create("base.tmpl", dirs, nil)
buf := bytes.NewBuffer([]byte{})
do := &dataPack{
Name: "alex",
Title: "flabber",
}
_ = asst.Tmpl.ExecuteTemplate(buf, "base", do)
/*
buf => `
flabber
we are equal
`
*/
```