search

rakyll / statik

Embed files into a Go executable
Apache License 2.0
3.76k stars 224 forks source link

Possibility to add a package comment #51

Closed vdobler closed 5 years ago

vdobler commented 6 years ago

Several tools complain if a package has no package level comment at all, eg. staticcheck:

staticcheck ./...
statik/statik.go:3:1: at least one file in a package should have a package comment (ST1000)

I'd like to propose the addition of a new command line flag with a useful default, e.g.

flagPkgCmt     = flag.String("c", "Package statik contains static assets.", "Package comment")

(An empty value for *flagPgkCmt would omit the comment.)

If this sounds sensible I could provide a PR.

rakyll commented 6 years ago

Happy to review a PR for this feature!

dolmen commented 5 years ago

This has been implemented in #52 and merged. Close?