Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/parnic/go-assetprecompiler
Asset pipeline/precompiler for Golang
https://github.com/parnic/go-assetprecompiler
asset-management asset-pipeline assets-management golang golang-library precompile precompiler
Last synced: 10 days ago
JSON representation
Asset pipeline/precompiler for Golang
- Host: GitHub
- URL: https://github.com/parnic/go-assetprecompiler
- Owner: parnic
- License: mit
- Created: 2018-11-29T03:21:16.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-12-12T01:44:40.000Z (24 days ago)
- Last Synced: 2024-12-12T02:36:53.106Z (24 days ago)
- Topics: asset-management, asset-pipeline, assets-management, golang, golang-library, precompile, precompiler
- Language: Go
- Size: 91.8 KB
- Stars: 7
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
Awesome Lists containing this project
README
# go-assetprecompiler
This is a web asset compiler written in Golang to be used in a web asset pipeline.
## Why?
Coming from Rails, I was used to having all my Javascript and CSS assets precompiled as well as uniquely identified for cache-friendliness and lowering the number of requests required to view a website.
The only Golang-based solutions I was able to find were either purpose-built for a specific use case or simply didn't have the features I needed.
## How is this different?
You provide a list of files that you would like to be compiled into one file, in the order you'd like them compiled in, and the library will combine, optionally minify them using , and generate an output file with the sha256 signature of the file in the filename. Your application can consume the generated byte buffers and handle them as you please, or you can have the library write the files out to a specified directory.
## How do I use it?
The simplest use case is to generate assets offline for use in a Golang web application. For example:
```go
package main
import precompiler "github.com/parnic/go-assetprecompiler"
func main() {
precompiler.Compile(precompiler.Config{
Files: []string{
"assets/css/bootstrap.default.css",
"assets/css/font-awesome.css",
"assets/css/application.css",
"assets/js/jquery.js",
"assets/js/popper.js",
"assets/js/bootstrap.js",
"assets/js/moment.js",
"assets/js/application.js",
},
Minify: true,
OutputDir: "assets/",
FilePrefix: "app-",
})
}
```
Currently only Javascript (.js) and CSS (.css) files are supported.
Config key | Use
-----------|-----
Files | An array of strings representing paths to files you want compiled
Minify | Bool, optionally minify the files with
OutputDir | String, the directory you'd like to write the compiled files to (with trailing slash)
FilePrefix | String, what, if anything, should be prefixed onto the output filenames
Note that if an output dir is specified, "css" and "js" subdirectories will be used/created to hold the resulting files. Leaving it blank will cause it to not write any files to disk.
`Compile()` returns `map[FileType]*CompileResult, error` where FileType is one of the supported types, e.g. `precompiler.CSS`, `precompiler.JS` and CompileResult is
```go
type CompileResult struct {
Bytes []byte
Hash string
OutputPath string
}
```
for use with handling the assets yourself if you don't want the library writing them to a file.
Once the compiled files have been generated, you would set your HTML file/template to use them with e.g.:
```html
```
Or create a template function to retrieve the correct filenames so you don't have to update your template every time you re-generate.
## Gin-gonic middleware
There is a middleware available to automatically set a Cache-Control header for infinite lifetime of these assets. You can use it like:
```go
r := gin.New()
r.Static("/assets", "assets")
r.Use(precompiler.GinMiddleware("/assets"))
```
Where "/assets" is the base path (with leading slash) for all assets on your website. Note that every request starting with this path will have very long cache headers set, not just CSS/JS files.
## Other integrations
If used as an offline generation tool, the resulting files can easily be used with a bindata/packr-style bundling system so that the app can be deployed as a single binary.
## Contributions
Contributions are quite welcome. This is a fairly simple helper library at the moment, but I'd be happy to implement any customizations for it to work for other peoples' apps than just my own.