README
¶
go.gotools
go tools and packages for manipulating go source code and generating documentation.
go.gotools contains the following cmds and packages:
- cloudeng.io/go/cmd/gomarkdown: generate markdown for go packages and commands.
- cloudeng.io/go/cmd/gousage: generate go code that captures the output of --help as a package comment.
- cloudeng.io/go/cmd/golocate: locating interface implementations, functions and comments.
- cloudeng.io/go/cmd/goannotate: extensible, configurable annotations such as for copyright/licenses, extensible logging etc.
- cloudeng.io/go/locate: support for locating interface implementations, functions etc.
- cloudeng.io/go/derive: support for deriving go code from existing types and function signatures.
The following commands are used to maintain the package and command README.md's for this repository and to ensure that the appropriate copyright and license headers are present.
go run cloudeng.io/go/cmd/gousage --overwrite ./...
go run cloudeng.io/go/cmd/goannotate --config=copyright-annotation.yaml --annotation=cloudeng-copyright ./...
go run cloudeng.io/go/cmd/gomarkdown --overwrite --circleci=cloudengio/go.gotools --goreportcard ./...
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
goannotate
command
Usage of goannotate:
|
Usage of goannotate: |
|
golocate
command
Usage of golocate:
|
Usage of golocate: |
|
gomarkdown
command
Usage of gomarkdown:
|
Usage of gomarkdown: |
|
gousage
command
Usage of gousage:
|
Usage of gousage: |
|
Package derive provides support for deriving go code from existing code.
|
Package derive provides support for deriving go code from existing code. |
|
Package locate provides a means for obtaining the location of comments, functions and implementations of interfaces in go source code, with a view to annotating that source code programmatically.
|
Package locate provides a means for obtaining the location of comments, functions and implementations of interfaces in go source code, with a view to annotating that source code programmatically. |
|
locateutil
Package locateutil provides utility routines for use with its parent locate package.
|
Package locateutil provides utility routines for use with its parent locate package. |
Click to show internal directories.
Click to hide internal directories.