README.md

codegen - Utilities for Go code generators

Package codegen provides a Go API for writing Go code generators from a text/template.

const tmpl = `// Code generated by main.go; DO NOT EDIT.

package main

const x = {{ printf "%q" .str }}

var v = {{ printf "%#v" .array }}
`

func main() {
	codegen.MustParse(tmpl).CreateFile(
		"main_gen.go",
		map[string]any{
			"str":   `abcdef`,
			"array": []int{1, 2, 3},
		},
	)
}

Try on the Go Playground.

Features:

• The Go syntax is validated before saving.
• The output properly is reformatted thanks to gofmt.
• The Go standard for marking generated code (https://golang.org/s/generatedcode) is enforces.

See documentation and example.

License

Copyright 2016-2024 Olivier Mengué

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.