Add --skip-gitignore flag (#307)

* Add --ignore-gitignore flag

* Rename --ignore-gitignore to --skip-gitignore

Author: bhirsz

CHANGES.md

@@ -28,6 +28,8 @@ by using ``skip_documentation`` parameter ([#300](https://github.com/MarketSquar
 robotidy --configure NormalizeSeparators:skip_documentation=True src
 ```
 
+### Other
+- Added ``--skip-gitignore`` flag to ignore ``.gitignore`` files and parse files listed there ([#299](https://github.com/MarketSquare/robotframework-tidy/issues/299)). 
 
 ## 2.3
 

docs/source/configuration/index.rst

@@ -28,6 +28,10 @@ Robotidy reads and ignores paths from ``.gitignore`` and ``--exclude``. You can
 
     robotidy --extend-exclude skip_me.robot|some_dir/* .
 
+To parse files listed in ``.gitignore`` use ``--skip-gitignore`` flag::
+
+    robotidy --skip-gitignore .
+
 .. rubric:: Target Version
 
 Robotidy can automatically disable transformers that are not supported in target version of Robot Framework.

robotidy/api.py

@@ -37,6 +37,7 @@ def __init__(self, src: str, output: Optional[str], **kwargs):
             src=(),
             exclude=exclude,
             extend_exclude=extend_exclude,
+            skip_gitignore=False,
             overwrite=False,
             show_diff=False,
             formatting_config=formatting_config,

robotidy/app.py

@@ -26,6 +26,7 @@ def __init__(
         src: Tuple[str, ...],
         exclude: Optional[Pattern],
         extend_exclude: Optional[Pattern],
+        skip_gitignore: bool,
         overwrite: bool,
         show_diff: bool,
         formatting_config: GlobalFormattingConfig,
@@ -36,7 +37,7 @@ def __init__(
         target_version: int,
         color: bool,
     ):
-        self.sources = get_paths(src, exclude, extend_exclude)
+        self.sources = get_paths(src, exclude, extend_exclude, skip_gitignore)
         self.overwrite = overwrite
         self.show_diff = show_diff
         self.check = check

robotidy/cli.py

@@ -60,7 +60,7 @@
                 "--endline",
             ],
         },
-        {"name": "File exclusion", "options": ["--exclude", "--extend-exclude"]},
+        {"name": "File exclusion", "options": ["--exclude", "--extend-exclude", "--skip-gitignore"]},
         {
             "name": "Other",
             "options": ["--target-version", "--verbose", "--color", "--output", "--version", "--help"],
@@ -243,6 +243,12 @@ def print_transformers_list(target_version: int):
         " excluded ones. (Useful if you simply want to add to the default)"
     ),
 )
+@click.option(
+    "--skip-gitignore",
+    is_flag=True,
+    show_default=True,
+    help="Skip **.gitignore** files and do not ignore files listed inside.",
+)
 @click.option(
     "--config",
     type=click.Path(
@@ -390,6 +396,7 @@ def cli(
     src: Tuple[str, ...],
     exclude: Optional[Pattern],
     extend_exclude: Optional[Pattern],
+    skip_gitignore: bool,
     overwrite: bool,
     diff: bool,
     color: bool,
@@ -457,6 +464,7 @@ def cli(
         src=src,
         exclude=exclude,
         extend_exclude=extend_exclude,
+        skip_gitignore=skip_gitignore,
         overwrite=overwrite,
         show_diff=diff,
         formatting_config=formatting_config,

robotidy/files.py

@@ -104,9 +104,14 @@ def should_parse_path(
     return True
 
 
-def get_paths(src: Tuple[str, ...], exclude: Optional[Pattern], extend_exclude: Optional[Pattern]):
+def get_paths(
+    src: Tuple[str, ...], exclude: Optional[Pattern], extend_exclude: Optional[Pattern], skip_gitignore: bool
+):
     root = find_project_root(src)
-    gitignore = get_gitignore(root)
+    if skip_gitignore:
+        gitignore = None
+    else:
+        gitignore = get_gitignore(root)
     sources = set()
     for s in src:
         if s == "-":

tests/utest/test_cli.py

@@ -337,6 +337,7 @@ def test_line_sep(self, line_sep, test_data_dir):
             actual_str = f.read()
         assert actual_str == expected_str, "Line endings does not match"
 
+    @pytest.mark.parametrize("skip_gitignore", [True, False])
     @pytest.mark.parametrize(
         "exclude, extend_exclude, allowed",
         [
@@ -346,11 +347,18 @@ def test_line_sep(self, line_sep, test_data_dir):
             ("test.resource", "nested/*", ["test.robot"]),
         ],
     )
-    def test_exclude_gitignore(self, exclude, extend_exclude, allowed, test_data_dir):
+    def test_exclude_gitignore(self, exclude, extend_exclude, skip_gitignore, allowed, test_data_dir):
+        if skip_gitignore:
+            allowed = allowed + ["test2.robot"]  # extend will not work due to mutability of list
+            if not extend_exclude or "nested" not in extend_exclude:
+                allowed = allowed + ["nested/test2.robot"]
         source = test_data_dir / "gitignore"
         allowed_paths = {Path(source, path) for path in allowed}
         paths = get_paths(
-            (str(source),), exclude=validate_regex(exclude), extend_exclude=validate_regex(extend_exclude)
+            (str(source),),
+            exclude=validate_regex(exclude),
+            extend_exclude=validate_regex(extend_exclude),
+            skip_gitignore=skip_gitignore,
         )
         assert paths == allowed_paths
 

tests/utest/test_utils.py

@@ -23,6 +23,7 @@ def app():
         src=(".",),
         exclude=None,
         extend_exclude=None,
+        skip_gitignore=False,
         overwrite=False,
         show_diff=False,
         formatting_config=formatting_config,