2020-10-16 07:06:27 +02:00
|
|
|
![Build Status](https://github.com/editorconfig/editorconfig-core-go/workflows/.github/workflows/main.yml/badge.svg)
|
2019-10-15 23:24:16 +02:00
|
|
|
[![GoDoc](https://godoc.org/github.com/editorconfig/editorconfig-core-go?status.svg)](https://godoc.org/github.com/editorconfig/editorconfig-core-go)
|
|
|
|
[![Go Report Card](https://goreportcard.com/badge/github.com/editorconfig/editorconfig-core-go)](https://goreportcard.com/report/github.com/editorconfig/editorconfig-core-go)
|
2019-03-27 12:15:23 +01:00
|
|
|
|
|
|
|
# Editorconfig Core Go
|
|
|
|
|
|
|
|
A [Editorconfig][editorconfig] file parser and manipulator for Go.
|
|
|
|
|
2019-10-15 23:24:16 +02:00
|
|
|
## Missing features
|
2019-03-27 12:15:23 +01:00
|
|
|
|
2019-10-15 23:24:16 +02:00
|
|
|
- escaping comments in values, probably in [go-ini/ini](https://github.com/go-ini/ini)
|
2021-03-01 00:08:33 +01:00
|
|
|
- [adjacent nested braces](https://github.com/editorconfig/editorconfig-core-test/pull/44)
|
2019-03-27 12:15:23 +01:00
|
|
|
|
2019-10-15 23:24:16 +02:00
|
|
|
## Installing
|
|
|
|
|
2020-10-16 07:06:27 +02:00
|
|
|
We recommend the use of Go 1.13+ modules for this package.
|
2019-03-27 12:15:23 +01:00
|
|
|
|
2019-08-05 09:52:41 +02:00
|
|
|
Import by the same path. The package name you will use to access it is
|
2019-03-27 12:15:23 +01:00
|
|
|
`editorconfig`.
|
|
|
|
|
|
|
|
```go
|
2020-10-16 07:06:27 +02:00
|
|
|
import "github.com/editorconfig/editorconfig-core-go/v2"
|
2019-03-27 12:15:23 +01:00
|
|
|
```
|
|
|
|
|
|
|
|
## Usage
|
|
|
|
|
|
|
|
### Parse from file
|
|
|
|
|
|
|
|
```go
|
2020-10-16 07:06:27 +02:00
|
|
|
fp, err := os.Open("path/to/.editorconfig")
|
|
|
|
if err != nil {
|
|
|
|
log.Fatal(err)
|
|
|
|
}
|
|
|
|
defer fp.Close()
|
|
|
|
|
|
|
|
editorConfig, err := editorconfig.Parse(fp)
|
2019-03-27 12:15:23 +01:00
|
|
|
if err != nil {
|
2020-10-16 07:06:27 +02:00
|
|
|
log.Fatal(err)
|
2019-03-27 12:15:23 +01:00
|
|
|
}
|
|
|
|
```
|
|
|
|
|
|
|
|
### Parse from slice of bytes
|
|
|
|
|
|
|
|
```go
|
|
|
|
data := []byte("...")
|
|
|
|
editorConfig, err := editorconfig.ParseBytes(data)
|
|
|
|
if err != nil {
|
2020-10-16 07:06:27 +02:00
|
|
|
log.Fatal(err)
|
2019-03-27 12:15:23 +01:00
|
|
|
}
|
|
|
|
```
|
|
|
|
|
|
|
|
### 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.
|
|
|
|
|
|
|
|
```go
|
|
|
|
def := editorConfig.GetDefinitionForFilename("my/file.go")
|
|
|
|
```
|
|
|
|
|
|
|
|
This definition have the following properties:
|
|
|
|
|
|
|
|
```go
|
|
|
|
type Definition struct {
|
|
|
|
Selector string
|
|
|
|
|
|
|
|
Charset string
|
|
|
|
IndentStyle string
|
|
|
|
IndentSize string
|
|
|
|
TabWidth int
|
|
|
|
EndOfLine string
|
2020-10-16 07:06:27 +02:00
|
|
|
TrimTrailingWhitespace *bool
|
|
|
|
InsertFinalNewline *bool
|
2019-10-15 23:24:16 +02:00
|
|
|
Raw map[string]string
|
2019-03-27 12:15:23 +01:00
|
|
|
}
|
|
|
|
```
|
|
|
|
|
|
|
|
#### 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`:
|
|
|
|
|
|
|
|
```go
|
|
|
|
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:
|
|
|
|
|
|
|
|
```go
|
|
|
|
// serialize to slice of bytes
|
|
|
|
data, err := editorConfig.Serialize()
|
|
|
|
if err != nil {
|
2020-10-16 07:06:27 +02:00
|
|
|
log.Fatal(err)
|
2019-03-27 12:15:23 +01:00
|
|
|
}
|
|
|
|
|
|
|
|
// save directly to file
|
|
|
|
err := editorConfig.Save("path/to/.editorconfig")
|
|
|
|
if err != nil {
|
2020-10-16 07:06:27 +02:00
|
|
|
log.Fatal(err)
|
2019-03-27 12:15:23 +01:00
|
|
|
}
|
|
|
|
```
|
|
|
|
|
|
|
|
## Contributing
|
|
|
|
|
|
|
|
To run the tests:
|
|
|
|
|
|
|
|
```bash
|
2019-10-15 23:24:16 +02:00
|
|
|
go test -v ./...
|
2019-03-27 12:15:23 +01:00
|
|
|
```
|
|
|
|
|
2020-10-16 07:06:27 +02:00
|
|
|
To run the [integration tests](https://github.com/editorconfig/editorconfig-core-test):
|
|
|
|
|
|
|
|
```
|
|
|
|
make test-core
|
|
|
|
```
|
|
|
|
|
|
|
|
[editorconfig]: https://editorconfig.org/
|