Merge pull request #15 from mx-psi/mx-psi/skip-dirs

Add options for skipping directories

.golangci.yml

@@ -24,6 +24,6 @@ linters-settings:
   lll:
     line-length: 170
   gocyclo:
-    min-complexity: 20
+    min-complexity: 25
   golint:
     min-confidence: 0.85

README.md

@@ -29,15 +29,22 @@ If you just want to list the files that porto would change vanity import, run:
 ```bash
 porto -l path/to/library
 ```
+## Inclusion/exclusion rules
 
-If you want to ignore files (e.g. proto generated files), pass the `--skip-files` flag:
+`porto` skips autogenerated, internal, third party and vendored files by default. You can customize what files get included using some flags:
+
+- If you want to ignore files (e.g. proto generated files), pass the `--skip-files` flag:
 
 ```bash
 porto --skip-files ".*\\.pb\\.go$" path/to/library
 ```
+- If you want to ignore directories (e.g. tooling directories), pass the `--skip-dirs` flag:
 
-If you want to include `internal` folders too
+```bash
+porto --skip-dirs "^tools$" path/to/library
+```
+- If you want to include `internal` folders and directories skipped by default:
 
 ```bash
-porto --include-internal path/to/library
+porto --include-internal --skip-dirs-use-default=false path/to/library
 ```

cmd/porto/main.go

@@ -6,6 +6,7 @@ import (
 	"log"
 	"os"
 	"path/filepath"
+	"regexp"
 
 	"github.com/jcchavezs/porto"
 )
@@ -14,6 +15,8 @@ func main() {
 	flagWriteOutputToFile := flag.Bool("w", false, "write result to (source) file instead of stdout")
 	flagListDiff := flag.Bool("l", false, "list files whose vanity import differs from porto's")
 	flagSkipFiles := flag.String("skip-files", "", "Regexps of files to skip")
+	flagSkipDirs := flag.String("skip-dirs", "", "Regexps of directories to skip")
+	flagSkipDefaultDirs := flag.Bool("skip-dirs-use-default", true, "use default skip directory list")
 	flagIncludeInternal := flag.Bool("include-internal", false, "include internal folders")
 	flag.Parse()
 
@@ -23,10 +26,12 @@ func main() {
 usage: porto [options] <target-path>
 
 Options:
--w                  Write result to (source) file instead of stdout (default: false)
--l                  List files whose vanity import differs from porto's (default: false)
---skip-files        Regexps of files to skip
---include-internal  Include internal folders
+-w                       Write result to (source) file instead of stdout (default: false)
+-l                       List files whose vanity import differs from porto's (default: false)
+--skip-files             Regexps of files to skip
+--skip-dirs              Regexps of directories to skip
+--skip-dirs-use-default  Use default skip directory list (default: true)
+--include-internal       Include internal folders
 
 Examples:
 
@@ -51,10 +56,21 @@ Add import path to a folder
 		log.Fatalf("failed to build files regexes: %v", err)
 	}
 
+	var skipDirsRegex []*regexp.Regexp
+	if *flagSkipDefaultDirs {
+		skipDirsRegex = append(skipDirsRegex, porto.StdExcludeDirRegexps...)
+	}
+	userSkipDirsRegex, err := porto.GetRegexpList(*flagSkipDirs)
+	if err != nil {
+		log.Fatalf("failed to build directories regexes: %v", err)
+	}
+	skipDirsRegex = append(skipDirsRegex, userSkipDirsRegex...)
+
 	diffCount, err := porto.FindAndAddVanityImportForDir(workingDir, baseAbsDir, porto.Options{
 		WriteResultToFile: *flagWriteOutputToFile,
 		ListDiffFiles:     *flagListDiff,
 		SkipFilesRegexes:  skipFilesRegex,
+		SkipDirsRegexes:   skipDirsRegex,
 		IncludeInternal:   *flagIncludeInternal,
 	})
 	if err != nil {

import.go

@@ -106,7 +106,7 @@ func findAndAddVanityImportForModuleDir(workingDir, absDir string, moduleName st
 
 	gc := 0
 	for _, f := range files {
-		if isDir, dirName := f.IsDir(), f.Name(); isDir {
+		if isDir, dirName := f.IsDir(), f.Name(); isDir && !matchesAny(opts.SkipDirsRegexes, dirName) {
 			var (
 				c   int
 				err error
@@ -127,7 +127,7 @@ func findAndAddVanityImportForModuleDir(workingDir, absDir string, moduleName st
 			}
 
 			gc += c
-		} else if fileName := f.Name(); isGoFile(fileName) && !isGoTestFile(fileName) && !isIgnoredFile(opts.SkipFilesRegexes, fileName) {
+		} else if fileName := f.Name(); isGoFile(fileName) && !isGoTestFile(fileName) && !matchesAny(opts.SkipFilesRegexes, fileName) {
 			absFilepath := absDir + pathSeparator + fileName
 
 			hasChanged, newContent, err := addImportPath(absDir+pathSeparator+fileName, moduleName)
@@ -170,9 +170,9 @@ func findAndAddVanityImportForModuleDir(workingDir, absDir string, moduleName st
 	return gc, nil
 }
 
-func isIgnoredFile(fileRegexes []*regexp.Regexp, filename string) bool {
-	for _, fr := range fileRegexes {
-		if matched := fr.MatchString(filename); matched {
+func matchesAny(regexes []*regexp.Regexp, str string) bool {
+	for _, fr := range regexes {
+		if matched := fr.MatchString(str); matched {
 			return true
 		}
 	}
@@ -227,6 +227,8 @@ type Options struct {
 	ListDiffFiles bool
 	// Set of regex for matching files to be skipped
 	SkipFilesRegexes []*regexp.Regexp
+	// Set of regex for matching directories to be skipped
+	SkipDirsRegexes []*regexp.Regexp
 	// Include internal packages
 	IncludeInternal bool
 }

import_test.go

@@ -74,22 +74,30 @@ func TestFindFilesWithVanityImport(t *testing.T) {
 
 }
 
-func TestIsIgnoredFile(t *testing.T) {
+func TestMatchesAny(t *testing.T) {
 	assert.True(
 		t,
-		isIgnoredFile(
+		matchesAny(
 			[]*regexp.Regexp{regexp.MustCompile(".*\\.pb\\.go$")},
 			"myfile.pb.go",
 		),
 	)
 
 	assert.False(
 		t,
-		isIgnoredFile(
+		matchesAny(
 			[]*regexp.Regexp{},
 			"myfile.pb.go",
 		),
 	)
+
+	assert.True(
+		t,
+		matchesAny(
+			[]*regexp.Regexp{regexp.MustCompile("^third_party$")},
+			"third_party",
+		),
+	)
 }
 
 func TestIsUnexportedModule(t *testing.T) {

regexes.go

@@ -6,6 +6,17 @@ import (
 	"strings"
 )
 
+// StdExcludeDirRegexps is the standard directory exclusion list from golangci-lint.
+// See https://github.com/golangci/golangci-lint/blob/master/pkg/packages/skip.go.
+var StdExcludeDirRegexps = []*regexp.Regexp{
+	regexp.MustCompile("^vendor$"),
+	regexp.MustCompile("^third_party$"),
+	regexp.MustCompile("^testdata$"),
+	regexp.MustCompile("^examples$"),
+	regexp.MustCompile("^Godeps$"),
+	regexp.MustCompile("^builtin$"),
+}
+
 func GetRegexpList(regexps string) ([]*regexp.Regexp, error) {
 	var regexes []*regexp.Regexp
 	if len(regexps) > 0 {