common

Documentation

Index

• Variables
• func DoNotEdit(src []byte) bool
• func GitChangeFiles() ([]string, error)
• func ParseFile(fileName string, src []byte) (fileSet *token.FileSet, file *ast.File, err error)
• func PrintCode(fileSet *token.FileSet, file *ast.File) (out []byte, err error)
• type ImportGroupFunc
• type Options
  • func NewDefaultOptions() *Options
  • func (opt *Options) AllGoFiles() ([]string, error)
  • func (opt *Options) BindFlags()
  • func (opt *Options) Check() error
  • func (opt *Options) GetImportGroup(t byte) int

Variables

var Version = "v0.2.8 20220305"

Version 版本信息

Functions

func DoNotEdit

func DoNotEdit(src []byte) bool

DoNotEdit 该代码是否不让修改，一般是有代码工具自动生成

func GitChangeFiles

func GitChangeFiles() ([]string, error)

GitChangeFiles 获取当前git项目有变更的文件 支持如下git状态: M auth/md5_sign.go R utils/counter_test.go -> component/counter/counter_test.go A unittest/internal/monitor/bvar.apis_monitor.data ?? internal/gofmt/files.go

func ParseFile

func ParseFile(fileName string, src []byte) (fileSet *token.FileSet, file *ast.File, err error)

ParseFile 解析为astFile

func PrintCode

func PrintCode(fileSet *token.FileSet, file *ast.File) (out []byte, err error)

PrintCode 输出代码

Types

type ImportGroupFunc

type ImportGroupFunc func(importPath string, opt *Options) int

ImportGroupFunc import 排序逻辑

type Options

type Options struct {
	Trace bool

	TabIndent bool

	TabWidth int

	// LocalPrefix 当前模块的前缀
	LocalPrefix string

	// Write 是否直接将格式化后的内容写入文件
	Write bool

	// Simplify  是否简化代码
	Simplify bool

	// 待处理的文件列表
	Files []string

	ImportGroupFn ImportGroupFunc

	// 是否将多段 import 合并为一个
	MergeImports bool

	// SingleLineCopyright 是否将 copyright 的多行注释格式化为单行注释
	SingleLineCopyright bool

	// import 分组的排序规则,可选
	// 总共 可分为 3 组，分别是 标准库(简称 s)，第三方库(简称 t)，模块自身(简称 c)
	// stc: 默认的排序规则
	// sct: Go 源码中的排序规则
	ImportGroupRule string
}

Options 选项

func NewDefaultOptions

func NewDefaultOptions() *Options

NewDefaultOptions 生成默认的 options

func (*Options) AllGoFiles

func (opt *Options) AllGoFiles() ([]string, error)

AllGoFiles 获取所有的待格式化的 .go 文件

func (*Options) BindFlags

func (opt *Options) BindFlags()

BindFlags 绑定参数信息

func (*Options) Check

func (opt *Options) Check() error

Check 简称 option 是否正确

func (*Options) GetImportGroup

func (opt *Options) GetImportGroup(t byte) int

GetImportGroup 读取 import 分组的排序