151 lines
3.2 KiB
Go
151 lines
3.2 KiB
Go
package format
|
|
|
|
import (
|
|
"bytes"
|
|
"fmt"
|
|
"io"
|
|
"os"
|
|
"path/filepath"
|
|
"strings"
|
|
|
|
"git.ipao.vip/rogeecn/atomctl/pkg/swag"
|
|
)
|
|
|
|
// Format implements `fmt` command for formatting swag comments in Go source
|
|
// files.
|
|
type Format struct {
|
|
formatter *swag.Formatter
|
|
|
|
// exclude exclude dirs and files in SearchDir
|
|
exclude map[string]bool
|
|
}
|
|
|
|
// New creates a new Format instance
|
|
func New() *Format {
|
|
return &Format{
|
|
exclude: map[string]bool{},
|
|
formatter: swag.NewFormatter(),
|
|
}
|
|
}
|
|
|
|
// Config specifies configuration for a format run
|
|
type Config struct {
|
|
// SearchDir the swag would be parse
|
|
SearchDir string
|
|
|
|
// excludes dirs and files in SearchDir,comma separated
|
|
Excludes string
|
|
|
|
// MainFile (DEPRECATED)
|
|
MainFile string
|
|
}
|
|
|
|
var defaultExcludes = []string{"docs", "vendor"}
|
|
|
|
// Build runs formatter according to configuration in config
|
|
func (f *Format) Build(config *Config) error {
|
|
searchDirs := strings.Split(config.SearchDir, ",")
|
|
for _, searchDir := range searchDirs {
|
|
if _, err := os.Stat(searchDir); os.IsNotExist(err) {
|
|
return fmt.Errorf("fmt: %w", err)
|
|
}
|
|
for _, d := range defaultExcludes {
|
|
f.exclude[filepath.Join(searchDir, d)] = true
|
|
}
|
|
}
|
|
for _, fi := range strings.Split(config.Excludes, ",") {
|
|
if fi = strings.TrimSpace(fi); fi != "" {
|
|
f.exclude[filepath.Clean(fi)] = true
|
|
}
|
|
}
|
|
for _, searchDir := range searchDirs {
|
|
err := filepath.Walk(searchDir, f.visit)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func (f *Format) visit(path string, fileInfo os.FileInfo, err error) error {
|
|
if fileInfo.IsDir() && f.excludeDir(path) {
|
|
return filepath.SkipDir
|
|
}
|
|
if f.excludeFile(path) {
|
|
return nil
|
|
}
|
|
if err := f.format(path); err != nil {
|
|
return fmt.Errorf("fmt: %w", err)
|
|
}
|
|
return nil
|
|
}
|
|
|
|
func (f *Format) excludeDir(path string) bool {
|
|
return f.exclude[path] ||
|
|
filepath.Base(path)[0] == '.' &&
|
|
len(filepath.Base(path)) > 1 // exclude hidden folders
|
|
}
|
|
|
|
func (f *Format) excludeFile(path string) bool {
|
|
return f.exclude[path] ||
|
|
strings.HasSuffix(strings.ToLower(path), "_test.go") ||
|
|
filepath.Ext(path) != ".go"
|
|
}
|
|
|
|
func (f *Format) format(path string) error {
|
|
original, err := os.ReadFile(path)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
contents := make([]byte, len(original))
|
|
copy(contents, original)
|
|
formatted, err := f.formatter.Format(path, contents)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
if bytes.Equal(original, formatted) {
|
|
// Skip write if no change
|
|
return nil
|
|
}
|
|
return write(path, formatted)
|
|
}
|
|
|
|
func write(path string, contents []byte) error {
|
|
originalFileInfo, err := os.Stat(path)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
f, err := os.CreateTemp(filepath.Dir(path), filepath.Base(path))
|
|
if err != nil {
|
|
return err
|
|
}
|
|
defer os.Remove(f.Name())
|
|
if _, err := f.Write(contents); err != nil {
|
|
return err
|
|
}
|
|
if err := f.Close(); err != nil {
|
|
return err
|
|
}
|
|
if err := os.Chmod(f.Name(), originalFileInfo.Mode()); err != nil {
|
|
return err
|
|
}
|
|
return os.Rename(f.Name(), path)
|
|
}
|
|
|
|
// Run the format on src and write the result to dst.
|
|
func (f *Format) Run(src io.Reader, dst io.Writer) error {
|
|
contents, err := io.ReadAll(src)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
result, err := f.formatter.Format("", contents)
|
|
if err != nil {
|
|
return err
|
|
}
|
|
r := bytes.NewReader(result)
|
|
if _, err := io.Copy(dst, r); err != nil {
|
|
return err
|
|
}
|
|
return nil
|
|
}
|