format

package

v2.10.0-pre Latest Latest Go to latest Published: May 9, 2025 License: Apache-2.0 Imports: 12 Imported by: 1

Details

This section is empty.

This section is empty.

func BruteForceIndentation(ctx context.Context, startIndentation string, cfg Configuration, input io.Reader) (io.Reader, error)

func BuildTabWriter(writer io.Writer) *tabwriter.Writer

func Format(ctx context.Context, provider Provider, cfg ConfigurationProvider, filename string, fle io.Reader) (io.Reader, error)

func FormatSimple(ctx context.Context, provider Provider, filename string, useTabs bool, indentSize int, input io.Reader) (io.Reader, error)

func FormatSimpleBytes(ctx context.Context, provider Provider, filename string, useTabs bool, indentSize int, input []byte) ([]byte, error)

func HasShebang(bs []byte) bool

HasShebang reports whether bs begins with a valid shell shebang. It supports variations with /usr and env.

func Shebang(bs []byte) string

Shebang parses a "#!" sequence from the beginning of the input bytes, and returns the shell that it points to.

For instance, it returns "sh" for "#!/bin/sh", and "bash" for "#!/usr/bin/env bash".

type Configuration interface {
	UseTabs() bool
	IndentSize() int
	Raw() map[string]string
}

func NewBasicConfigurationProvider(tabs bool, indentSize int) Configuration

type ConfigurationProvider interface {
	GetConfigurationForFileType(ctx context.Context, filename string) (Configuration, error)
}

func NewDefaultConfigurationProvider() ConfigurationProvider

type LazyFormatProvider struct {
	// contains filtered or unexported fields
}

func NewLazyFormatProvider(providerFunc func() Provider) *LazyFormatProvider

func (p *LazyFormatProvider) Format(ctx context.Context, cfg Configuration, reader io.Reader) (io.Reader, error)

type Provider interface {
	Format(ctx context.Context, cfg Configuration, reader io.Reader) (io.Reader, error)
}