Add option to disable line numbering

relates to #1

Author: Dadido3

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2021-2022 David Vogel
+Copyright (c) 2021-2023 David Vogel
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

README.md

@@ -8,9 +8,9 @@ You only need to start the tool in any directory, and it will open a list of pat
 
 When run from inside some directory, this program will:
 
-1. Create a temporary file with a list of all files contained in the given directory and its sub directories
-2. Opens the temporary file with the default editor (For files with the file extension `.batch-rename`)
-3. Reads the file back, and renames/moves the files
+1. Create a temporary file with a list of all files contained in the given directory and its sub directories.
+2. Opens the temporary file with the default editor. (For files with the file extension `.batch-rename`)
+3. Reads the file back, and renames/moves the files.
 
 ## Usage
 
@@ -21,11 +21,19 @@ There are multiple ways to use this tool:
 - Use `go install github.com/Dadido3/batch-rename@latest`. Afterwards you can run `batch-rename` from inside any directory.
 - Build it yourself from source, see below.
 
+## Options
+
+- `batch-rename --no-numbers` will disable line number output.
+This means that each line contains only the file path without a preceding number, which is easier to edit in some cases.
+Using this option has the downside that any line removal or insertion can mess up the mapping between old and new paths, which can mess up your filenames.
+
 ## Building
 
 This software uses GoReleaser to automatically build and upload artifacts to GitHub.
 Make sure to [install GoReleaser](https://goreleaser.com/install/).
 
 - To build for your current platform use `goreleaser build --single-target --clean`. Or `goreleaser build --single-target --snapshot --clean` if you have modified the repository.
 - To simulate the release process, use `goreleaser --skip-publish --auto-snapshot --clean`.
-- To build for your current platform and without GoReleaser, use `go build`. This will not include the version information.
+
+To build for your current platform and without GoReleaser, use `go build`.
+This will not include the version information.

file-handling.go

@@ -1,4 +1,4 @@
-// Copyright (c) 2022 David Vogel
+// Copyright (c) 2022-2023 David Vogel
 //
 // This software is released under the MIT License.
 // https://opensource.org/licenses/MIT
@@ -15,17 +15,23 @@ import (
 )
 
 // createEntriesFile creates a new file with all the fileEntries and returns its file path.
-func createEntriesFile(rootDir string, fileEntries []fileEntry) (filePath string, err error) {
+func createEntriesFile(rootDir string, fileEntries []fileEntry, numbering bool) (filePath string, err error) {
 	// Create temporary file with paths.
 	file, err := os.CreateTemp(".", "*.batch-rename")
 	if err != nil {
 		log.Fatal(err)
 	}
 
-	decimalWidth := getDecimalWidth(uint(len(fileEntries)))
+	if numbering {
+		decimalWidth := getDecimalWidth(uint(len(fileEntries)))
 
-	for i, fileEntry := range fileEntries {
-		fmt.Fprintf(file, "%0"+fmt.Sprint(decimalWidth)+"d\t%s\n", i+1, fileEntry.originalPath)
+		for i, fileEntry := range fileEntries {
+			fmt.Fprintf(file, "%0"+fmt.Sprint(decimalWidth)+"d\t%s\n", i+1, fileEntry.originalPath)
+		}
+	} else {
+		for _, fileEntry := range fileEntries {
+			fmt.Fprintf(file, "%s\n", fileEntry.originalPath)
+		}
 	}
 
 	if err := file.Close(); err != nil {
@@ -36,24 +42,38 @@ func createEntriesFile(rootDir string, fileEntries []fileEntry) (filePath string
 }
 
 // readEntriesFile reads the (edited) temporary file back and modifies the fileEntries with the new file paths.
-func readEntriesFile(filePath string, fileEntries []fileEntry) error {
+func readEntriesFile(filePath string, fileEntries []fileEntry, numbering bool) error {
 	file, err := os.Open(filePath)
 	if err != nil {
 		return err
 	}
 	defer file.Close()
 
 	scanner := bufio.NewScanner(file)
+	i := 0
 	for scanner.Scan() {
-		substrings := strings.SplitN(scanner.Text(), "\t", 2)
-		entry, err := strconv.ParseUint(substrings[0], 10, 64)
-		if err != nil {
-			return fmt.Errorf("failed to parse element number: %w", err)
-		}
-		if entry <= 0 || entry > uint64(len(fileEntries)) {
-			return fmt.Errorf("element number outside of valid range: Given %v, there are %v entries", entry, len(fileEntries))
+		if numbering {
+			substrings := strings.SplitN(scanner.Text(), "\t", 2)
+			entry, err := strconv.ParseUint(substrings[0], 10, 64)
+			if err != nil {
+				return fmt.Errorf("failed to parse element number: %w", err)
+			}
+			if entry <= 0 || entry > uint64(len(fileEntries)) {
+				return fmt.Errorf("element number outside of valid range: Got %d, but there are only %d entries", entry, len(fileEntries))
+			}
+			fileEntries[entry-1].newPath = substrings[1]
+		} else {
+			if i >= len(fileEntries) {
+				return fmt.Errorf("there are more lines than files: Got %d, but expected %d", i+1, len(fileEntries))
+			}
+			fileEntries[i].newPath = scanner.Text()
+			i++
 		}
-		fileEntries[entry-1].newPath = substrings[1]
+	}
+
+	// In case we don't do numbering, we should make sure that the number of lines didn't change.
+	if !numbering && i != len(fileEntries) {
+		return fmt.Errorf("the number of lines don't match the number of files: Got %d, but expected %d", i, len(fileEntries))
 	}
 
 	if err := scanner.Err(); err != nil {
@@ -71,6 +91,8 @@ func moveFiles(fileEntries []fileEntry) error {
 				return err
 			}
 			log.Printf("Renamed %q to %q", fileEntry.originalPath, fileEntry.newPath)
+			// This is important, because if there is an error later on, we know which files were already moved.
+			// So we can query the user to correct the list, and just call moveFiles again, without files getting messed up.
 			fileEntry.originalPath = fileEntry.newPath
 		}
 	}

main.go

@@ -1,4 +1,4 @@
-// Copyright (c) 2021-2022 David Vogel
+// Copyright (c) 2021-2023 David Vogel
 //
 // This software is released under the MIT License.
 // https://opensource.org/licenses/MIT
@@ -7,6 +7,7 @@ package main
 
 import (
 	"bufio"
+	"flag"
 	"io/fs"
 	"log"
 	"os"
@@ -15,10 +16,15 @@ import (
 	"github.com/skratchdot/open-golang/open"
 )
 
+var flagNoNumbers = flag.Bool("no-numbers", false, "If set, batch-rename will not prepend numbers to every line. If you enable this option you have to make sure that you don't add or remove lines, as otherwise it will mess up your filenames!")
+
 func main() {
+	flag.Parse()
+
 	log.Printf("Started batch-rename %v", Version)
 
 	rootDir := "."
+	numbering := !*flagNoNumbers
 
 	fileEntries := []fileEntry{}
 
@@ -51,51 +57,48 @@ func main() {
 		return
 	}
 
-	log.Printf("Got %d files to rename", len(fileEntries))
+	log.Printf("Found %d files", len(fileEntries))
 
 	// Create temporary file.
-	filePath, err := createEntriesFile(rootDir, fileEntries)
+	filePath, err := createEntriesFile(rootDir, fileEntries, numbering)
 	if err != nil {
-		log.Panicf("Failed to create temporary text file: %v", err)
+		log.Panicf("Failed to create file with filepaths: %v", err)
 	}
 
-	/*if err := openWithDefault(filePath); err != nil {
-		log.Panicf("Failed to open temporary text file: %v", err)
-	}*/
-
 	if err := open.Run(filePath); err != nil {
-		log.Panicf("Failed to open temporary text file: %v", err)
+		log.Panicf("Failed to open file with filepaths: %v", err)
 	}
 
-	log.Print("Editor opened, edit file paths and press any key to continue...")
+	log.Printf("Opening %s in the default editor", filePath)
+	log.Print("You can now edit the filepaths and press any key to continue...")
 	reader.ReadString('\n')
 
 	// Read temporary file back and rename files. Retry on fail.
 	for {
-		if err := readEntriesFile(filePath, fileEntries); err != nil {
-			log.Printf("Failed to read temporary text file: %v", err)
-			log.Print("Update the temporary text file and press any key to retry...")
+		if err := readEntriesFile(filePath, fileEntries, numbering); err != nil {
+			log.Printf("Failed to read filepaths: %v", err)
+			log.Print("Please edit your filepaths, save them and press any key to retry...")
 			reader.ReadString('\n')
 			continue
 		}
 
 		if err := moveFiles(fileEntries); err != nil {
 			log.Printf("Failed to move file: %v", err)
-			log.Print("Update the temporary file and press any key to retry...")
+			log.Print("Please edit your filepaths, save them and press any key to retry...")
 			reader.ReadString('\n')
 			continue
 		}
 
 		break
 	}
 
-	log.Print("Deleting temporary file")
+	log.Print("Deleting filepaths file")
 
 	// Try to delete the temporary file. Retry on fail.
 	for {
 		if err := os.Remove(filePath); err != nil {
-			log.Printf("Failed to remove temporary text file: %v", err)
-			log.Printf("Close the temporary text file and press any key to try again...")
+			log.Printf("Failed to remove file with filepaths: %v", err)
+			log.Printf("Please close your editor and press any key to try again...")
 			reader.ReadString('\n')
 			continue
 		}