editorconfig-core-go 使用指南

editorconfig-core-go 是一个用于解析和操作 EditorConfig 文件的 Go 语言库。EditorConfig 是一种帮助开发者在不同编辑器和 IDE 中保持一致的编码风格的工具。

安装

go get github.com/editorconfig/editorconfig-core-go/v2

基本用法

1. 解析 EditorConfig 文件

package main

import (
	"fmt"
	"github.com/editorconfig/editorconfig-core-go/v2"
)

func main() {
	// 解析指定文件的 EditorConfig 配置
	config, err := editorconfig.GetConfigForFilename("path/to/your/file.go")
	if err != nil {
		panic(err)
	}

	// 打印所有配置项
	for name, def := range config.Definitions {
		fmt.Printf("%s = %s\n", name, def.Value)
	}
}

2. 获取特定属性

// 获取缩进样式
indentStyle := config.Definitions["indent_style"]
fmt.Printf("缩进样式: %s\n", indentStyle.Value)

// 获取缩进大小
indentSize := config.Definitions["indent_size"]
fmt.Printf("缩进大小: %s\n", indentSize.Value)

// 获取行尾样式
endOfLine := config.Definitions["end_of_line"]
fmt.Printf("行尾样式: %s\n", endOfLine.Value)

// 获取字符集
charset := config.Definitions["charset"]
fmt.Printf("字符集: %s\n", charset.Value)

// 获取是否修剪行尾空白
trimTrailingWhitespace := config.Definitions["trim_trailing_whitespace"]
fmt.Printf("修剪行尾空白: %s\n", trimTrailingWhitespace.Value)

// 获取文件末尾是否插入空行
insertFinalNewline := config.Definitions["insert_final_newline"]
fmt.Printf("文件末尾空行: %s\n", insertFinalNewline.Value)

3. 创建自定义 EditorConfig

package main

import (
	"fmt"
	"github.com/editorconfig/editorconfig-core-go/v2"
)

func main() {
	// 创建新的 EditorConfig
	config := editorconfig.New()

	// 添加定义
	config.Definitions["root"] = &editorconfig.Definition{Value: "true"}
	config.Definitions["indent_style"] = &editorconfig.Definition{Value: "space"}
	config.Definitions["indent_size"] = &editorconfig.Definition{Value: "4"}
	config.Definitions["end_of_line"] = &editorconfig.Definition{Value: "lf"}
	config.Definitions["charset"] = &editorconfig.Definition{Value: "utf-8"}
	config.Definitions["trim_trailing_whitespace"] = &editorconfig.Definition{Value: "true"}
	config.Definitions["insert_final_newline"] = &editorconfig.Definition{Value: "true"}

	// 打印配置
	for name, def := range config.Definitions {
		fmt.Printf("%s = %s\n", name, def.Value)
	}
}

4. 处理多个文件模式

package main

import (
	"fmt"
	"github.com/editorconfig/editorconfig-core-go/v2"
)

func main() {
	// 解析 .editorconfig 文件
	config, err := editorconfig.ParseFile(".editorconfig")
	if err != nil {
		panic(err)
	}

	// 遍历所有部分
	for _, section := range config.Sections {
		fmt.Printf("模式: %s\n", section.Selector)
		for name, def := range section.Definitions {
			fmt.Printf("  %s = %s\n", name, def.Value)
		}
	}
}

高级用法

1. 自定义解析器选项

package main

import (
	"fmt"
	"github.com/editorconfig/editorconfig-core-go/v2"
)

func main() {
	// 创建解析器选项
	options := &editorconfig.Config{
		Version: "0.15.0", // 指定 EditorConfig 版本
		Parser: editorconfig.ParserOptions{
			StopOnFirstError: true, // 遇到第一个错误时停止
		},
	}

	// 使用自定义选项解析
	config, err := editorconfig.ParseFileWithConfig(".editorconfig", options)
	if err != nil {
		panic(err)
	}

	// 使用配置...
}

2. 处理不同编码

package main

import (
	"fmt"
	"github.com/editorconfig/editorconfig-core-go/v2"
)

func main() {
	config, err := editorconfig.ParseFile(".editorconfig")
	if err != nil {
		panic(err)
	}

	// 检查文件编码
	charset := config.Definitions["charset"]
	if charset != nil {
		switch charset.Value {
		case "utf-8":
			fmt.Println("使用 UTF-8 编码")
		case "utf-8-bom":
			fmt.Println("使用带 BOM 的 UTF-8 编码")
		case "latin1":
			fmt.Println("使用 Latin1 编码")
		default:
			fmt.Printf("未知编码: %s\n", charset.Value)
		}
	}
}

实际应用示例

验证文件是否符合 EditorConfig 规范

package main

import (
	"fmt"
	"os"
	"github.com/editorconfig/editorconfig-core-go/v2"
)

func checkFileCompliance(filename string) error {
	// 获取文件的 EditorConfig 配置
	config, err := editorconfig.GetConfigForFilename(filename)
	if err != nil {
		return err
	}

	// 读取文件内容
	content, err := os.ReadFile(filename)
	if err != nil {
		return err
	}

	// 检查行尾
	if eol := config.Definitions["end_of_line"]; eol != nil {
		hasCR := false
		hasLF := false
		for _, b := range content {
			if b == '\r' {
				hasCR = true
			} else if b == '\n' {
				hasLF = true
			}
		}

		switch eol.Value {
		case "lf":
			if hasCR {
				return fmt.Errorf("文件包含 CR 字符，但要求使用 LF 行尾")
			}
		case "crlf":
			if !hasCR || !hasLF {
				return fmt.Errorf("文件不符合 CRLF 行尾要求")
			}
		case "cr":
			if hasLF {
				return fmt.Errorf("文件包含 LF 字符，但要求使用 CR 行尾")
			}
		}
	}

	// 这里可以添加更多检查，如缩进、尾随空格等

	return nil
}

func main() {
	filename := "example.go"
	if err := checkFileCompliance(filename); err != nil {
		fmt.Printf("文件 %s 不符合 EditorConfig 规范: %v\n", filename, err)
	} else {
		fmt.Printf("文件 %s 符合 EditorConfig 规范\n", filename)
	}
}

注意事项

1. editorconfig-core-go 遵循 EditorConfig 规范，但不执行实际的代码格式化
2. 该库主要用于解析和查询 EditorConfig 配置
3. 对于实际格式化，需要结合其他工具使用
4. 在 Windows 上路径处理可能需要特别注意

通过 editorconfig-core-go，你可以轻松地将 EditorConfig 支持集成到你的 Go 应用程序中，确保代码风格的一致性。