https://github.com/kubernetes/gengo

gengo library for code generation.
https://github.com/kubernetes/gengo

Last synced: 7 days ago
JSON representation

gengo library for code generation.

• Host: GitHub
• URL: https://github.com/kubernetes/gengo
• Owner: kubernetes
• License: apache-2.0
• Created: 2016-08-30T02:38:59.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2024-09-11T19:33:12.000Z (about 2 months ago)
• Last Synced: 2024-10-19T16:53:30.394Z (16 days ago)
• Language: Go
• Size: 1.37 MB
• Stars: 549
• Watchers: 39
• Forks: 193
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: code-of-conduct.md
  • Security: SECURITY.md

Awesome Lists containing this project

• awesome - kubernetes/gengo - gengo library for code generation. (Go)

README

        
# gengo

[![Travis Widget]][Travis] [![GoDoc Widget]][GoDoc]  [![GoReport]][GoReportStatus]

[Travis]: https://travis-ci.org/kubernetes/gengo

[Travis Widget]: https://travis-ci.org/kubernetes/gengo.svg?branch=master

[GoDoc]: https://godoc.org/k8s.io/gengo

[GoDoc Widget]: https://godoc.org/k8s.io/gengo?status.svg

[GoReport]: https://goreportcard.com/badge/github.com/kubernetes/gengo

[GoReportStatus]: https://goreportcard.com/report/github.com/kubernetes/gengo

NOTE: [`k8s.io/gengo/v2`](https://github.com/kubernetes/gengo/tree/master/v2) is the current development module.

A package for generating things based on go files. This mechanism was first used

in [Kubernetes code-generator](https://github.com/kubernetes/kubernetes/tree/master/staging/src/k8s.io/code-generator) and is split out here for ease of reuse and maintainability.

`go get k8s.io/gengo/...`

## Examples

A set generator, deep-copy generator, defaulter generator and go-to-protobuf

generator are included here. Also, import-boss will enforce arbitrary rules about

import trees.

## args/

Package args defines common arguments for a generator binary.

## generator/

Package generator defines interfaces for code generators to implement, and

machinery that will execute those code generators.

## types/

Package types contains the type system definition. It is modeled after Go's type

system, but it's intended that you could produce these types by parsing

something else, if you want to write the parser/converter.

We don't directly use the go types in the go typecheck library because they are

based on implementing differing interfaces. A struct-based format is more

convenient input for template driven output.

## parser/

Package parser parses go source files.

## namer/

Package namer defines a naming system, for:

* helping you reference go objects in a syntactically correct way

* keeping track of what you reference, for importing the right packages

* and defining parallel tracks of names, for making public interfaces and

  private implementations.

## Contributing

Please see [CONTRIBUTING.md](CONTRIBUTING.md) for instructions on how to contribute.