Merge pull request #23 from kurtmckee/improve-exclusion-matching

Improve exclusion matching

.chipshot.toml

@@ -8,4 +8,5 @@ SPDX-License-Identifier: MIT
 exclusions = [
     "docs/conf.py",
     "docs/_static/custom.css",
+    "tests/files/",
 ]

changelog.d/20231207_073026_kurtmckee_improve_exclusion_matching.rst

@@ -0,0 +1,4 @@
+Changed
+-------
+
+*   Allow exclusions to match directories, too.

docs/how-to/exclusions.rst

@@ -16,12 +16,14 @@ It supports a list of files that Chipshot must ignore.
 The example below will tell Chipshot to exclude ``conf.py``,
 which is the standard name for a Sphinx configuration file;
 it will also ignore ``Gruntfile.js``,
-which is a common name for a Grunt configuration file.
+which is a common name for a Grunt configuration file;
+it will also ignore everything in the ``tests/`` subdirectory.
 
 ..  code-block:: toml
 
     [chipshot]
     exclusions = [
         "docs/conf.py",
         "Gruntfile.js",
+        "tests/",
     ]

src/chipshot/cli.py

@@ -141,7 +141,10 @@ def _get_files(
                 continue
 
             # Ensure that the path is not excluded.
-            if any(sub_path == exclusion for exclusion in exclusions):
+            if any(
+                sub_path == exclusion or sub_path.is_relative_to(exclusion)
+                for exclusion in exclusions
+            ):
                 continue
 
             yield sub_path

tests/conftest.py

@@ -1,3 +1,7 @@
+# This file is a part of Chipshot <https://github.com/kurtmckee/chipshot>
+# Copyright 2022-2023 Kurt McKee <[email protected]>
+# SPDX-License-Identifier: MIT
+
 import copy
 import pathlib
 

tests/test_compare.py

@@ -1,3 +1,7 @@
+# This file is a part of Chipshot <https://github.com/kurtmckee/chipshot>
+# Copyright 2022-2023 Kurt McKee <[email protected]>
+# SPDX-License-Identifier: MIT
+
 import pytest
 
 import chipshot.compare

tests/test_config.py

@@ -1,3 +1,7 @@
+# This file is a part of Chipshot <https://github.com/kurtmckee/chipshot>
+# Copyright 2022-2023 Kurt McKee <[email protected]>
+# SPDX-License-Identifier: MIT
+
 import pytest
 
 

tests/test_reader.py

@@ -1,3 +1,7 @@
+# This file is a part of Chipshot <https://github.com/kurtmckee/chipshot>
+# Copyright 2022-2023 Kurt McKee <[email protected]>
+# SPDX-License-Identifier: MIT
+
 import pathlib
 
 import chipshot.reader

tests/test_reader_encoding.py

@@ -1,3 +1,7 @@
+# This file is a part of Chipshot <https://github.com/kurtmckee/chipshot>
+# Copyright 2022-2023 Kurt McKee <[email protected]>
+# SPDX-License-Identifier: MIT
+
 import codecs
 import logging
 import pathlib

tests/test_reader_header.py

@@ -1,3 +1,7 @@
+# This file is a part of Chipshot <https://github.com/kurtmckee/chipshot>
+# Copyright 2022-2023 Kurt McKee <[email protected]>
+# SPDX-License-Identifier: MIT
+
 import pathlib
 
 import pytest

tests/test_reader_identity.py

@@ -1,3 +1,7 @@
+# This file is a part of Chipshot <https://github.com/kurtmckee/chipshot>
+# Copyright 2022-2023 Kurt McKee <[email protected]>
+# SPDX-License-Identifier: MIT
+
 import pathlib
 
 import pytest

tests/test_reader_newlines.py

@@ -1,3 +1,7 @@
+# This file is a part of Chipshot <https://github.com/kurtmckee/chipshot>
+# Copyright 2022-2023 Kurt McKee <[email protected]>
+# SPDX-License-Identifier: MIT
+
 import pytest
 
 import chipshot.reader.newlines

tests/test_reader_prolog.py

@@ -1,3 +1,7 @@
+# This file is a part of Chipshot <https://github.com/kurtmckee/chipshot>
+# Copyright 2022-2023 Kurt McKee <[email protected]>
+# SPDX-License-Identifier: MIT
+
 import pathlib
 
 import pytest

tests/test_render.py

@@ -1,3 +1,7 @@
+# This file is a part of Chipshot <https://github.com/kurtmckee/chipshot>
+# Copyright 2022-2023 Kurt McKee <[email protected]>
+# SPDX-License-Identifier: MIT
+
 import pathlib
 import textwrap
 

tests/test_writer.py

@@ -1,3 +1,7 @@
+# This file is a part of Chipshot <https://github.com/kurtmckee/chipshot>
+# Copyright 2022-2023 Kurt McKee <[email protected]>
+# SPDX-License-Identifier: MIT
+
 import codecs
 import pathlib