commit-check 2.2.2__py3-none-any.whl → 2.3.0__py3-none-any.whl

commit_check/config.py

@@ -15,6 +15,8 @@ except ImportError:
 DEFAULT_CONFIG_PATHS = [
     Path("cchk.toml"),
     Path("commit-check.toml"),
+    Path(".github/cchk.toml"),
+    Path(".github/commit-check.toml"),
 ]
 
 

commit_check/main.py

@@ -43,7 +43,7 @@ def _get_parser() -> argparse.ArgumentParser:
     parser.add_argument(
         "-c",
         "--config",
-        help="path to config file (cchk.toml or commit-check.toml). If not specified, searches for cchk.toml in current directory",
+        help="path to config file (cchk.toml or commit-check.toml). If not specified, searches for config in: cchk.toml, commit-check.toml, .github/cchk.toml, .github/commit-check.toml",
     )
 
     parser.add_argument(

commit_check/util.py

@@ -24,7 +24,7 @@ except Exception:  # pragma: no cover
         _toml = None  # type: ignore[assignment]
 
 
-def _find_check(checks: list, check_type: str) -> dict | None:
+def _find_check(checks: list, check_type: str) -> Optional[dict]:
     """Return the first check dict matching check_type, else None."""
     for check in checks:
         if check.get("check") == check_type:
@@ -164,13 +164,18 @@ def _load_toml(path: PurePath) -> Dict[str, Any]:
 def _find_config_file(path_hint: str) -> Optional[PurePath]:
     """Resolve config file.
 
-    - If a directory is passed, search in priority: commit-check.toml, cchk.toml
+    - If a directory is passed, search in priority: cchk.toml, commit-check.toml, .github/cchk.toml, .github/commit-check.toml
     - If a file ending with .toml is passed, use it if exists.
     - Ignore legacy .commit-check.yml entirely.
     """
     p = Path(path_hint)
     if p.is_dir():
-        for name in ("commit-check.toml", "cchk.toml"):
+        for name in (
+            "cchk.toml",
+            "commit-check.toml",
+            ".github/cchk.toml",
+            ".github/commit-check.toml",
+        ):
             candidate = p / name
             if candidate.exists():
                 return candidate
@@ -254,7 +259,7 @@ def print_error_message(check_type: str, regex: str, error: str, reason: str):
     print(error)
 
 
-def print_suggestion(suggest: str | None) -> None:
+def print_suggestion(suggest: Optional[str]) -> None:
     """Print suggestion to user
     :param suggest: what message to print out
     """

{commit_check-2.2.2.dist-info → commit_check-2.3.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: commit-check
-Version: 2.2.2
+Version: 2.3.0
 Summary: Check commit message formatting, branch naming, commit author, email, and more.
 Author-email: Xianpeng Shen <xianpeng.shen@gmail.com>
 License-Expression: MIT
@@ -121,7 +121,7 @@ Use Default Configuration
 Use Custom Configuration
 ~~~~~~~~~~~~~~~~~~~~~~~~
 
-To customize the behavior, create a configuration file named ``cchk.toml`` or ``commit-check.toml`` in your repository's root directory, e.g., `cchk.toml <https://github.com/commit-check/commit-check/blob/main/cchk.toml>`_
+To customize the behavior, create a configuration file named ``cchk.toml`` or ``commit-check.toml`` in your repository's root directory or in the ``.github`` folder, e.g., `cchk.toml <https://github.com/commit-check/commit-check/blob/main/cchk.toml>`_ or ``.github/cchk.toml``.
 
 Usage
 -----

commit_check-2.3.0.dist-info/RECORD

@@ -0,0 +1,14 @@
+commit_check/__init__.py,sha256=6bUw-6fUjCN5qAxe6i4mUztQiAHpjOhyPHsegW1tbBc,1297
+commit_check/config.py,sha256=88zOLW6W2DHQjglxfSR3LQhCXgw-QcfEg118-OaWxIg,1031
+commit_check/engine.py,sha256=O9H39JgqrzWclfVTZYf-tJP8lAhHzGfV7j-CIxAsXWA,19348
+commit_check/imperatives.py,sha256=b_olcxhoHW2LMHaO9COVlVUdLE-7uifo9WeSY7rPql4,3582
+commit_check/main.py,sha256=SSQfN5p5AQoG0G_AFXA2wAoTcOJK8N8m8_gj8hkH-OI,7040
+commit_check/rule_builder.py,sha256=0UqMQxDiPNgqEjmRTYnyHimCA7vZRZqgqdm7ughp3DY,9205
+commit_check/rules_catalog.py,sha256=FSRsdecwfUteEp3J8lnfehLu4j6owZlWfDzPa1ar1Fg,4288
+commit_check/util.py,sha256=4c9cxbBR3ZBSmYGNmzj87XWWr0zsCV8tmg1Z1yZ3iBI,8501
+commit_check-2.3.0.dist-info/licenses/LICENSE,sha256=VAJ9TE1ov8aUKmeoBRYqciMs0CXag1TeDCoLhwbeQmA,1095
+commit_check-2.3.0.dist-info/METADATA,sha256=TlR6GZ1noth7Nx-brsfWEs9bSur2rRiu4GaE5N2zle4,9540
+commit_check-2.3.0.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
+commit_check-2.3.0.dist-info/entry_points.txt,sha256=YMrkFGeub-3-IanV1d9qnopXVaRQM7MA9foXKW9iZ88,86
+commit_check-2.3.0.dist-info/top_level.txt,sha256=Wf46u-ooHBMJNHbhfrBNQw3wC5_m8wt-o_Lfbc4QpRg,13
+commit_check-2.3.0.dist-info/RECORD,,

commit_check-2.2.2.dist-info/RECORD

@@ -1,14 +0,0 @@
-commit_check/__init__.py,sha256=6bUw-6fUjCN5qAxe6i4mUztQiAHpjOhyPHsegW1tbBc,1297
-commit_check/config.py,sha256=1Th_57ekaYorJFLpSjZq-HW5U5iuVGYWBBAUj8kp9pI,961
-commit_check/engine.py,sha256=O9H39JgqrzWclfVTZYf-tJP8lAhHzGfV7j-CIxAsXWA,19348
-commit_check/imperatives.py,sha256=b_olcxhoHW2LMHaO9COVlVUdLE-7uifo9WeSY7rPql4,3582
-commit_check/main.py,sha256=-leaum2NqejOixOWNtUnuxEfNcxP_gVQyZRUr8gh8jE,6985
-commit_check/rule_builder.py,sha256=0UqMQxDiPNgqEjmRTYnyHimCA7vZRZqgqdm7ughp3DY,9205
-commit_check/rules_catalog.py,sha256=FSRsdecwfUteEp3J8lnfehLu4j6owZlWfDzPa1ar1Fg,4288
-commit_check/util.py,sha256=bvB4w0jSdgot5eOThmn9iV1IwKjBX_B8hB2T9hhrskQ,8340
-commit_check-2.2.2.dist-info/licenses/LICENSE,sha256=VAJ9TE1ov8aUKmeoBRYqciMs0CXag1TeDCoLhwbeQmA,1095
-commit_check-2.2.2.dist-info/METADATA,sha256=o4qUeKoPNUCGae1ewzvKSjRwyZvuUDMIyoL9ku6vTEQ,9485
-commit_check-2.2.2.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
-commit_check-2.2.2.dist-info/entry_points.txt,sha256=YMrkFGeub-3-IanV1d9qnopXVaRQM7MA9foXKW9iZ88,86
-commit_check-2.2.2.dist-info/top_level.txt,sha256=Wf46u-ooHBMJNHbhfrBNQw3wC5_m8wt-o_Lfbc4QpRg,13
-commit_check-2.2.2.dist-info/RECORD,,