Merge pull request #60 from ivanilves/issue-57

feat(issues/57): use ${EDITOR} variable to edit files

cmd/travelgrunt/main.go

@@ -22,12 +22,14 @@ var appVersion = "default"
 
 var outFile string
 var expression string
+var editFile bool
 var top bool
 var version bool
 
 func init() {
 	flag.StringVar(&outFile, "out-file", "", "output selected path into the file specified")
 	flag.StringVar(&expression, "x", "", "use arbitrary expression passed instead of configured rules")
+	flag.BoolVar(&editFile, "e", false, "edit file selected instead of changing working directory")
 	flag.BoolVar(&top, "top", false, "get to the repository top level (root) path")
 	flag.BoolVar(&version, "version", false, "print application version and exit")
 }
@@ -132,6 +134,8 @@ func main() {
 		cfg = cfg.WithNameEx(expression)
 	}
 
+	cfg.UseFiles = editFile
+
 	entries, paths, err := directory.Collect(rootPath, cfg)
 
 	if err != nil {
@@ -149,7 +153,9 @@ func main() {
 	if outFile != "" {
 		path := getEntryPath(entries, selected, rootPath)
 
-		tag(path)
+		if !editFile {
+			tag(path)
+		}
 
 		writeFileAndExit(outFile, path)
 	}

codecov.yml

@@ -0,0 +1,2 @@
+ignore:
+  - cmd/**/*

fixtures/config/rule/link-to-sample.hcl

@@ -0,0 +1 @@
+sample.hcl

fixtures/config/rule/sample.hcl

@@ -0,0 +1 @@
+# dummy sample

pkg/config/config.go

@@ -16,13 +16,15 @@ type Config struct {
 	Rules []rule.Rule `yaml:"rules"`
 
 	IsDefault bool
+	UseFiles  bool
 }
 
 // DefaultConfig returns default travelgrunt repo-level configuration
 func DefaultConfig() Config {
 	return Config{
 		Rules:     []rule.Rule{{ModeFn: mode.IsTerragrunt}},
 		IsDefault: true,
+		UseFiles:  false,
 	}
 }
 

pkg/config/rule/rule_test.go

@@ -0,0 +1,43 @@
+package rule
+
+import (
+	"os"
+	"testing"
+
+	"github.com/stretchr/testify/assert"
+)
+
+const (
+	fixturePath = "../../../fixtures/config/rule"
+)
+
+func TestPathPrefixed(t *testing.T) {
+	assert := assert.New(t)
+
+	assert.False(Rule{Prefix: "./prefix"}.pathPrefixed("/etc/passwd"))
+	assert.True(Rule{Prefix: ""}.pathPrefixed("/etc/passwd"))
+	assert.True(Rule{Prefix: "./prefix"}.pathPrefixed("./prefix/file"))
+}
+
+func TestNormalizeNameEx(t *testing.T) {
+	assert := assert.New(t)
+
+	r := Rule{NameEx: "*.inc.php"}
+
+	assert.Equal(r.normalizeNameEx(), "^.*\\.inc\\.php$")
+}
+
+func TestNameMatched(t *testing.T) {
+	assert := assert.New(t)
+
+	files, err := os.ReadDir(fixturePath)
+	if err != nil {
+		panic(err)
+	}
+
+	for _, file := range files {
+		assert.True(Rule{}.nameMatched(file))
+		assert.True(Rule{NameEx: ".*"}.nameMatched(file))
+		assert.False(Rule{NameEx: "some-nonsense"}.nameMatched(file))
+	}
+}

pkg/directory/directory.go

@@ -12,6 +12,14 @@ func isHiddenDir(d os.DirEntry) bool {
 	return d.IsDir() && string(d.Name()[0]) == "."
 }
 
+func getAbsPath(path string, useFiles bool) string {
+	if useFiles {
+		return path
+	}
+
+	return filepath.Dir(path)
+}
+
 func isInScope(absPath string, rootPath string) bool {
 	return len(absPath) >= len(rootPath)
 }
@@ -31,7 +39,7 @@ func Collect(rootPath string, cfg config.Config) (entries map[string]string, pat
 				return filepath.SkipDir
 			}
 
-			absPath := filepath.Dir(path)
+			absPath := getAbsPath(path, cfg.UseFiles)
 
 			if isInScope(absPath, rootPath) {
 				relPath := strings.TrimPrefix(absPath, rootPath+"/")

pkg/directory/directory_test.go

@@ -13,6 +13,15 @@ const (
 	invalidPath = "/c2RmZ3JlZ2ZncnR3Z3I0aGd3dGd3d3d3d3d3d2RmZGZmZnJlZmdydDRndnQ0M3RodWprbDhpb2s4"
 )
 
+func TestGetAbsPath(t *testing.T) {
+	assert := assert.New(t)
+
+	const testPath = "/etc/passwd"
+
+	assert.Equal(getAbsPath(testPath, false), "/etc")
+	assert.Equal(getAbsPath(testPath, true), "/etc/passwd")
+}
+
 func TestCollect(t *testing.T) {
 	assert := assert.New(t)