Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/maddyblue/esc
A simple file embedder for Go
https://github.com/maddyblue/esc
Last synced: 3 months ago
JSON representation
A simple file embedder for Go
- Host: GitHub
- URL: https://github.com/maddyblue/esc
- Owner: maddyblue
- License: mit
- Archived: true
- Created: 2014-01-26T05:08:04.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2023-10-19T05:01:50.000Z (about 1 year ago)
- Last Synced: 2024-05-19T17:30:59.025Z (8 months ago)
- Language: Go
- Homepage: http://godoc.org/github.com/mjibson/esc
- Size: 1.42 MB
- Stars: 639
- Watchers: 16
- Forks: 76
- Open Issues: 10
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-go - esc - Embeds files into Go programs and provides http.FileSystem interfaces to them. (Resource Embedding / HTTP Clients)
- awesome-ccamel - maddyblue/esc - A simple file embedder for Go (Go)
README
## DEPRECATED
Stop using this and switch to [embed](https://pkg.go.dev/embed) now in the standard library.
# esc
[](https://godoc.org/github.com/mjibson/esc)
esc embeds files into go programs and provides http.FileSystem interfaces
to them.
It adds all named files or files recursively under named directories at the
path specified. The output file provides an http.FileSystem interface with
zero dependencies on packages outside the standard library.
## Installation
`go get -u github.com/mjibson/esc`
## Usage
`esc [flag] [name ...]`
The flags are:
```
-o=""
output filename, defaults to stdout
-pkg="main"
package name of output file, defaults to main
-prefix=""
strip given prefix from filenames
-ignore=""
regular expression for files to ignore
-include=""
regular expression for files to include
-modtime=""
Unix timestamp to override as modification time for all files
-private
unexport functions by prefixing them with esc, e.g. FS -> escFS
-no-compress
do not compress files
```
## Accessing Embedded Files
After producing an output file, the assets may be accessed with the FS()
function, which takes a flag to use local assets instead (for local
development).
* (_esc)?FS(Must)?(Byte|String) returns an asset as a (byte slice|string).
* (_esc)?FSMust(Byte|String) panics if the asset is not found.
## Go Generate
esc can be invoked by go generate:
`//go:generate esc -o static.go -pkg server static`
## Example
Embedded assets can be served with HTTP using the http.FileServer.
Assuming you have a directory structure similar to the following:
```
.
├── main.go
└── static
├── css
│ └── style.css
└── index.html
```
Where main.go contains:
```
package main
import (
"log"
"net/http"
)
func main() {
// FS() is created by esc and returns a http.Filesystem.
http.Handle("/static/", http.FileServer(FS(false)))
log.Fatal(http.ListenAndServe(":8080", nil))
}
```
1. Generate the embedded data:
`esc -o static.go static`
2. Start the server:
`go run main.go static.go`
3. Access http://localhost:8080/static/index.html to view the files.
You can see worked example in [example](example) dir
just run it as
`go run example/main.go example/static.go`