main.go

package main

import (
	"fmt"
	"os"
	"regexp"

	"github.com/akamensky/argparse"
	logging "github.com/op/go-logging"

	"github.com/mathpn/listme/pretty"
	"github.com/mathpn/listme/search"
)

var log = logging.MustGetLogger("listme")
var format = logging.MustStringFormatter(`%{color}%{level}%{color:reset}: %{message}`)
var tags = []string{"BUG", "FIXME", "XXX", "TODO", "HACK", "OPTIMIZE", "NOTE"}
var tagValRegex = regexp.MustCompile(`^(\w+)$`)

func validateTags(tags []string) error {
	for _, tag := range tags {
		match := tagValRegex.MatchString(tag)
		if !match {
			return fmt.Errorf("provided tags must be non-empty and contain only alphanumeric characters")
		}
	}
	return nil
}

func main() {
	parser := argparse.NewParser("listme", "Summarize you FIXME, TODO, XXX (and other tags) comments so you don't forget them.")
	path := parser.StringPositional(&argparse.Options{Help: "Path to folder or file to be searched. Search is recursive."})
	tags := parser.StringList("T", "tags", &argparse.Options{Default: tags, Validate: validateTags, Help: "Tags to search for, input should be separated by spaces"})
	glob := parser.String("g", "glob", &argparse.Options{Default: "*", Help: "Glob pattern to filter files in the search. Use a single-quoted string. Example: '*.go'"})
	author := parser.String("a", "author", &argparse.Options{Help: "Filter lines by commit author"})
	ageFilter := parser.Int("n", "newer-than", &argparse.Options{Default: -1, Help: "Filters lines based on the age of commits, showing only lines committed within the specified number of days"})
	oldCommitLimit := parser.Int("o", "old-commit-mark-limit", &argparse.Options{Default: 60, Help: "Sets the age limit for marking commits as old, with commits older than the specified limit being marked"})
	maxFileSize := parser.Int("f", "max-file-size", &argparse.Options{Default: 5, Help: "Maximum file size to scan (in MB)"})
	fullPath := parser.Flag("F", "full-path", &argparse.Options{Help: "Print full absolute path of the files"})
	noAuthor := parser.Flag("A", "no-author", &argparse.Options{Help: "Do not print git author information"})
	noSummary := parser.Flag("S", "no-summary", &argparse.Options{Help: "Do not print summary box for each file"})
	bw := parser.Flag("b", "bw", &argparse.Options{Help: "Use black and white style"})
	plain := parser.Flag("p", "plain", &argparse.Options{Help: "Use plain style. Ideal for machine consumption. Used by default when redirecting the output"})
	workers := parser.Int("w", "workers", &argparse.Options{Default: 128, Help: "[debug] Number of search workers. There's likely no need to change this"})
	verbose := parser.Flag("v", "verbose", &argparse.Options{Help: "Enable info logging level"})
	debug := parser.Flag("d", "debug", &argparse.Options{Help: "Add debug verbosity"})

	err := parser.Parse(os.Args)
	if err != nil {
		fmt.Print(parser.Usage(err))
		panic(err)
	}

	if *maxFileSize <= 0 {
		panic("max-file-size must be a positive integer")
	}

	logging.SetFormatter(format)
	b := logging.NewLogBackend(os.Stderr, "", 0)
	bFormatter := logging.NewBackendFormatter(b, format)
	logging.SetBackend(bFormatter)
	logging.SetLevel(logging.WARNING, "")
	if *verbose {
		logging.SetLevel(logging.INFO, "")
	}
	if *debug {
		logging.SetLevel(logging.DEBUG, "")
	}

	style, err := pretty.GetStyle(*bw, *plain)
	if err != nil {
		log.Fatal(err)
	}

	params, err := search.NewSearchParams(
		*path,
		*tags,
		*workers,
		style,
		*oldCommitLimit,
		*ageFilter,
		int64(*maxFileSize),
		*fullPath,
		*noSummary,
		*noAuthor,
		*glob,
		*author,
	)
	if err != nil {
		log.Fatal(err)
	}
	search.Search(params)
}