README.zh.md

formatgo

formatgo 是一个 Go 包，用于格式化 Go 源代码，无论是字节切片、字符串还是文件，甚至是包含 Go 文件的整个目录。

英文文档

English README

安装

你可以通过以下命令安装 formatgo 包：

go get github.com/yyle88/formatgo

使用方法

该包提供了多个函数来格式化 Go 代码，下面是主要的函数及其用法：

FormatBytes

从字节切片格式化 Go 源代码。

formattedCode, err := formatgo.FormatBytes(code []byte)

• code: Go 源代码（字节切片）。
• 返回值：格式化后的代码（字节切片）或者格式化出错时的错误。

FormatCode

从字符串格式化 Go 源代码。

formattedCode, err := formatgo.FormatCode(code string)

• code: Go 源代码（字符串）。
• 返回值：格式化后的代码（字符串）或者格式化出错时的错误。

FormatFile

格式化指定路径下的 Go 源代码文件。

err := formatgo.FormatFile(path string)

• path: Go 源代码文件的路径。
• 返回值：格式化失败时的错误。

FormatRoot

格式化指定根目录及其子目录下的所有 Go 源代码文件。

err := formatgo.FormatRoot(root string)

• root: 要开始格式化的根目录路径。
• 返回值：格式化过程中发生错误时的错误。

示例

以下是一个简单的例子，演示如何从字符串格式化 Go 代码：

package main

import (
	"fmt"
	"github.com/yyle88/formatgo"
)

func main() {
	code := `package main

import "fmt"

func main() {fmt.Println("Hello, world!")}`
	
	formattedCode, err := formatgo.FormatCode(code)
	if err != nil {
		fmt.Println("格式化代码时出错:", err)
		return
	}
	
	fmt.Println("格式化后的代码:", formattedCode)
}

许可证

formatgo 是开源项目，采用 MIT 许可证。详情请查看 LICENSE 文件。

贡献与支持

欢迎通过提交 pull request 或报告问题来贡献此项目。

如果你觉得这个包对你有帮助，请在 GitHub 上给个 ⭐，感谢支持！！！

感谢你的支持！

祝编程愉快！ 🎉

Give me stars. Thank you!!!