add --target-dir option

app/app.go

@@ -264,6 +264,7 @@ offers several options for fine-grained control over the renaming process.`,
 			flagSortr,
 			flagSortPerDir,
 			flagStringMode,
+			flagTargetDir,
 			flagVerbose,
 		},
 		UseShortOptionHandling: true,

app/app_test/testdata/help_stdout.golden

@@ -179,9 +179,12 @@ Project repository: https://github.com/ayoisaiah/f2
     Treats the search pattern (specified by -f/--find) as a literal string
     instead of a regular expression.
 
+  -t, --target-dir 
+    Specify a target directory to move renamed files and reorganize your 
+    filesystem.
+
   -V, --verbose 
     Enables verbose output during the renaming operation.
-
 ENVIRONMENTAL VARIABLES
   F2_DEFAULT_OPTS
     Override the default options according to your preferences. For example, 

app/flag.go

@@ -281,6 +281,14 @@ var (
 		instead of a regular expression.`,
 	}
 
+	flagTargetDir = &cli.StringFlag{
+		Name:    "target-dir",
+		Aliases: []string{"t"},
+		Usage: `
+		Specify a target directory to move renamed files and reorganize your 
+		filesystem.`,
+	}
+
 	flagVerbose = &cli.BoolFlag{
 		Name:    "verbose",
 		Aliases: []string{"V"},

app/help.go

@@ -201,6 +201,13 @@ func helpText(app *cli.App) string {
 		flagStringMode.GetUsage(),
 	)
 
+	flagTargetDirHelp := fmt.Sprintf(
+		`%s, %s %s`,
+		pterm.Green("-", flagTargetDir.Aliases[0]),
+		pterm.Green("--", flagTargetDir.Name),
+		flagTargetDir.GetUsage(),
+	)
+
 	flagVerboseHelp := fmt.Sprintf(
 		`%s, %s %s`,
 		pterm.Green("-", flagVerbose.Aliases[0]),
@@ -286,6 +293,7 @@ Project repository: https://github.com/ayoisaiah/f2
 
 	%s
 
+	%s
 %s
 	%s
 
@@ -331,6 +339,7 @@ Project repository: https://github.com/ayoisaiah/f2
 		flagSortrHelp,
 		flagSortPerDirHelp,
 		flagStringModeHelp,
+		flagTargetDirHelp,
 		flagVerboseHelp,
 		pterm.Bold.Sprintf("ENVIRONMENTAL VARIABLES"),
 		envHelp(),

f2.go

@@ -58,7 +58,7 @@ func execute(_ *cli.Context) error {
 		return nil
 	}
 
-	err = rename.Rename(changes)
+	err = rename.Rename(appConfig, changes)
 
 	rename.PostRename(appConfig, changes, err)
 

find/csv.go

@@ -91,6 +91,7 @@ func handleCSV(conf *config.Config) (file.Changes, error) {
 
 		match := &file.Change{
 			BaseDir:      sourceDir,
+			TargetDir:    sourceDir,
 			IsDir:        fileInfo.IsDir(),
 			Source:       fileName,
 			Target:       fileName,
@@ -100,11 +101,20 @@ func handleCSV(conf *config.Config) (file.Changes, error) {
 			Position:     i,
 		}
 
-		changes = append(changes, match)
+		if conf.TargetDir != "" {
+			match.TargetDir = conf.TargetDir
+		}
 
 		if len(record) > 1 {
 			match.Target = strings.TrimSpace(record[1])
+
+			if filepath.IsAbs(match.Target) {
+				match.TargetDir = ""
+				continue
+			}
 		}
+
+		changes = append(changes, match)
 	}
 
 	return changes, nil

find/find.go

@@ -99,18 +99,27 @@ func isMaxDepth(rootPath, currentPath string, maxDepth int) bool {
 	return depthCount > maxDepth
 }
 
-func createFileChange(dirPath string, fileInfo fs.FileInfo) *file.Change {
+func createFileChange(
+	conf *config.Config,
+	dirPath string,
+	fileInfo fs.FileInfo,
+) *file.Change {
 	baseDir := filepath.Dir(dirPath)
 	fileName := fileInfo.Name()
 
 	match := &file.Change{
 		BaseDir:      baseDir,
+		TargetDir:    baseDir,
 		IsDir:        fileInfo.IsDir(),
 		Source:       fileName,
 		OriginalName: fileName,
 		SourcePath:   filepath.Join(baseDir, fileName),
 	}
 
+	if conf.TargetDir != "" {
+		match.TargetDir = conf.TargetDir
+	}
+
 	return match
 }
 
@@ -135,7 +144,7 @@ func searchPaths(conf *config.Config) (file.Changes, error) {
 			}
 
 			if conf.Search.Regex.MatchString(fileInfo.Name()) {
-				match := createFileChange(rootPath, fileInfo)
+				match := createFileChange(conf, rootPath, fileInfo)
 
 				if !shouldFilter(conf, match) {
 					matches = append(matches, match)
@@ -203,7 +212,7 @@ func searchPaths(conf *config.Config) (file.Changes, error) {
 						return infoErr
 					}
 
-					match := createFileChange(currentPath, fileInfo)
+					match := createFileChange(conf, currentPath, fileInfo)
 
 					if !shouldFilter(conf, match) {
 						matches = append(matches, match)
@@ -250,7 +259,7 @@ func loadFromBackup(conf *config.Config) (file.Changes, error) {
 	for i := range changes {
 		ch := changes[i]
 		ch.Source, ch.Target = ch.Target, ch.Source
-		ch.SourcePath = filepath.Join(ch.BaseDir, ch.Source)
+		ch.SourcePath = filepath.Join(ch.TargetDir, ch.Source)
 		ch.TargetPath = filepath.Join(ch.BaseDir, ch.Target)
 		ch.Status = status.OK
 

internal/config/config.go

@@ -72,6 +72,7 @@ type Config struct {
 	FixConflictsPattern      string         `json:"fix_conflicts_pattern"`
 	CSVFilename              string         `json:"csv_filename"`
 	BackupFilename           string         `json:"backup_filename"`
+	TargetDir                string         `json:"target_dir"`
 	ExiftoolOpts             ExiftoolOpts   `json:"exiftool_opts"`
 	PairOrder                []string       `json:"pair_order"`
 	FindSlice                []string       `json:"find_slice"`
@@ -158,6 +159,18 @@ func (c *Config) setOptions(ctx *cli.Context) error {
 	c.Revert = ctx.Bool("undo")
 	c.Debug = ctx.Bool("debug")
 	c.FilesAndDirPaths = ctx.Args().Slice()
+	c.TargetDir = ctx.String("target-dir")
+
+	if c.TargetDir != "" {
+		info, err := os.Stat(c.TargetDir)
+		if err == nil && !info.IsDir() {
+			return errInvalidTargetDir.Fmt(c.TargetDir)
+		}
+
+		if err != nil && os.IsExist(err) {
+			return err
+		}
+	}
 
 	if c.CSVFilename != "" {
 		absPath, err := filepath.Abs(filepath.Dir(c.CSVFilename))

internal/config/errors.go

@@ -14,4 +14,8 @@ var (
 	errInvalidSort = &apperr.Error{
 		Message: "the provided sort '%s' is invalid",
 	}
+
+	errInvalidTargetDir = &apperr.Error{
+		Message: "target path '%s' exists but is not a directory",
+	}
 )

internal/file/file.go

@@ -16,16 +16,18 @@ import (
 // Change represents a single renaming change.
 type Change struct {
 	Error error `json:"error,omitempty"`
-	// The original filename which can be different from Source in
+	// The original filename can be different from the `Source` in
 	// a multi-step renaming operation
 	OriginalName string        `json:"-"`
 	Status       status.Status `json:"status"`
 	BaseDir      string        `json:"base_dir"`
-	Source       string        `json:"source"`
-	Target       string        `json:"target"`
+	// TargetDir is the same as BaseDir unless `--target-dir` is provided
+	TargetDir string `json:"target_dir"`
+	Source    string `json:"source"`
+	Target    string `json:"target"`
 	// SourcePath is BaseDir + Source
 	SourcePath string `json:"-"`
-	// TargetPath is BaseDir + Target
+	// TargetPath is TargetDir + Target
 	TargetPath    string   `json:"-"`
 	CSVRow        []string `json:"-"`
 	Position      int      `json:"-"`
@@ -36,7 +38,7 @@ type Change struct {
 // AutoFixTarget sets the new target name.
 func (c *Change) AutoFixTarget(newTarget string) {
 	c.Target = newTarget
-	c.TargetPath = filepath.Join(c.BaseDir, c.Target)
+	c.TargetPath = filepath.Join(c.TargetDir, c.Target)
 
 	// Ensure empty targets is reported as empty instead of as a dot
 	if c.TargetPath == "." {

internal/testutil/testutil.go

@@ -182,14 +182,18 @@ func UpdateFileChanges(files file.Changes) {
 	for i := range files {
 		ch := files[i]
 
+		if ch.TargetDir == "" {
+			ch.TargetDir = ch.BaseDir
+		}
+
 		files[i].OriginalName = ch.Source
 		files[i].Position = i
 		files[i].SourcePath = filepath.Join(
 			ch.BaseDir,
 			ch.Source,
 		)
 		files[i].TargetPath = filepath.Join(
-			ch.BaseDir,
+			ch.TargetDir,
 			ch.Target,
 		)
 	}
@@ -219,6 +223,10 @@ func ProcessTestCaseChanges(t *testing.T, cases []TestCase) {
 		for j := range tc.Changes {
 			ch := tc.Changes[j]
 
+			if ch.TargetDir == "" {
+				ch.TargetDir = ch.BaseDir
+			}
+
 			if ch.Status == "" {
 				cases[i].Changes[j].Status = status.OK
 			}
@@ -234,7 +242,7 @@ func ProcessTestCaseChanges(t *testing.T, cases []TestCase) {
 
 			if cases[i].Changes[j].TargetPath == "" {
 				cases[i].Changes[j].TargetPath = filepath.Join(
-					ch.BaseDir,
+					ch.TargetDir,
 					ch.Target,
 				)
 			}
@@ -250,6 +258,10 @@ func GetConfig(t *testing.T, tc *TestCase, testDir string) *config.Config {
 		t.Setenv(k, v)
 	}
 
+	if len(tc.Args) == 0 {
+		tc.Args = []string{"-f", "", "-r", ""}
+	}
+
 	// add fake binary name as first argument
 	args := append([]string{"f2_test"}, tc.Args...)
 

rename/rename.go

@@ -54,7 +54,7 @@ func commit(fileChanges file.Changes) []int {
 			isCaseChangeOnly = true
 			timeStr := fmt.Sprintf("%d", time.Now().UnixNano())
 			targetPath = filepath.Join(
-				change.BaseDir,
+				change.TargetDir,
 				"__"+timeStr+"__"+change.Target+"__"+timeStr+"__", // step 1
 			)
 		}
@@ -69,7 +69,7 @@ func commit(fileChanges file.Changes) []int {
 			dir := filepath.Dir(change.Target)
 
 			err := os.MkdirAll(
-				filepath.Join(change.BaseDir, dir),
+				filepath.Join(change.TargetDir, dir),
 				osutil.DirPermission,
 			)
 			if err != nil {
@@ -99,8 +99,16 @@ func commit(fileChanges file.Changes) []int {
 // Rename renames files according to the provided changes and configuration
 // handling conflicts and backups.
 func Rename(
+	conf *config.Config,
 	fileChanges file.Changes,
 ) error {
+	if conf.TargetDir != "" {
+		err := os.MkdirAll(conf.TargetDir, osutil.DirPermission)
+		if err != nil {
+			return err
+		}
+	}
+
 	renameErrs := commit(fileChanges)
 	if len(renameErrs) > 0 {
 		return errRenameFailed.WithCtx(renameErrs)