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.
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
fix: suppress debug logs when using -q #1254
Merged
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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. | ||
|
@@ -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{ | ||
|
@@ -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 | ||
} | ||
|
@@ -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) | ||
Comment on lines
-141
to
+151
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
|
||
|
||
overrides, err = parseOverrides(overridesFile) | ||
if err != nil { | ||
|
@@ -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), | ||
|
@@ -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 | ||
} | ||
|
@@ -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 | ||
} | ||
|
@@ -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 | ||
} | ||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Moving initializing the debugger to here to avoid
nil
confusions.