2eb00dcf94
Noticed that the `hclfmt` tool (which uses hcl/printer) was chomping the trailing newline from config files. Here we switch to the more conventional newline-at-EOF output. In the process of changing this, I realized that: * The printer_test.go build tag was wrong, so it wasn't running * The format() test helper was not exercising Format So both of those fixes are included here
68 lines
1.4 KiB
Go
68 lines
1.4 KiB
Go
// Package printer implements printing of AST nodes to HCL format.
|
|
package printer
|
|
|
|
import (
|
|
"bytes"
|
|
"io"
|
|
"text/tabwriter"
|
|
|
|
"github.com/hashicorp/hcl/hcl/ast"
|
|
"github.com/hashicorp/hcl/hcl/parser"
|
|
)
|
|
|
|
var DefaultConfig = Config{
|
|
SpacesWidth: 2,
|
|
}
|
|
|
|
// A Config node controls the output of Fprint.
|
|
type Config struct {
|
|
SpacesWidth int // if set, it will use spaces instead of tabs for alignment
|
|
}
|
|
|
|
func (c *Config) Fprint(output io.Writer, node ast.Node) error {
|
|
p := &printer{
|
|
cfg: *c,
|
|
comments: make([]*ast.CommentGroup, 0),
|
|
standaloneComments: make([]*ast.CommentGroup, 0),
|
|
// enableTrace: true,
|
|
}
|
|
|
|
p.collectComments(node)
|
|
|
|
if _, err := output.Write(p.unindent(p.output(node))); err != nil {
|
|
return err
|
|
}
|
|
|
|
// flush tabwriter, if any
|
|
var err error
|
|
if tw, _ := output.(*tabwriter.Writer); tw != nil {
|
|
err = tw.Flush()
|
|
}
|
|
|
|
return err
|
|
}
|
|
|
|
// Fprint "pretty-prints" an HCL node to output
|
|
// It calls Config.Fprint with default settings.
|
|
func Fprint(output io.Writer, node ast.Node) error {
|
|
return DefaultConfig.Fprint(output, node)
|
|
}
|
|
|
|
// Format formats src HCL and returns the result.
|
|
func Format(src []byte) ([]byte, error) {
|
|
node, err := parser.Parse(src)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
var buf bytes.Buffer
|
|
if err := DefaultConfig.Fprint(&buf, node); err != nil {
|
|
return nil, err
|
|
}
|
|
|
|
// Add trailing newline to result
|
|
buf.WriteString("\n")
|
|
|
|
return buf.Bytes(), nil
|
|
}
|