feat(cmd): add --exclude-dirs option

cmd/gomarkdoc/command.go

@@ -52,6 +52,7 @@ type commandOptions struct {
 	footerFile            string
 	format                string
 	tags                  []string
+	excludeDirs           []string
 	templateOverrides     map[string]string
 	templateFileOverrides map[string]string
 	verbosity             int
@@ -96,6 +97,7 @@ func buildCommand() *cobra.Command {
 			opts.footer = viper.GetString("footer")
 			opts.footerFile = viper.GetString("footerFile")
 			opts.tags = viper.GetStringSlice("tags")
+			opts.excludeDirs = viper.GetStringSlice("excludeDirs")
 			opts.repository.Remote = viper.GetString("repository.url")
 			opts.repository.DefaultBranch = viper.GetString("repository.defaultBranch")
 			opts.repository.PathFromRoot = viper.GetString("repository.path")
@@ -197,6 +199,12 @@ func buildCommand() *cobra.Command {
 		defaultTags(),
 		"Set of build tags to apply when choosing which files to include for documentation generation.",
 	)
+	command.Flags().StringSliceVar(
+		&opts.excludeDirs,
+		"exclude-dirs",
+		nil,
+		"List of package directories to ignore when producing documentation.",
+	)
 	command.Flags().CountVarP(
 		&opts.verbosity,
 		"verbose",
@@ -241,6 +249,7 @@ func buildCommand() *cobra.Command {
 	_ = viper.BindPFlag("footer", command.Flags().Lookup("footer"))
 	_ = viper.BindPFlag("footerFile", command.Flags().Lookup("footer-file"))
 	_ = viper.BindPFlag("tags", command.Flags().Lookup("tags"))
+	_ = viper.BindPFlag("excludeDirs", command.Flags().Lookup("exclude-dirs"))
 	_ = viper.BindPFlag("repository.url", command.Flags().Lookup("repository.url"))
 	_ = viper.BindPFlag("repository.defaultBranch", command.Flags().Lookup("repository.default-branch"))
 	_ = viper.BindPFlag("repository.path", command.Flags().Lookup("repository.path"))
@@ -294,6 +303,13 @@ func runCommand(paths []string, opts commandOptions) error {
 
 	specs := getSpecs(paths...)
 
+	excluded := getSpecs(opts.excludeDirs...)
+	if err := validateExcludes(excluded); err != nil {
+		return err
+	}
+
+	specs = removeExcludes(specs, excluded)
+
 	if err := resolveOutput(specs, outputTmpl); err != nil {
 		return err
 	}
@@ -565,13 +581,49 @@ func isIgnoredDir(dirname string) bool {
 	return false
 }
 
+// validateExcludes checks that the exclude dirs are all directories, not
+// packages.
+func validateExcludes(specs []*PackageSpec) error {
+	for _, s := range specs {
+		if !s.isLocal {
+			return fmt.Errorf("gomarkdoc: invalid directory specified as an exclude directory: %s", s.ImportPath)
+		}
+	}
+
+	return nil
+}
+
+// removeExcludes removes any package specs that were specified as excluded.
+func removeExcludes(specs []*PackageSpec, excludes []*PackageSpec) []*PackageSpec {
+	out := make([]*PackageSpec, 0, len(specs))
+	for _, s := range specs {
+		var exclude bool
+		for _, e := range excludes {
+			if !s.isLocal || !e.isLocal {
+				continue
+			}
+
+			if r, err := filepath.Rel(s.Dir, e.Dir); err == nil && r == "." {
+				exclude = true
+				break
+			}
+		}
+
+		if !exclude {
+			out = append(out, s)
+		}
+	}
+
+	return out
+}
+
 const (
 	cwdPathPrefix    = "." + string(os.PathSeparator)
 	parentPathPrefix = ".." + string(os.PathSeparator)
 )
 
 func isLocalPath(path string) bool {
-	return strings.HasPrefix(path, cwdPathPrefix) || strings.HasPrefix(path, parentPathPrefix) || filepath.IsAbs(path)
+	return strings.HasPrefix(path, ".") || strings.HasPrefix(path, parentPathPrefix) || filepath.IsAbs(path)
 }
 
 func compare(r1, r2 io.Reader) (bool, error) {

logger/README.md

@@ -0,0 +1,85 @@
+<!-- Code generated by gomarkdoc. DO NOT EDIT -->
+
+# logger
+
+```go
+import "github.com/princjef/gomarkdoc/logger"
+```
+
+Package logger provides a simple console logger for reporting information about execution to stderr.
+
+## Index
+
+- [type Level](<#Level>)
+- [type Logger](<#Logger>)
+  - [func New\(level Level, opts ...Option\) Logger](<#New>)
+- [type Option](<#Option>)
+  - [func WithField\(key string, value interface\{\}\) Option](<#WithField>)
+
+
+<a name="Level"></a>
+## type [Level](<https://github.com/princjef/gomarkdoc/blob/master/logger/logger.go#L24>)
+
+Level defines valid logging levels for a Logger.
+
+```go
+type Level int
+```
+
+<a name="DebugLevel"></a>Valid logging levels
+
+```go
+const (
+    DebugLevel Level = iota + 1
+    InfoLevel
+    WarnLevel
+    ErrorLevel
+)
+```
+
+<a name="Logger"></a>
+## type [Logger](<https://github.com/princjef/gomarkdoc/blob/master/logger/logger.go#L12-L21>)
+
+Logger provides basic logging capabilities at different logging levels.
+
+```go
+type Logger interface {
+    Debug(a ...interface{})
+    Debugf(format string, a ...interface{})
+    Info(a ...interface{})
+    Infof(format string, a ...interface{})
+    Warn(a ...interface{})
+    Warnf(format string, a ...interface{})
+    Error(a ...interface{})
+    Errorf(format string, a ...interface{})
+}
+```
+
+<a name="New"></a>
+### func [New](<https://github.com/princjef/gomarkdoc/blob/master/logger/logger.go#L44>)
+
+```go
+func New(level Level, opts ...Option) Logger
+```
+
+New initializes a new Logger.
+
+<a name="Option"></a>
+## type [Option](<https://github.com/princjef/gomarkdoc/blob/master/logger/logger.go#L27>)
+
+Option defines an option for configuring the logger.
+
+```go
+type Option func(opts *options)
+```
+
+<a name="WithField"></a>
+### func [WithField](<https://github.com/princjef/gomarkdoc/blob/master/logger/logger.go#L83>)
+
+```go
+func WithField(key string, value interface{}) Option
+```
+
+WithField sets the provided key/value pair for use on all logs.
+
+Generated by [gomarkdoc](<https://github.com/princjef/gomarkdoc>)

magefile.go

@@ -36,18 +36,14 @@ func Build() error {
 func Doc() error {
 	return shellcmd.RunAll(
 		`go run ./cmd/gomarkdoc .`,
-		`go run ./cmd/gomarkdoc --header "" ./lang/...`,
-		`go run ./cmd/gomarkdoc --header "" ./format/...`,
-		`go run ./cmd/gomarkdoc --header "" ./cmd/...`,
+		`go run ./cmd/gomarkdoc --header "" --exclude-dirs . --exclude-dirs ./testData/... ./...`,
 	)
 }
 
 func DocVerify() error {
 	return shellcmd.RunAll(
 		`go run ./cmd/gomarkdoc -c .`,
-		`go run ./cmd/gomarkdoc -c --header "" ./lang/...`,
-		`go run ./cmd/gomarkdoc -c --header "" ./format/...`,
-		`go run ./cmd/gomarkdoc -c --header "" ./cmd/...`,
+		`go run ./cmd/gomarkdoc -c --header "" --exclude-dirs . --exclude-dirs ./testData/... ./...`,
 	)
 }