go

module

v0.0.0-...-43c8ab9 Latest Latest Go to latest Published: Feb 14, 2023 License: Apache-2.0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/cloudengio/go.gotools

Links

Open Source Insights

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 Usage of goannotate:	Usage of goannotate:
goannotate/annotators
goannotate/annotators/functions
goannotate/annotators/internal
goannotate/annotators/internal/testutil
golocate Usage of golocate:	Usage of golocate:
gomarkdown Usage of gomarkdown:	Usage of gomarkdown:
gousage Usage of gousage:	Usage of gousage:
derive Package derive provides support for deriving go code from existing code.	Package derive provides support for deriving go code from existing code.
locate 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.

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL