pkgzip

command module
Version: v0.0.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 11, 2021 License: BSD-2-Clause Imports: 16 Imported by: 0

README

pkgzip

The pkgzip command bundles assets into a Go package. It is a fork of statik that changes the API of the package to not require import side effects.

To use this tool in your Go project, add it to your tools.go file, and add a Go Generate line (this doesn't necessarily have to be in tools.go) similar to the one in the following example:

//go:generate go run code.soquee.net/pkgzip -m -f -src assets -pkg assetsfs

// +build tools

package main

import (
	_ "code.soquee.net/pkgzip"
)

Then update your go.mod file with the specific version you want (use go get -u to get the latest), and run go generate tools.go (or wherever you put the comment) to generate your assets package. It's probably easiest to do this from your Makefile like so:

ASSETS!=find myassetstree/

mybin: internal/assetsfs/pkgzip.go
	go build -o $@

internal/assetsfs/pkgzip.go: $(ASSETS)
	go generate tools.go

License

The package may be used under the terms of the BSD 2-Clause License a copy of which may be found in the LICENSE file.

Unless you explicitly state otherwise, any contribution submitted for inclusion in the work by you shall be licensed as above, without any additional terms or conditions.

Parts of this work are copied from statik and used under the terms of the Apache License Version 2.0, a copy of which can be found in the file LICENSE.apache.

Documentation

Overview

The pkgzip command bundles assets into a Go package.

For more information see pkgzip -help

Source Files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL