package printer

Import Path
	github.com/hashicorp/hcl/hcl/printer (on go.dev)

Dependency Relation
	imports 8 packages, and imported by one package

Involved Source Files

	      nodes.go
	   d➜ printer.go
		Package printer implements printing of AST nodes to HCL format.
Package-Level Type Names (total 3, in which 2 are exported)

	/* sort exporteds by: alphabet | popularity */
	 type ByPosition ([]T)

		Methods (total 3, all are exported)
			( T) Len() int
			( T) Less(i, j int) bool
			( T) Swap(i, j int)
		Implements (at least one exported)
			 T : sort.Interface

	 type Config (struct)
		A Config node controls the output of Fprint.

		Fields (only one, which is exported)
			SpacesWidth int
				// if set, it will use spaces instead of tabs for alignment

		Methods (only one, which is exported)
			(*T) Fprint(output io.Writer, node ast.Node) error
		As Types Of (only one, which is exported)
			  var DefaultConfig

	/* one unexported ... *//* one unexported: */
	 type printer (struct)

		Fields (total 6, none are exported)
			/* 6 unexporteds ... *//* 6 unexporteds: */
			cfg Config
			comments []*ast.CommentGroup
				// may be nil, contains all comments

			enableTrace bool
			indentTrace int
			prev token.Pos
			standaloneComments []*ast.CommentGroup
				// contains all standalone comments (not assigned to any node)

		Methods (total 14, none are exported)
			/* 14 unexporteds ... *//* 14 unexporteds: */
			(*T) alignedItems(items []*ast.ObjectItem) []byte
			(*T) collectComments(node ast.Node)
				collectComments comments all standalone comments which are not lead or line
				comment

			(*T) heredocIndent(buf []byte) []byte
				heredocIndent marks all the 2nd and further lines as unindentable

			(*T) indent(buf []byte) []byte
				indent indents the lines of the given buffer for each non-empty line

			( T) isSingleLineList(l *ast.ListType) bool
				isSingleLineList returns true if:
				* they were previously formatted entirely on one line
				* they consist entirely of literals
				* there are either no heredoc strings or the list has exactly one element
				* there are no line comments

			(*T) isSingleLineObject(val *ast.ObjectItem) bool
				isSingleLineObject tells whether the given object item is a single
				line object such as "obj {}".

				A single line object:

				  * has no lead comments (hence multi-line)
				  * has no assignment
				  * has no values in the stanza (within {})

			(*T) list(l *ast.ListType) []byte
				list returns the printable HCL form of an list type.

			(*T) literalType(lit *ast.LiteralType) []byte
			(*T) objectItem(o *ast.ObjectItem) []byte
				objectItem returns the printable HCL form of an object item. An object type
				starts with one/multiple keys and has a value. The value might be of any
				type.

			(*T) objectType(o *ast.ObjectType) []byte
				objectType returns the printable HCL form of an object type. An object type
				begins with a brace and ends with a brace.

			(*T) output(n interface{}) []byte
				output prints creates b printable HCL output and returns it.

			(*T) printTrace(a ...interface{})
			(*T) singleLineList(l *ast.ListType) []byte
				singleLineList prints a simple single line list.
				For a definition of "simple", see isSingleLineList above.

			(*T) unindent(buf []byte) []byte
				unindent removes all the indentation from the tombstoned lines

		As Outputs Of (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			func trace(p *printer, msg string) *printer
		As Inputs Of (at least 2, neither is exported)
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			func trace(p *printer, msg string) *printer
			func un(p *printer)


Package-Level Functions (total 5, in which 2 are exported)

	 func Format(src []byte) ([]byte, error)
		Format formats src HCL and returns the result.

	 func Fprint(output io.Writer, node ast.Node) error
		Fprint "pretty-prints" an HCL node to output
		It calls Config.Fprint with default settings.

	/* 3 unexporteds ... *//* 3 unexporteds: */
	 func lines(txt string) int
	 func trace(p *printer, msg string) *printer
	 func un(p *printer)
		Usage pattern: defer un(trace(p, "..."))


Package-Level Variables (total 2, in which 1 are exported)

	  var DefaultConfig Config
	/* one unexported ... *//* one unexported: */
	  var unindent []byte // in the private use space
Package-Level Constants (total 4, none are exported)

	/* 4 unexporteds ... *//* 4 unexporteds: */
	const blank byte = 32
	const infinity = 1073741824 // offset or line
	const newline byte = 10
	const tab byte = 9

The pages are generated with Golds v0.3.2. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.