Merge pull request #23 from Don-Felice/nicer_reports

feat(sed): nicer reporting

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ## Unreleased Changes
 
+- streaming editor: nicer reporting
 
 ## v1.5.0 - Feb. 22, 2024
 

clifs/plugins/edit.py

@@ -99,8 +99,7 @@ def init_parser(cls, parser: ArgumentParser) -> None:
             "--max_previews",
             type=int,
             default=5,
-            help="Max number of changes shown in preview mode. Each line in a file "
-            "where 'pattern' matches at least once counts as a change. "
+            help="Maximum number of line changes shown in the preview mode. "
             "Set to zero to skip preview mode completely. Only for the brave...",
         )
 
@@ -167,7 +166,7 @@ def run(self) -> None:
                     self.replace(file)
                     self.progress["overall"].update(
                         self.tasks["progress"],
-                        last_action=f"Edited: {file.name}",
+                        last_action=f"edited '{file.name}'",
                     )
                     self.progress["overall"].advance(self.tasks["progress"])
                     self.progress["counts"].advance(self.tasks["files_edited"])
@@ -227,8 +226,8 @@ def get_tasks(self) -> Dict[str, TaskID]:
         tasks["files_edited"] = self.progress["counts"].add_task(
             "Files edited:", total=None
         )
-        tasks["total_replacements"] = self.progress["counts"].add_task(
-            "Total replacements:", total=None
+        tasks["lines_changed_total"] = self.progress["counts"].add_task(
+            "Lines modified:", total=None
         )
         return tasks
 
@@ -292,7 +291,7 @@ def replace(self, input_file: Path) -> None:
                     mod_line = re.sub(self.pattern, self.replacement, line)
                     if mod_line != line:
                         self.progress["counts"].advance(
-                            self.tasks["total_replacements"]
+                            self.tasks["lines_changed_total"]
                         )
                     output_fh.write(mod_line)
             else:
@@ -301,7 +300,7 @@ def replace(self, input_file: Path) -> None:
                         mod_line = re.sub(self.pattern, self.replacement, line)
                         if mod_line != line:
                             self.progress["counts"].advance(
-                                self.tasks["total_replacements"]
+                                self.tasks["lines_changed_total"]
                             )
                         output_fh.write(mod_line)
                     else: