Go2md v0.3 (#3)

* warn about missing doc.go

* warn about types that are not exported

* bugfixes (for example [])

* `--output` argument to direct output into file

* line-up tags in struct fields

cmd/README.md

@@ -1,8 +1,10 @@
 # github.com/jylitalo/go2md/cmd
 
 ## Overview
+Package cmd provides command line arguments and flags parsing with spf13/cobra and
+calls backend functionality from pkg package.
 
-Imports: 4
+Imports: 6
 
 ## Index
 - [func NewCommand(out io.Writer, version string) *cobra.Command](#func-newcommand)
@@ -33,5 +35,5 @@ Default is to generate markdown from current directory.
 
 --
 
-Generated by [github.com/jylitalo/go2md](https://github.com/jylitalo/go2cmd/) v0.2
+Generated by [github.com/jylitalo/go2md](https://github.com/jylitalo/go2md/) v0.3
 

cmd/cmd.go

@@ -3,7 +3,9 @@ package cmd
 import (
 	"fmt"
 	"io"
+	"os"
 
+	log "github.com/sirupsen/logrus"
 	"github.com/spf13/cobra"
 
 	"github.com/jylitalo/go2md/pkg"
@@ -19,9 +21,18 @@ func NewCommand(out io.Writer, version string) *cobra.Command {
 				out.Write([]byte(fmt.Sprintf("go2md %s\n", version)))
 				return nil
 			}
+			if flag, _ := cmd.Flags().GetString("output"); flag != "" {
+				fout, err := os.Create(flag)
+				if err != nil {
+					log.WithFields(log.Fields{"err": err, "filename": flag}).Fatal("failed to create file")
+				}
+				defer fout.Close()
+				out = fout
+			}
 			return pkg.Run(out, version)
 		},
 	}
 	cmd.Flags().BoolP("version", "v", false, "print go2md version")
+	cmd.Flags().StringP("output", "o", "", "write output to file")
 	return cmd
 }

cmd/doc.go

@@ -0,0 +1,3 @@
+// Package cmd provides command line arguments and flags parsing with spf13/cobra and
+// calls backend functionality from pkg package.
+package cmd

pkg/README.md

@@ -1,8 +1,9 @@
 # github.com/jylitalo/go2md/pkg
 
 ## Overview
+Package pkg provides the backend functionality for golang to markdown transformation.
 
-Imports: 15
+Imports: 16
 
 ## Index
 - [Variables](variables)
@@ -37,5 +38,5 @@ Run reads all "*.go" files (excluding "*_test.go") and writes markdown document
 
 --
 
-Generated by [github.com/jylitalo/go2md](https://github.com/jylitalo/go2cmd/) v0.2
+Generated by [github.com/jylitalo/go2md](https://github.com/jylitalo/go2md/) v0.3
 

pkg/doc.go

@@ -0,0 +1,2 @@
+// Package pkg provides the backend functionality for golang to markdown transformation.
+package pkg