feat: Improve logging for unchanged files

Author: rushwerks

README.md

@@ -46,8 +46,10 @@ feefifofum <directory1> <directory2>  # Format all feature files in multiple dir
 ```
 
 ### Output
-In its default setting, `feefifofum` will only log the total number of files formatted to the console.
-The `--verbose` or `-v` flag can be passed to log information on which files have been formatted and overall progress.
+In its default setting, `feefifofum` will only log the total number of formatted and unchanged files to the console.
+Files marked as 'unchanged' already meet the required formatting standard and therefore no changes are written to these files.
+
+The `--verbose` or `-v` flag can be passed to log realtime information on which files have been formatted (or are unchanged), and overall progress.
 ```shell
 feefifofum <file1> <file2> <file3> --verbose
 ```

feefifofum/main.py

@@ -21,13 +21,25 @@ def main() -> None:  # pragma: no cover
         logging.warning('No feature file(s) found in specified path(s)')
         return
 
+    changed_count, unchanged_count = 0, 0
     for index, file_path in enumerate(file_paths, 1):
         file_lines = read_file_lines(file_path)
         formatted_file_lines = format_feature_file(file_lines)
+
+        if file_lines == formatted_file_lines:
+            logging.debug(f'({index}/{file_count}) | unchanged | {file_path}')
+            unchanged_count += 1
+            continue
+
         write_file_lines(formatted_file_lines, file_path)
-        logging.debug(f'Formatted: {file_path} ({index}/{file_count})')
+        logging.debug(f'({index}/{file_count}) | formatted | {file_path}')
+        changed_count += 1
+
+    if changed_count:
+        logging.info(f'{changed_count} file(s) formatted')
 
-    logging.info(f'Formatted {file_count} file(s)')
+    if unchanged_count:
+        logging.info(f'{unchanged_count} file(s) unchanged')
 
 
 if __name__ == '__main__':  # pragma: no cover