https://github.com/benbjohnson/hashfs

Implementation of io/fs.FS that appends SHA256 hashes to filenames to allow for aggressive HTTP caching.
https://github.com/benbjohnson/hashfs

Last synced: 21 days ago
JSON representation

Implementation of io/fs.FS that appends SHA256 hashes to filenames to allow for aggressive HTTP caching.

• Host: GitHub
• URL: https://github.com/benbjohnson/hashfs
• Owner: benbjohnson
• License: mit
• Created: 2020-12-11T18:42:56.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2024-02-22T20:48:57.000Z (10 months ago)
• Last Synced: 2024-10-20T16:35:08.693Z (about 2 months ago)
• Language: Go
• Size: 18.6 KB
• Stars: 358
• Watchers: 4
• Forks: 13
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
hashfs

======

Implementation of io/fs.FS that appends SHA256 hashes to filenames to allow for

aggressive HTTP caching.

For example, given a file path of `scripts/main.js`, the `hashfs.FS`

filesystem will provide the server with a hashname of

`scripts/main-b633a..d628.js` (the hash is truncated for brevity in the example). When

this file path is requested by the client, the server can verify the hash and

return the contents with an aggressive `Cache-Control` header. The client will

cache this file for up to a year and does not need to re-request it in the

future.

Note that this library requires Go 1.16 or higher.

## Usage

To use `hashfs`, first wrap your `embed.FS` in a `hashfs.FS` filesystem:

```go

//go:embed scripts stylesheets images

var embedFS embed.FS

var fsys = hashfs.NewFS(embedFS)

```

Then attach a `hashfs.FileServer()` to your router:

```go

http.Handle("/assets/", http.StripPrefix("/assets/", hashfs.FileServer(fsys)))

```

Next, your html templating library can obtain the hashname of your file using

the `hashfs.FS.HashName()` method:

```go

func renderHTML(w io.Writer) {

	fmt.Fprintf(w, ``)

	fmt.Fprintf(w, ``, fsys.HashName("scripts/main.js"))

	fmt.Fprintf(w, ``)

}

```