hclfmt

package

v0.71.0 Latest Latest Go to latest Published: Apr 2, 2024 License: Apache-2.0 Imports: 11 Imported by: 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/walteh/retab

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func Format(ctx context.Context, cfg format.Configuration, fs afero.Fs, fle string) error
func FormatBytes(cfg format.Configuration, src []byte) (io.Reader, error)
type Formatter
- func NewFormatter() *Formatter
- func (me *Formatter) Format(ctx context.Context, cfg format.Configuration, read io.Reader) (io.Reader, error)
- func (me *Formatter) Targets() []string
type Token
type Tokens
- func (ts Tokens) Columns() int
- func (ts Tokens) WriteTo(wr io.Writer, cfg format.Configuration) (int64, error)

Constants ¶

View Source

const NumSpacesPerIndent = 1

Variables ¶

This section is empty.

Functions ¶

func Format ¶

func Format(ctx context.Context, cfg format.Configuration, fs afero.Fs, fle string) error

Process uses the hcl2 library to format the hcl file. This will attempt to parse the HCL file first to ensure that there are no syntax errors, before attempting to format it.

func FormatBytes ¶

func FormatBytes(cfg format.Configuration, src []byte) (io.Reader, error)

Types ¶

type Formatter ¶

type Formatter struct {
}

func NewFormatter ¶

func NewFormatter() *Formatter

func (*Formatter) Format ¶

func (me *Formatter) Format(ctx context.Context, cfg format.Configuration, read io.Reader) (io.Reader, error)

func (*Formatter) Targets ¶

func (me *Formatter) Targets() []string

type Token ¶

type Token struct {
	hclwrite.Token
	TabsBefore int
}

type Tokens ¶

type Tokens []*Token

func (Tokens) Columns ¶

func (ts Tokens) Columns() int

Columns returns the number of columns (grapheme clusters) the token sequence occupies. The result is not meaningful if there are newline or single-line comment tokens in the sequence.

func (Tokens) WriteTo ¶

func (ts Tokens) WriteTo(wr io.Writer, cfg format.Configuration) (int64, error)

WriteTo takes an io.Writer and writes the bytes for each token to it, along with the spacing that separates each token. In other words, this allows serializing the tokens to a file or other such byte stream.

Source Files ¶

View all Source files

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