Add plain text template

README.md

@@ -100,6 +100,14 @@ For example:
 //go:generate go run github.com/paulhammond/licensepack -tmpl string-const .
 ```
 
+If you’d prefer to generate plain text output, perhaps because you’d like to
+embed licensing information using a different mechanism, there is a plain text
+template available. To use this you’ll need to disable gofmt. For example:
+
+```
+//go:generate go run github.com/paulhammond/licensepack -file licenses.txt -nofmt -tmpl text ./cmd
+```
+
 ### Custom templates
 
 If you’d like to customize the template you can provide the path to a template

main.go

@@ -28,6 +28,7 @@ var (
 	pkg      = flag.String("pkg", "main", "package for generated code")
 	file     = flag.String("file", "licenses.go", "filename for generated code")
 	variable = flag.String("var", "Licenses", "variable name")
+	nofmt    = flag.Bool("nofmt", false, "run output through go fmt")
 	quiet    = flag.Bool("quiet", false, "only output error messages")
 	credits  = flag.Bool("credits", false, "show open source credits")
 	help     = flag.Bool("help", false, "show help")
@@ -197,10 +198,6 @@ func main() {
 	})
 
 	var src bytes.Buffer
-	_, err = src.Write([]byte("// " + comment + "\n"))
-	if err != nil {
-		log.Fatal(err)
-	}
 
 	t, err := parseTemplate(*tmpl)
 	if err != nil {
@@ -210,22 +207,27 @@ func main() {
 	err = t.Execute(&src, struct {
 		Pkg     string
 		Var     string
+		Comment string
 		Modules []license.Module
 	}{
 		Pkg:     *pkg,
 		Var:     *variable,
 		Modules: modules,
+		Comment: comment,
 	})
 	if err != nil {
 		log.Fatal(err)
 	}
 
-	formatted, err := format.Source(src.Bytes())
-	if err != nil {
-		log.Fatal(err)
+	output := src.Bytes()
+	if !*nofmt {
+		output, err = format.Source(src.Bytes())
+		if err != nil {
+			log.Fatal(err)
+		}
 	}
 
-	err = os.WriteFile(*file, formatted, 0666)
+	err = os.WriteFile(*file, output, 0666)
 	if err != nil {
 		log.Fatal(err)
 	}

tmpl/string-const.tmpl

@@ -1,3 +1,4 @@
+// {{ .Comment }}
 package {{ .Pkg }}
 
 const {{ .Var }} = {{ (eval "licenses" .) | wrapquote "\t\t" }}

tmpl/string-func.tmpl

@@ -1,3 +1,4 @@
+// {{ .Comment }}
 package {{ .Pkg }}
 
 func {{ .Var }}() string {

tmpl/string-var.tmpl

@@ -1,3 +1,4 @@
+// {{ .Comment }}
 package {{ .Pkg }}
 
 var {{ .Var }} = {{ (eval "licenses" .) | wrapquote "\t\t" }}

tmpl/string.tmpl

@@ -1,3 +1,4 @@
+// {{ .Comment }}
 package {{ .Pkg }}
 
 func init() {

tmpl/struct-func.tmpl

@@ -1,3 +1,4 @@
+// {{ .Comment }}
 package {{ .Pkg }}
 
 import "github.com/paulhammond/licensepack/license"

tmpl/struct-var.tmpl

@@ -1,3 +1,4 @@
+// {{ .Comment }}
 package {{ .Pkg }}
 
 import "github.com/paulhammond/licensepack/license"

tmpl/struct.tmpl

@@ -1,3 +1,4 @@
+// {{ .Comment }}
 package {{ .Pkg }}
 
 import "github.com/paulhammond/licensepack/license"

tmpl/text.tmpl

@@ -0,0 +1,10 @@
+{{ range .Modules -}}
+## {{ .Name }}
+
+{{ range .Licenses -}}
+{{ .Path }}:
+
+{{ .Contents }}
+
+{{ end -}}
+{{ end -}}