section

Documentation

Index

• Constants
• Variables
• type Alias
  • func (b Alias) MatchSpecificity(spec *parse.GciImports) specificity.MatchSpecificity
  • func (b Alias) String() string
  • func (b Alias) Type() string
• type Blank
  • func (b Blank) MatchSpecificity(spec *parse.GciImports) specificity.MatchSpecificity
  • func (b Blank) String() string
  • func (b Blank) Type() string
• type CommentLine
  • func (c CommentLine) MatchSpecificity(spec *parse.GciImports) specificity.MatchSpecificity
  • func (c CommentLine) String() string
  • func (c CommentLine) Type() string
• type Custom
  • func (c Custom) MatchSpecificity(spec *parse.GciImports) specificity.MatchSpecificity
  • func (c Custom) String() string
  • func (c Custom) Type() string
• type Default
  • func (d Default) MatchSpecificity(spec *parse.GciImports) specificity.MatchSpecificity
  • func (d Default) String() string
  • func (d Default) Type() string
• type Dot
  • func (d Dot) MatchSpecificity(spec *parse.GciImports) specificity.MatchSpecificity
  • func (d Dot) String() string
  • func (d Dot) Type() string
• type EqualSpecificityMatchError
  • func (e EqualSpecificityMatchError) Error() string
  • func (e EqualSpecificityMatchError) Is(err error) bool
• type FileParsingError
  • func (f FileParsingError) Is(err error) bool
  • func (f FileParsingError) Unwrap() error
• type InvalidAliasSplitError
  • func (i InvalidAliasSplitError) Error() string
  • func (i InvalidAliasSplitError) Is(err error) bool
• type InvalidImportSplitError
  • func (i InvalidImportSplitError) Error() string
  • func (i InvalidImportSplitError) Is(err error) bool
• type LocalModule
  • func (m *LocalModule) Configure() error
  • func (m *LocalModule) MatchSpecificity(spec *parse.GciImports) specificity.MatchSpecificity
  • func (m *LocalModule) String() string
  • func (m *LocalModule) Type() string
• type NewLine
  • func (n NewLine) MatchSpecificity(spec *parse.GciImports) specificity.MatchSpecificity
  • func (n NewLine) String() string
  • func (n NewLine) Type() string
• type NoMatchingSectionForImportError
  • func (n NoMatchingSectionForImportError) Error() string
  • func (n NoMatchingSectionForImportError) Is(err error) bool
• type Section
• type SectionList
  • func DefaultSectionSeparators() SectionList
  • func DefaultSections() SectionList
  • func Parse(data []string) (SectionList, error)
  • func (list SectionList) String() []string
• type SectionParsingError
  • func (s SectionParsingError) Is(err error) bool
  • func (s SectionParsingError) Unwrap() error
  • func (s SectionParsingError) Wrap(sectionStr string) error
• type Standard
  • func (s Standard) MatchSpecificity(spec *parse.GciImports) specificity.MatchSpecificity
  • func (s Standard) String() string
  • func (s Standard) Type() string

Constants

const AliasType = "alias"

const BlankType = "blank"

const CustomSeparator = ","

CustomSeparator allows you to group multiple custom prefix together in the same section gci diff -s standard -s default -s prefix(github.com/company,gitlab.com/company,companysuffix)

const CustomType = "custom"

const DefaultType = "default"

const DotType = "dot"

const LocalModuleType = "localmodule"

const StandardType = "standard"

Variables

var (
	MissingImportStatementError   = FileParsingError{errors.New("no import statement present in File")}
	ImportStatementNotClosedError = FileParsingError{errors.New("import statement not closed")}
)

var MissingParameterClosingBracketsError = fmt.Errorf("section parameter is missing closing %q", utils.RightParenthesis)

var MoreThanOneOpeningQuotesError = fmt.Errorf("found more than one %q parameter start sequences", utils.RightParenthesis)

var SectionTypeDoesNotAcceptParametersError = errors.New("section type does not accept a parameter")

var SectionTypeDoesNotAcceptPrefixError = errors.New("section may not contain a Prefix")

var SectionTypeDoesNotAcceptSuffixError = errors.New("section may not contain a Suffix")

Types

type Alias

type Alias struct{}

func (Alias) MatchSpecificity

func (b Alias) MatchSpecificity(spec *parse.GciImports) specificity.MatchSpecificity

func (Alias) String

func (b Alias) String() string

func (Alias) Type

func (b Alias) Type() string

type Blank

type Blank struct{}

func (Blank) MatchSpecificity

func (b Blank) MatchSpecificity(spec *parse.GciImports) specificity.MatchSpecificity

func (Blank) String

func (b Blank) String() string

func (Blank) Type

func (b Blank) Type() string

type CommentLine

type CommentLine struct {
	Comment string
}

func (CommentLine) MatchSpecificity

func (c CommentLine) MatchSpecificity(spec *parse.GciImports) specificity.MatchSpecificity

func (CommentLine) String

func (c CommentLine) String() string

func (CommentLine) Type

func (c CommentLine) Type() string

type Custom

type Custom struct {
	Prefix string
}

func (Custom) MatchSpecificity

func (c Custom) MatchSpecificity(spec *parse.GciImports) specificity.MatchSpecificity

func (Custom) String

func (c Custom) String() string

func (Custom) Type

func (c Custom) Type() string

type Default

type Default struct{}

func (Default) MatchSpecificity

func (d Default) MatchSpecificity(spec *parse.GciImports) specificity.MatchSpecificity

func (Default) String

func (d Default) String() string

func (Default) Type

func (d Default) Type() string

type Dot

type Dot struct{}

func (Dot) MatchSpecificity

func (d Dot) MatchSpecificity(spec *parse.GciImports) specificity.MatchSpecificity

func (Dot) String

func (d Dot) String() string

func (Dot) Type

func (d Dot) Type() string

type EqualSpecificityMatchError

type EqualSpecificityMatchError struct {
	Imports            *parse.GciImports
	SectionA, SectionB Section
}

func (EqualSpecificityMatchError) Error

func (e EqualSpecificityMatchError) Error() string

func (EqualSpecificityMatchError) Is

func (e EqualSpecificityMatchError) Is(err error) bool

type FileParsingError

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

func (FileParsingError) Is

func (f FileParsingError) Is(err error) bool

func (FileParsingError) Unwrap

func (f FileParsingError) Unwrap() error

type InvalidAliasSplitError

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

func (InvalidAliasSplitError) Error

func (i InvalidAliasSplitError) Error() string

func (InvalidAliasSplitError) Is

func (i InvalidAliasSplitError) Is(err error) bool

type InvalidImportSplitError

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

func (InvalidImportSplitError) Error

func (i InvalidImportSplitError) Error() string

func (InvalidImportSplitError) Is

func (i InvalidImportSplitError) Is(err error) bool

type LocalModule

type LocalModule struct {
	Paths []string
}

func (*LocalModule) Configure

func (m *LocalModule) Configure() error

Configure configures the module section by finding the module for the current path

func (*LocalModule) MatchSpecificity

func (m *LocalModule) MatchSpecificity(spec *parse.GciImports) specificity.MatchSpecificity

func (*LocalModule) String

func (m *LocalModule) String() string

func (*LocalModule) Type

func (m *LocalModule) Type() string

type NewLine

type NewLine struct{}

func (NewLine) MatchSpecificity

func (n NewLine) MatchSpecificity(spec *parse.GciImports) specificity.MatchSpecificity

func (NewLine) String

func (n NewLine) String() string

func (NewLine) Type

func (n NewLine) Type() string

type NoMatchingSectionForImportError

type NoMatchingSectionForImportError struct {
	Imports *parse.GciImports
}

func (NoMatchingSectionForImportError) Error

func (n NoMatchingSectionForImportError) Error() string

func (NoMatchingSectionForImportError) Is

func (n NoMatchingSectionForImportError) Is(err error) bool

type Section

type Section interface {
	// MatchSpecificity returns how well an Import matches to this Section
	MatchSpecificity(spec *parse.GciImports) specificity.MatchSpecificity

	// String Implements the stringer interface
	String() string

	// return section type
	Type() string
}

Section defines a part of the formatted output.

type SectionList

type SectionList []Section

func DefaultSectionSeparators

func DefaultSectionSeparators() SectionList

func DefaultSections

func DefaultSections() SectionList

func Parse

func Parse(data []string) (SectionList, error)

func (SectionList) String

func (list SectionList) String() []string

type SectionParsingError

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

func (SectionParsingError) Is

func (s SectionParsingError) Is(err error) bool

func (SectionParsingError) Unwrap

func (s SectionParsingError) Unwrap() error

func (SectionParsingError) Wrap

func (s SectionParsingError) Wrap(sectionStr string) error

type Standard

type Standard struct{}

func (Standard) MatchSpecificity

func (s Standard) MatchSpecificity(spec *parse.GciImports) specificity.MatchSpecificity

func (Standard) String

func (s Standard) String() string

func (Standard) Type

func (s Standard) Type() string