Giter Club home page Giter Club logo

codegen's Introduction

codegen - Utilities for Go code generators

Go Reference Codecov Go Report Card

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:

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.

codegen's People

Contributors

dolmen avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar

Forkers

cyrannosaurus

codegen's Issues

Make enforcement of marking generated code optional

From https://pkg.go.dev/cmd/go#hdr-Generate_Go_files_by_processing_source:

To convey to humans and machine tools that code is generated, generated source should have a line that matches the following regular expression (in Go syntax):

Notice that documentation even says should - it is just a recommendation.

The potential issue of generating code with such comments is that a lot of tools (e.g. https://github.com/golangci/golangci-lint) will ignore these files while people may want to have additional checks and refinements than just gofmt.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.