Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

replace log with logrus #52

Merged
merged 3 commits into from
Mar 18, 2022
Merged

replace log with logrus #52

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d653058
replace log with logrus
glightfoot Mar 3, 2022
66b9393
enable terminal colors
glightfoot Mar 10, 2022
1f8136b
add pretty print log functions for imports
glightfoot Mar 10, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions cmd/gci/gcicommand.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ import (
"github.com/daixiang0/gci/pkg/constants"
"github.com/daixiang0/gci/pkg/gci"
sectionsPkg "github.com/daixiang0/gci/pkg/gci/sections"
log "github.com/sirupsen/logrus"

"github.com/spf13/cobra"
)
Expand All @@ -28,6 +29,9 @@ func (e *Executor) newGciCommand(use, short, long string, aliases []string, stdI
if err != nil {
return err
}
if *debug {
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here we can support more levels more than debug.

log.SetLevel(log.DebugLevel)
}
return processingFunc(args, *gciCfg)
},
}
Expand Down
10 changes: 10 additions & 0 deletions cmd/gci/root.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,20 @@ import (

"github.com/daixiang0/gci/pkg/configuration"
"github.com/daixiang0/gci/pkg/gci"
log "github.com/sirupsen/logrus"

"github.com/spf13/cobra"
)

func init() {
log.SetFormatter(&log.TextFormatter{
DisableLevelTruncation: true,
FullTimestamp: true,
})

log.SetOutput(os.Stderr)
}

type Executor struct {
rootCmd *cobra.Command
diffMode *bool
Expand Down
4 changes: 2 additions & 2 deletions go.mod
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@ go 1.17

require (
github.com/hexops/gotextdiff v1.0.3
github.com/sirupsen/logrus v1.4.2
github.com/spf13/cobra v1.3.0
github.com/stretchr/testify v1.7.0
golang.org/x/sync v0.0.0-20210220032951-036812b2e83c
Expand All @@ -14,11 +15,10 @@ require (
require (
github.com/davecgh/go-spew v1.1.1 // indirect
github.com/inconshreveable/mousetrap v1.0.0 // indirect
github.com/kr/pretty v0.2.0 // indirect
github.com/konsorten/go-windows-terminal-sequences v1.0.1 // indirect
github.com/pmezard/go-difflib v1.0.0 // indirect
github.com/spf13/pflag v1.0.5 // indirect
golang.org/x/mod v0.5.0 // indirect
golang.org/x/sys v0.0.0-20211216021012-1d35b9e2eb4e // indirect
golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1 // indirect
gopkg.in/check.v1 v1.0.0-20190902080502-41f04d3bba15 // indirect
)
2 changes: 2 additions & 0 deletions go.sum
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -236,6 +236,7 @@ github.com/jstemmer/go-junit-report v0.9.1/go.mod h1:Brl9GWCQeLvo8nXZwPNNblvFj/X
github.com/julienschmidt/httprouter v1.2.0/go.mod h1:SYymIcj16QtmaHHD7aYtjjsJG7VTCxuUUipMqKk8s4w=
github.com/kisielk/errcheck v1.5.0/go.mod h1:pFxgyoBC7bSaBwPgfKdkLd5X25qrDl4LWUI2bnpBCr8=
github.com/kisielk/gotool v1.0.0/go.mod h1:XhKaO+MFFWcvkIS/tQcRk01m1F5IRFswLeQ+oQHNcck=
github.com/konsorten/go-windows-terminal-sequences v1.0.1 h1:mweAR1A6xJ3oS2pRaGiHgQ4OO8tzTaLawm8vnODuwDk=
github.com/konsorten/go-windows-terminal-sequences v1.0.1/go.mod h1:T0+1ngSBFLxvqU3pZ+m/2kptfBszLMUkC4ZK/EgS/cQ=
github.com/kr/fs v0.1.0/go.mod h1:FFnZGqtBN9Gxj7eW1uZ42v5BccTP0vu6NEaFoC2HwRg=
github.com/kr/logfmt v0.0.0-20140226030751-b84e30acd515/go.mod h1:+0opPa2QZZtGFBFZlji/RkVcI2GknAs/DXo4wKdlNEc=
Expand Down Expand Up @@ -303,6 +304,7 @@ github.com/ryanuber/columnize v0.0.0-20160712163229-9b3edd62028f/go.mod h1:sm1tb
github.com/sagikazarmark/crypt v0.3.0/go.mod h1:uD/D+6UF4SrIR1uGEv7bBNkNqLGqUr43MRiaGWX1Nig=
github.com/sean-/seed v0.0.0-20170313163322-e2103e2c3529/go.mod h1:DxrIzT+xaE7yg65j358z/aeFdxmN0P9QXhEzd20vsDc=
github.com/sirupsen/logrus v1.2.0/go.mod h1:LxeOpSwHxABJmUn/MG1IvRgCAasNZTLOkJPxbbu5VWo=
github.com/sirupsen/logrus v1.4.2 h1:SPIRibHv4MatM3XXNO2BJeFLZwZ2LvZgfQ5+UNI2im4=
github.com/sirupsen/logrus v1.4.2/go.mod h1:tLMulIdttU9McNUspp0xgXVQah82FyeX6MwdIuYE2rE=
github.com/spaolacci/murmur3 v0.0.0-20180118202830-f09979ecbc72/go.mod h1:JwIasOWyU6f++ZhiEuf87xNszmSA2myDM2Kzu9HwQUA=
github.com/spf13/afero v1.3.3/go.mod h1:5KUK8ByomD5Ti5Artl0RtHeI5pTF7MIDuXL3yY520V4=
Expand Down
31 changes: 21 additions & 10 deletions pkg/gci/format.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,14 @@ package gci
import (
"bytes"
"fmt"
"log"
"strings"

"github.com/daixiang0/gci/pkg/constants"
importPkg "github.com/daixiang0/gci/pkg/gci/imports"
sectionsPkg "github.com/daixiang0/gci/pkg/gci/sections"
"github.com/daixiang0/gci/pkg/gci/specificity"

log "github.com/sirupsen/logrus"
)

// Formats the import section of a Go file
Expand Down Expand Up @@ -37,6 +38,20 @@ func formatGoFile(input []byte, cfg GciConfiguration) ([]byte, error) {
return output, nil
}

// pprintImports prints the imports without quotes for logging
func pprintImports(imports []importPkg.ImportDef) string {
var sb strings.Builder
sb.WriteRune('[')
for i, imprt := range imports {
if i != 0 {
sb.WriteRune(' ')
}
sb.WriteString(imprt.UnquotedString())
}
sb.WriteRune(']')
return sb.String()
}

// Takes unsorted imports as byte array and formats them according to the specified sections
func formatImportBlock(input []byte, cfg GciConfiguration) ([]byte, error) {
//strings.ReplaceAll(input, "\r\n", linebreak)
Expand All @@ -45,9 +60,8 @@ func formatImportBlock(input []byte, cfg GciConfiguration) ([]byte, error) {
if err != nil {
return nil, fmt.Errorf("an error occured while trying to parse imports: %w", err)
}
if cfg.Debug {
log.Println("Parsed imports in file:", imports)
}
log.WithField("imports", pprintImports(imports)).Debug("Parsed imports in file")

// create mapping between sections and imports
sectionMap := make(map[sectionsPkg.Section][]importPkg.ImportDef, len(cfg.Sections))
// find matching section for every importSpec
Expand All @@ -70,9 +84,8 @@ func formatImportBlock(input []byte, cfg GciConfiguration) ([]byte, error) {
if bestSection == nil {
return nil, NoMatchingSectionForImportError{i}
}
if cfg.Debug {
log.Printf("Matched import %s to section %s", i, bestSection)
}
log.WithFields(log.Fields{"import": i.UnquotedString(), "section": bestSection}).Debug("Matched import to section")

sectionMap[bestSection] = append(sectionMap[bestSection], i)
}
// format every section to a str
Expand All @@ -81,9 +94,7 @@ func formatImportBlock(input []byte, cfg GciConfiguration) ([]byte, error) {
sectionStr := section.Format(sectionMap[section], cfg.FormatterConfiguration)
// prevent adding an empty section which would cause a separator to be inserted
if sectionStr != "" {
if cfg.Debug {
log.Printf("Formatting section %s with imports: %v", section, sectionMap[section])
}
log.WithFields(log.Fields{"imports": pprintImports(sectionMap[section]), "section": section}).Debug("Formatting section with imports")
sectionStrings = append(sectionStrings, sectionStr)
}
}
Expand Down
10 changes: 5 additions & 5 deletions pkg/gci/gci.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@ import (
"bytes"
"errors"
"fmt"
"log"
"os"

sectionsPkg "github.com/daixiang0/gci/pkg/gci/sections"
Expand All @@ -13,6 +12,7 @@ import (
"github.com/hexops/gotextdiff"
"github.com/hexops/gotextdiff/myers"
"github.com/hexops/gotextdiff/span"
log "github.com/sirupsen/logrus"
"golang.org/x/sync/errgroup"
)

Expand Down Expand Up @@ -52,10 +52,10 @@ func PrintFormattedFiles(paths []string, cfg GciConfiguration) error {
func WriteFormattedFiles(paths []string, cfg GciConfiguration) error {
return processGoFilesInPaths(paths, cfg, func(filePath string, unmodifiedFile, formattedFile []byte) error {
if bytes.Equal(unmodifiedFile, formattedFile) {
log.Printf("Skipping correctly formatted File: %s", filePath)
log.WithField("file", filePath).Debug("Skipping correctly formatted file")
return nil
}
log.Printf("Writing formatted File: %s", filePath)
log.WithField("file", filePath).Info("Writing formatted file")
return os.WriteFile(filePath, formattedFile, 0644)
})
}
Expand Down Expand Up @@ -109,7 +109,7 @@ func processingFunc(file io.FileObj, cfg GciConfiguration, formattingFunc fileFo

func LoadFormatGoFile(file io.FileObj, cfg GciConfiguration) (unmodifiedFile, formattedFile []byte, err error) {
unmodifiedFile, err = file.Load()
log.Printf("Loaded File: %s", file.Path())
log.WithField("file", file.Path()).Debug("Loaded file")
if err != nil {
return nil, nil, err
}
Expand All @@ -120,7 +120,7 @@ func LoadFormatGoFile(file io.FileObj, cfg GciConfiguration) (unmodifiedFile, fo
if !errors.Is(err, MissingImportStatementError) {
return unmodifiedFile, nil, err
}
log.Printf("File does not contain an import statement: %s", file.Path())
log.WithField("file", file.Path()).Debug("File does not contain an import statement")
formattedFile = unmodifiedFile
}
return unmodifiedFile, formattedFile, nil
Expand Down
5 changes: 5 additions & 0 deletions pkg/gci/imports/import.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,11 @@ func (i ImportDef) String() string {
return i.QuotedPath
}

// useful for logging statements
func (i ImportDef) UnquotedString() string {
return strings.Trim(i.QuotedPath, "\"")
}

func (i ImportDef) Format(cfg configuration.FormatterConfiguration) string {
linePrefix := constants.Indent
var output string
Expand Down