Support --exclude option on fprime-util format (nasa#297)

* Add --exclude argument for excluding directories from formatting

* Apply black format

* Add exclude_file function

* Change parsed.excluded to parsed.exclude

* Add verbose information in exclude_file function

* Apply black format

* Allow file path to exclude in formatting

* Shorten else if to elif

* Apply black format

* Update src/fprime/util/cli.py

* Update src/fprime/util/commands.py

---------

Co-authored-by: Thomas Boyer-Chammard <49786685+thomas-bc@users.noreply.github.com>

Author: rmzmrnn

src/fprime/util/cli.py

@@ -251,6 +251,14 @@ def add_special_parsers(
         default=[],
         help="If specified, --pass-through must be the last argument. Remaining arguments passed to underlying executable",
     )
+    format_parser.add_argument(
+        "--exclude",
+        nargs="+",
+        default=[],
+        type=Path,
+        help="Exclude paths from formatting, taking precedence over all input mechanisms",
+    )
+
     return {
         "hash-to-file": run_hash_to_file,
         "info": run_info,

src/fprime/util/code_formatter.py

@@ -73,6 +73,21 @@ def stage_file(self, filepath: Path) -> None:
         else:
             self._files_to_format.append(filepath)
 
+    def exclude_file(self, filepath: Path) -> None:
+        """Request ClangFormatter to exclude the file for formatting.
+        If the file exists and its extension matches a known C/C++ format,
+        it will be excluded to clang-format when the execute() function is called.
+
+        Args:
+            filepath (str): file path to be excluded.
+        """
+        if filepath in self._files_to_format:
+            if self.verbose:
+                print(f"[INFO] Excluding {filepath} from formatting.")
+            self._files_to_format.remove(filepath)
+        elif self.verbose:
+            print(f"[INFO] {filepath} was not staged for formatting. Skipping.")
+
     def execute(
         self, builder: "Build", context: "Path", args: Tuple[Dict[str, str], List[str]]
     ):

src/fprime/util/commands.py

@@ -201,6 +201,19 @@ def run_code_format(
         for allowed_ext in clang_formatter.allowed_extensions:
             for file in dir_path.rglob(f"*{allowed_ext}"):
                 clang_formatter.stage_file(file)
+    # Remove staged files that are within excluded paths
+    for excluded in parsed.exclude:
+        excluded_path = Path(excluded)
+        if excluded_path.is_file():
+            clang_formatter.exclude_file(excluded_path)
+        elif excluded_path.is_dir():
+            for allowed_ext in clang_formatter.allowed_extensions:
+                for file in excluded_path.rglob(f"*{allowed_ext}"):
+                    clang_formatter.exclude_file(file)
+        else:
+            print(f"[INFO] {excluded_path} is not a valid path. Skipping.")
+            continue
+
     return clang_formatter.execute(build, parsed.path, ({}, parsed.pass_through))