Skip to content

Commit

Permalink
feat: suppress debug logs when using -q (#1254)
Browse files Browse the repository at this point in the history
  • Loading branch information
Jake-Convictional committed Jul 19, 2022
1 parent 401e414 commit 89c61d4
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 6 deletions.
2 changes: 1 addition & 1 deletion cmd/swag/main.go
Expand Up @@ -143,7 +143,7 @@ func initAction(ctx *cli.Context) error {
if len(outputTypes) == 0 {
return fmt.Errorf("no output types specified")
}
var logger swag.Debugger
logger := log.New(os.Stdout, "", log.LstdFlags)
if ctx.Bool(quietFlag) {
logger = log.New(ioutil.Discard, "", log.LstdFlags)
}
Expand Down
20 changes: 15 additions & 5 deletions gen/gen.go
Expand Up @@ -33,6 +33,12 @@ type Gen struct {
jsonIndent func(data interface{}) ([]byte, error)
jsonToYAML func(data []byte) ([]byte, error)
outputTypeMap map[string]genTypeWriter
debug Debugger
}

// Debugger is the interface that wraps the basic Printf method.
type Debugger interface {
Printf(format string, v ...interface{})
}

// New creates a new Gen.
Expand All @@ -43,6 +49,7 @@ func New() *Gen {
return json.MarshalIndent(data, "", " ")
},
jsonToYAML: yaml.JSONToYAML,
debug: log.New(os.Stdout, "", log.LstdFlags),
}

gen.outputTypeMap = map[string]genTypeWriter{
Expand Down Expand Up @@ -117,6 +124,9 @@ type Config struct {

// Build builds swagger json file for given searchDir and mainAPIFile. Returns json.
func (g *Gen) Build(config *Config) error {
if config.Debugger != nil {
g.debug = config.Debugger
}
if config.InstanceName == "" {
config.InstanceName = swag.Name
}
Expand All @@ -138,7 +148,7 @@ func (g *Gen) Build(config *Config) error {
return fmt.Errorf("could not open overrides file: %w", err)
}
} else {
log.Printf("Using overrides from %s", config.OverridesFile)
g.debug.Printf("Using overrides from %s", config.OverridesFile)

overrides, err = parseOverrides(overridesFile)
if err != nil {
Expand All @@ -147,7 +157,7 @@ func (g *Gen) Build(config *Config) error {
}
}

log.Println("Generate swagger docs....")
g.debug.Printf("Generate swagger docs....")

p := swag.New(swag.SetMarkdownFileDirectory(config.MarkdownFilesDir),
swag.SetDebugger(config.Debugger),
Expand Down Expand Up @@ -216,7 +226,7 @@ func (g *Gen) writeDocSwagger(config *Config, swagger *spec.Swagger) error {
return err
}

log.Printf("create docs.go at %+v", docFileName)
g.debug.Printf("create docs.go at %+v", docFileName)

return nil
}
Expand All @@ -240,7 +250,7 @@ func (g *Gen) writeJSONSwagger(config *Config, swagger *spec.Swagger) error {
return err
}

log.Printf("create swagger.json at %+v", jsonFileName)
g.debug.Printf("create swagger.json at %+v", jsonFileName)

return nil
}
Expand Down Expand Up @@ -269,7 +279,7 @@ func (g *Gen) writeYAMLSwagger(config *Config, swagger *spec.Swagger) error {
return err
}

log.Printf("create swagger.yaml at %+v", yamlFileName)
g.debug.Printf("create swagger.yaml at %+v", yamlFileName)

return nil
}
Expand Down

0 comments on commit 89c61d4

Please sign in to comment.