The highest tagged major version is
README
¶
Editorconfig Core Go
A Editorconfig file parser and manipulator for Go.
This package is already working, but still under testing.
Installing
go get -u gopkg.in/editorconfig/editorconfig-core-go.v1
Usage
Parse from file
editorConfig, err := editorconfig.ParseFile("path/to/.editorconfig")
if err != nil {
log.Fatal(err)
}
Parse from slice of bytes
data := []byte("...")
editorConfig, err := editorconfig.ParseBytes(data)
if err != nil {
log.Fatal(err)
}
Get definition to a given filename
This method builds a definition to a given filename. This definition is a merge of the properties with selectors that matched the given filename. The lasts sections of the file have preference over the priors.
def := editorConfig.GetDefinitionForFilename("my/file.go")
This definition have the following properties:
type Definition struct {
Selector string
Charset string
IndentStyle string
IndentSize string
TabWidth int
EndOfLine string
TrimTrailingWhitespace bool
InsertFinalNewline bool
}
Generating a .editorconfig file
You can easily convert a Editorconfig struct to a compatible INI file:
// serialize to slice of bytes
data, err := editorConfig.Serialize()
if err != nil {
log.Fatal(err)
}
// save directly to file
err := editorConfig.Save("path/to/.editorconfig")
if err != nil {
log.Fatal(err)
}
Contributing
To run the tests:
go test
Documentation
¶
Overview ¶
Package editorconfig can be used to parse and generate editorconfig files. For more information about editorconfig, see http://editorconfig.org/
Index ¶
Constants ¶
const ( IndentStyleTab = "tab" IndentStyleSpaces = "space" )
IndentStyle possible values
const ( EndOfLineLf = "lf" EndOfLineCr = "cr" EndOfLineCrLf = "crlf" )
EndOfLine possible values
const ( CharsetLatin1 = "latin1" CharsetUTF8 = "utf-8" CharsetUTF16BE = "utf-16be" CharsetUTF16LE = "utf-16le" )
Charset possible values
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Definition ¶
type Definition struct {
Selector string `ini:"-"`
Charset string `ini:"charset"`
IndentStyle string `ini:"indent_style"`
IndentSize string `ini:"indent_size"`
TabWidth int `ini:"tab_width"`
EndOfLine string `ini:"end_of_line"`
TrimTrailingWhitespace bool `ini:"trim_trailing_whitespace"`
InsertFinalNewline bool `ini:"insert_final_newline"`
}
Definition represents a definition inside the .editorconfig file. E.g. a section of the file. The definition is composed of the selector ("*", "*.go", "*.{js.css}", etc), plus the properties of the selected files.
type Editorconfig ¶
type Editorconfig struct {
Root bool
Definitions []*Definition
}
Editorconfig represents a .editorconfig file. It is composed by a "root" property, plus the definitions defined in the file.
func ParseBytes ¶
func ParseBytes(data []byte) (*Editorconfig, error)
ParseBytes parses from a slice of bytes.
func (*Editorconfig) GetDefinitionForFilename ¶
func (e *Editorconfig) GetDefinitionForFilename(name string) *Definition
GetDefinitionForFilename returns a definition for the given filename. The result is a merge of the selectors that matched the file. The last section has preference over the priors.
func (*Editorconfig) Save ¶
func (e *Editorconfig) Save(filename string) error
Save saves the Editorconfig to a compatible INI file.
func (*Editorconfig) Serialize ¶
func (e *Editorconfig) Serialize() ([]byte, error)
Serialize converts the Editorconfig to a slice of bytes, containing the content of the file in the INI format.
Source Files