README
¶
goprint 
goprint is a command that prints the source code of a Go packages. The
generated document is in HTML format, suitable for printing or converting to
PDF.
The tool uses experimental CSS features for setting the page headers and footer that, at the present time, are not fully supported by browsers. However they are supported by Prince (http://www.princexml.com).
On the top left of the page is reported the package import path.
On the top right of the page is reported the file name.
On the bottom left of the page is reported the package's containing module. Currently only the module path is printed, without the version.
On the bottom right of the page is reported the page number.
Usage
Usage: goprint [flags] importpath
Flags:
-font value
font (default "Courier" 10pt/12pt)
-m
print all the packages in the module
-page-margin value
page margin (default 2.5cm 1cm)
-page-size value
page size (default A4 portrait)
-test
print _test.go source files
importpath is interpreted as in go list, however goprint only process the
first package.
By default goprint will print all the .go source files, excluding the
_test.go files.
-page-size
Supported page sizes are A4 or letter. The page orientation is portrait
and can not be changed.
-page-margin
The right, bottom and left margins can be omitted.
-font
The font family, font size and line height must all be specified. The font family must be quoted, even if it contains no white space.
-test
When the -test flag is set, goprint will print all the _test.go files,
instead of the .go source files.
-m
When the -m flag is set, goprint operates in module mode and importpath
is interpreted as modulepath.
goprint will print the source files of all the packages belonging to the
module named by the modulepath.
Examples
goprint main.go > build/pkg.html
goprint -font='"Inconsolata" 10pt/12pt' ./internal/css > build/pkg.html
prince -o build/pkg.pdf build/pkg.html
Requirements
goprint requires at least Go 1.7. There are no external dependencies.
Documentation
¶
Overview ¶
goprint is a command used to print the source code of a Go package.
The generated document is in HTML format, written on stdout and with CSS specialized for printing.
Source Files
¶
Directories
¶
| Path | Synopsis |
|---|---|
|
internal
|
|
|
css
Package css implements the minimal CSS syntax for allowing CSS properties to be defined via the standard flag package.
|
Package css implements the minimal CSS syntax for allowing CSS properties to be defined via the standard flag package. |
|
goefmt
Package goefmt implements an enhanced and reusable formatter for Go source code.
|
Package goefmt implements an enhanced and reusable formatter for Go source code. |
|
packages
Package packages implements support for loading packages.
|
Package packages implements support for loading packages. |