Fixed #24 - incorrect default file filter for formatter

Author: RobertoRoos

src/tctools/common.py

@@ -20,6 +20,9 @@ class Tool(ABC):
 
     LOGGER_NAME: Optional[str] = None
 
+    # Default value for file filter argument:
+    FILTER_DEFAULT: List[str]
+
     def __init__(self, *args):
         """Pass e.g. ``sys.args[1:]`` (skipping the script part of the arguments).
 
@@ -109,7 +112,7 @@ def set_arguments(cls, parser):
             "--filter",
             help="Target files only with these patterns",
             nargs="+",
-            default=["*.tsproj", "*.xti", "*.plcproj"],
+            default=cls.FILTER_DEFAULT,
         )
 
         return parser

src/tctools/format/format_class.py

@@ -93,6 +93,8 @@ class Formatter(TcTool):
 
     LOGGER_NAME = "formatter"
 
+    FILTER_DEFAULT = ["*.TcPOU", "*.TcGVL", "*.TcDUT"]
+
     _RULE_CLASSES: List[Type[FormattingRule]] = []
 
     def __init__(self, *args):
@@ -133,7 +135,7 @@ def run(self) -> int:
                 self.logger.info("No changes to be made in checked files!")
                 return 0
 
-            self.logger.info(f"{self.files_to_alter} path(s) can be re-sorted")
+            self.logger.info(f"{self.files_to_alter} path(s) should altered")
             return 1
 
         self.logger.info(f"Re-saved {self.files_resaved} path(s)")

src/tctools/xml_sort/xml_sort_class.py

@@ -1,5 +1,5 @@
 import re
-from typing import Dict
+from typing import Dict, List
 
 from lxml import etree
 
@@ -14,6 +14,8 @@ class XmlSorter(TcTool):
 
     LOGGER_NAME = "xml_sorter"
 
+    FILTER_DEFAULT: List[str] = ["*.tsproj", "*.xti", "*.plcproj"]
+
     def __init__(self, *args):
         super().__init__(*args)
 

tests/test_formatter.py

@@ -158,6 +158,32 @@ def test_check(plc_code, caplog):
     assert code_new == 0
 
 
+def test_check_recursive(plc_code, caplog):
+    """Test `check` flag for formatter, on a folder"""
+    project_folder = plc_code / "TwinCAT Project1"
+    config = project_folder / ".editorconfig"
+    config.write_text(
+        """root = true
+[*.TcPOU]
+indent_style = space
+indent_size = 4
+"""
+    )
+    formatter = Formatter(str(project_folder), "--check", "-r", "-l", "DEBUG")
+    code = formatter.run()
+
+    for expected_file in [
+        "FB_Example.TcPOU",
+        "FB_Full.TcPOU",
+        "MAIN.TcPOU",
+        "GVL_Version.TcGVL",
+        "ST_Example.TcDUT",
+    ]:
+        assert any(expected_file in msg for msg in caplog.messages)
+
+    assert code != 0
+
+
 def test_reformat_empty_config(plc_code):
     """Test reformatting with no or empty `editorconfig`.