Add -write_source_comment flag to toggle whether to emit source file/…

…interface names comment (#33)

Fix #32

README.md

@@ -113,6 +113,8 @@ It supports the following flags:
 
 - `-write_package_comment`: Writes package documentation comment (godoc) if true. (default true)
 
+- `-write_source_comment`: Writes original file (source mode) or interface names (reflect mode) comment if true. (default true)
+
 - `-typed`: Generate Type-safe 'Return', 'Do', 'DoAndReturn' function. (default false)
 
 For an example of the use of `mockgen`, see the `sample/` directory. In simple

mockgen/mockgen.go

@@ -54,14 +54,15 @@ var (
 )
 
 var (
- source = flag.String("source", "", "(source mode) Input Go source file; enables source mode.")
- destination = flag.String("destination", "", "Output file; defaults to stdout.")
- mockNames = flag.String("mock_names", "", "Comma-separated interfaceName=mockName pairs of explicit mock names to use. Mock names default to 'Mock'+ interfaceName suffix.")
- packageOut = flag.String("package", "", "Package of the generated code; defaults to the package of the input with a 'mock_' prefix.")
- selfPackage = flag.String("self_package", "", "The full package import path for the generated code. The purpose of this flag is to prevent import cycles in the generated code by trying to include its own package. This can happen if the mock's package is set to one of its inputs (usually the main one) and the output is stdio so mockgen cannot detect the final output package. Setting this flag will then tell mockgen which import to exclude.")
- writePkgComment = flag.Bool("write_package_comment", true, "Writes package documentation comment (godoc) if true.")
- copyrightFile = flag.String("copyright_file", "", "Copyright file used to add copyright header")
- typed = flag.Bool("typed", false, "Generate Type-safe 'Return', 'Do', 'DoAndReturn' function")
+ source = flag.String("source", "", "(source mode) Input Go source file; enables source mode.")
+ destination = flag.String("destination", "", "Output file; defaults to stdout.")
+ mockNames = flag.String("mock_names", "", "Comma-separated interfaceName=mockName pairs of explicit mock names to use. Mock names default to 'Mock'+ interfaceName suffix.")
+ packageOut = flag.String("package", "", "Package of the generated code; defaults to the package of the input with a 'mock_' prefix.")
+ selfPackage = flag.String("self_package", "", "The full package import path for the generated code. The purpose of this flag is to prevent import cycles in the generated code by trying to include its own package. This can happen if the mock's package is set to one of its inputs (usually the main one) and the output is stdio so mockgen cannot detect the final output package. Setting this flag will then tell mockgen which import to exclude.")
+ writePkgComment = flag.Bool("write_package_comment", true, "Writes package documentation comment (godoc) if true.")
+ writeSourceComment = flag.Bool("write_source_comment", true, "Writes original file (source mode) or interface names (reflect mode) comment if true.")
+ copyrightFile = flag.String("copyright_file", "", "Copyright file used to add copyright header")
+ typed = flag.Bool("typed", false, "Generate Type-safe 'Return', 'Do', 'DoAndReturn' function")
 
  debugParser = flag.Bool("debug_parser", false, "Print out parser results only.")
  showVersion = flag.Bool("version", false, "Print version.")
@@ -283,10 +284,12 @@ func (g *generator) Generate(pkg *model.Package, outputPkgName string, outputPac
  }
 
  g.p("// Code generated by MockGen. DO NOT EDIT.")
- if g.filename != "" {
- g.p("// Source: %v", g.filename)
- } else {
- g.p("// Source: %v (interfaces: %v)", g.srcPackage, g.srcInterfaces)
+ if *writeSourceComment {
+ if g.filename != "" {
+ g.p("// Source: %v", g.filename)
+ } else {
+ g.p("// Source: %v (interfaces: %v)", g.srcPackage, g.srcInterfaces)
+ }
  }
  g.p("")