EditorConfig Core written in Go
Go Makefile
Switch branches/tags
Clone or download
Latest commit a180556 Jul 26, 2018
Permalink
Failed to load latest commit information.
cmd/editorconfig Fix editorconfig package import Jul 25, 2018
core-test @ 0001aa2 Add core-test submodule Jul 23, 2018
testdata Update tests Jul 19, 2018
.editorconfig Update .editorconfig Jul 25, 2018
.gitattributes
.gitignore Add /editorconfig to .gitignore Jul 26, 2018
.gitmodules Add core-test submodule Jul 23, 2018
.travis.yml Fix Makefile targets (#8) Jul 26, 2018
LICENSE Update LICENSE Jul 3, 2016
Makefile Fix Makefile targets (#8) Jul 26, 2018
README.md Typo on string #19 Jul 25, 2018
editorconfig.go
editorconfig_test.go Update tests Jul 19, 2018

README.md

Build Status GoDoc Go Report Card

Editorconfig Core Go

A Editorconfig file parser and manipulator for Go.

This package is already working, but still under testing.

Installing

We recommend the use of gopkg.in for this package:

go get -u gopkg.in/editorconfig/editorconfig-core-go.v1

Import by the same path. The package name you will use to access it is editorconfig.

import (
    "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
}

Automatic search for .editorconfig files

If you want a definition of a file without having to manually parse the .editorconfig files, you can then use the static version of GetDefinitionForFilename:

def, err := editorconfig.GetDefinitionForFilename("foo/bar/baz/my-file.go")

In the example above, the package will automatically search for .editorconfig files on:

  • foo/bar/baz/.editorconfig
  • foo/baz/.editorconfig
  • foo/.editorconfig

Until it reaches a file with root = true or the root of the filesystem.

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 -v