commit-check 2.4.0__py3-none-any.whl → 2.4.2__py3-none-any.whl

commit_check/imperatives.py

@@ -52,6 +52,7 @@ IMPERATIVES = {
     "declare",
     "decode",
     "decorate",
+    "decrease",
     "define",
     "delegate",
     "delete",
@@ -60,6 +61,7 @@ IMPERATIVES = {
     "describe",
     "detect",
     "determine",
+    "disable",
     "display",
     "download",
     "drop",
@@ -107,6 +109,8 @@ IMPERATIVES = {
     "identify",
     "implement",
     "import",
+    "include",
+    "increase",
     "indicate",
     "init",
     "initialise",
@@ -116,6 +120,7 @@ IMPERATIVES = {
     "insert",
     "instantiate",
     "intercept",
+    "introduce",
     "invoke",
     "iterate",
     "join",
@@ -126,6 +131,7 @@ IMPERATIVES = {
     "load",
     "log",
     "look",
+    "lower",
     "make",
     "manage",
     "manipulate",
@@ -141,7 +147,10 @@ IMPERATIVES = {
     "note",
     "obtain",
     "open",
+    "optimize",
     "output",
+    "organize",
+    "orchestrate",
     "override",
     "overwrite",
     "package",
@@ -157,6 +166,7 @@ IMPERATIVES = {
     "populate",
     "post",
     "prepare",
+    "prevent",
     "print",
     "process",
     "produce",
@@ -169,6 +179,7 @@ IMPERATIVES = {
     "read",
     "record",
     "redesign",
+    "refactor",
     "refer",
     "refresh",
     "register",
@@ -187,6 +198,7 @@ IMPERATIVES = {
     "retrieve",
     "return",
     "revert",
+    "rework",
     "roll",
     "rollback",
     "round",
@@ -202,6 +214,7 @@ IMPERATIVES = {
     "serve",
     "set",
     "show",
+    "simplify",
     "simulate",
     "source",
     "specify",
@@ -230,6 +243,7 @@ IMPERATIVES = {
     "try",
     "turn",
     "tweak",
+    "unify",
     "update",
     "upload",
     "use",

commit_check/main.py

@@ -31,6 +31,7 @@ def _get_parser() -> argparse.ArgumentParser:
     parser = argparse.ArgumentParser(
         prog="commit-check",
         description="Check commit message, branch name, author name, email, and more.",
+        formatter_class=argparse.RawDescriptionHelpFormatter,
     )
 
     parser.add_argument(
@@ -47,14 +48,25 @@ def _get_parser() -> argparse.ArgumentParser:
     )
 
     parser.add_argument(
+        "commit_msg_file",
+        nargs="?",
+        default=None,
+        help="path to commit message file (positional argument for pre-commit compatibility)",
+    )
+
+    # Main check type arguments
+    check_group = parser.add_argument_group(
+        "check types", "Specify which validation checks to run"
+    )
+
+    check_group.add_argument(
         "-m",
         "--message",
-        nargs="?",
-        const="",
-        help="validate commit message. Optionally specify file path, otherwise reads from stdin if available",
+        action="store_true",
+        help="validate commit message (file path can be provided as positional argument for pre-commit compatibility)",
     )
 
-    parser.add_argument(
+    check_group.add_argument(
         "-b",
         "--branch",
         help="check current git branch name",
@@ -62,7 +74,7 @@ def _get_parser() -> argparse.ArgumentParser:
         required=False,
     )
 
-    parser.add_argument(
+    check_group.add_argument(
         "-n",
         "--author-name",
         help="check git author name",
@@ -70,7 +82,7 @@ def _get_parser() -> argparse.ArgumentParser:
         required=False,
     )
 
-    parser.add_argument(
+    check_group.add_argument(
         "-e",
         "--author-email",
         help="check git author email",
@@ -78,7 +90,7 @@ def _get_parser() -> argparse.ArgumentParser:
         required=False,
     )
 
-    parser.add_argument(
+    check_group.add_argument(
         "-d",
         "--dry-run",
         help="perform a dry run without failing (always returns 0)",
@@ -86,8 +98,12 @@ def _get_parser() -> argparse.ArgumentParser:
         required=False,
     )
 
-    # Commit configuration options
-    parser.add_argument(
+    # Commit message configuration options
+    commit_group = parser.add_argument_group(
+        "commit message options", "Configuration options for --message validation"
+    )
+
+    commit_group.add_argument(
         "--conventional-commits",
         type=parse_bool,
         default=None,
@@ -95,7 +111,7 @@ def _get_parser() -> argparse.ArgumentParser:
         help="enforce conventional commits format (true/false)",
     )
 
-    parser.add_argument(
+    commit_group.add_argument(
         "--subject-capitalized",
         type=parse_bool,
         default=None,
@@ -103,7 +119,7 @@ def _get_parser() -> argparse.ArgumentParser:
         help="require subject to start with capital letter (true/false)",
     )
 
-    parser.add_argument(
+    commit_group.add_argument(
         "--subject-imperative",
         type=parse_bool,
         default=None,
@@ -111,7 +127,7 @@ def _get_parser() -> argparse.ArgumentParser:
         help="require subject to use imperative mood (true/false)",
     )
 
-    parser.add_argument(
+    commit_group.add_argument(
         "--subject-max-length",
         type=parse_int,
         default=None,
@@ -119,7 +135,7 @@ def _get_parser() -> argparse.ArgumentParser:
         help="maximum length of commit subject",
     )
 
-    parser.add_argument(
+    commit_group.add_argument(
         "--subject-min-length",
         type=parse_int,
         default=None,
@@ -127,7 +143,7 @@ def _get_parser() -> argparse.ArgumentParser:
         help="minimum length of commit subject",
     )
 
-    parser.add_argument(
+    commit_group.add_argument(
         "--allow-commit-types",
         type=parse_list,
         default=None,
@@ -135,7 +151,7 @@ def _get_parser() -> argparse.ArgumentParser:
         help="comma-separated list of allowed commit types (e.g., feat,fix,docs)",
     )
 
-    parser.add_argument(
+    commit_group.add_argument(
         "--allow-merge-commits",
         type=parse_bool,
         default=None,
@@ -143,7 +159,7 @@ def _get_parser() -> argparse.ArgumentParser:
         help="allow merge commits (true/false)",
     )
 
-    parser.add_argument(
+    commit_group.add_argument(
         "--allow-revert-commits",
         type=parse_bool,
         default=None,
@@ -151,7 +167,7 @@ def _get_parser() -> argparse.ArgumentParser:
         help="allow revert commits (true/false)",
     )
 
-    parser.add_argument(
+    commit_group.add_argument(
         "--allow-empty-commits",
         type=parse_bool,
         default=None,
@@ -159,7 +175,7 @@ def _get_parser() -> argparse.ArgumentParser:
         help="allow empty commit messages (true/false)",
     )
 
-    parser.add_argument(
+    commit_group.add_argument(
         "--allow-fixup-commits",
         type=parse_bool,
         default=None,
@@ -167,7 +183,7 @@ def _get_parser() -> argparse.ArgumentParser:
         help="allow fixup commits (true/false)",
     )
 
-    parser.add_argument(
+    commit_group.add_argument(
         "--allow-wip-commits",
         type=parse_bool,
         default=None,
@@ -175,7 +191,7 @@ def _get_parser() -> argparse.ArgumentParser:
         help="allow WIP commits (true/false)",
     )
 
-    parser.add_argument(
+    commit_group.add_argument(
         "--require-body",
         type=parse_bool,
         default=None,
@@ -183,7 +199,7 @@ def _get_parser() -> argparse.ArgumentParser:
         help="require commit body (true/false)",
     )
 
-    parser.add_argument(
+    commit_group.add_argument(
         "--require-signed-off-by",
         type=parse_bool,
         default=None,
@@ -191,7 +207,7 @@ def _get_parser() -> argparse.ArgumentParser:
         help="require 'Signed-off-by' trailer (true/false)",
     )
 
-    parser.add_argument(
+    commit_group.add_argument(
         "--ignore-authors",
         type=parse_list,
         default=None,
@@ -200,7 +216,11 @@ def _get_parser() -> argparse.ArgumentParser:
     )
 
     # Branch configuration options
-    parser.add_argument(
+    branch_group = parser.add_argument_group(
+        "branch options", "Configuration options for --branch validation"
+    )
+
+    branch_group.add_argument(
         "--conventional-branch",
         type=parse_bool,
         default=None,
@@ -208,7 +228,7 @@ def _get_parser() -> argparse.ArgumentParser:
         help="enforce conventional branch naming (true/false)",
     )
 
-    parser.add_argument(
+    branch_group.add_argument(
         "--allow-branch-types",
         type=parse_list,
         default=None,
@@ -216,7 +236,7 @@ def _get_parser() -> argparse.ArgumentParser:
         help="comma-separated list of allowed branch types (e.g., feature,bugfix,hotfix)",
     )
 
-    parser.add_argument(
+    branch_group.add_argument(
         "--allow-branch-names",
         type=parse_list,
         default=None,
@@ -224,7 +244,7 @@ def _get_parser() -> argparse.ArgumentParser:
         help="comma-separated list of additional allowed branch names",
     )
 
-    parser.add_argument(
+    branch_group.add_argument(
         "--require-rebase-target",
         type=str,
         default=None,
@@ -232,7 +252,7 @@ def _get_parser() -> argparse.ArgumentParser:
         help="target branch for rebase validation",
     )
 
-    parser.add_argument(
+    branch_group.add_argument(
         "--branch-ignore-authors",
         type=parse_list,
         default=None,
@@ -296,11 +316,17 @@ def main() -> int:
         rule_builder = RuleBuilder(config_data)
         all_rules = rule_builder.build_all_rules()
 
+        # Handle positional commit_msg_file argument for pre-commit compatibility
+        # Store the file path separately from the boolean flag
+        commit_msg_file_path = None
+        if args.commit_msg_file:
+            commit_msg_file_path = args.commit_msg_file
+            # If a file was provided positionally, always enable message checking
+            args.message = True
+
         # Filter rules based on CLI arguments
         requested_checks = []
-        if (
-            args.message is not None
-        ):  # Check for None explicitly since empty string is valid
+        if args.message:  # args.message is now a boolean flag
             # Add commit message related checks
             requested_checks.extend(
                 [
@@ -340,18 +366,16 @@ def main() -> int:
         stdin_content = None
         commit_file_path = None
 
-        if (
-            args.message is not None
-        ):  # Check explicitly for None since empty string is valid
-            if args.message == "":
-                # Only set stdin_content if there's actual piped input
+        if args.message:  # args.message is a boolean flag
+            # Check if we have a file path from positional argument
+            if commit_msg_file_path:
+                commit_file_path = commit_msg_file_path
+            else:
+                # No file path provided, try reading from stdin
                 stdin_content = stdin_reader.read_piped_input()
                 if not stdin_content:
                     # No stdin and no file - let validators get data from git themselves
                     stdin_content = None
-            else:
-                # Message is a file path
-                commit_file_path = args.message
         elif not any([args.branch, args.author_name, args.author_email]):
             # If no specific validation type is requested, don't read stdin
             pass

{commit_check-2.4.0.dist-info → commit_check-2.4.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: commit-check
-Version: 2.4.0
+Version: 2.4.2
 Summary: Check commit message formatting, branch naming, commit author, email, and more.
 Author-email: Xianpeng Shen <xianpeng.shen@gmail.com>
 License-Expression: MIT
@@ -149,7 +149,7 @@ For one-off checks or CI/CD pipelines, you can configure via CLI arguments or en
       - repo: https://github.com/commit-check/commit-check
         rev: v2.3.0
         hooks:
-          - id: commit-check
+          - id: check-message
             args:
               - --subject-imperative=false
               - --subject-max-length=100

{commit_check-2.4.0.dist-info → commit_check-2.4.2.dist-info}/RECORD

@@ -2,14 +2,14 @@ commit_check/__init__.py,sha256=6bUw-6fUjCN5qAxe6i4mUztQiAHpjOhyPHsegW1tbBc,1297
 commit_check/config.py,sha256=88zOLW6W2DHQjglxfSR3LQhCXgw-QcfEg118-OaWxIg,1031
 commit_check/config_merger.py,sha256=QwOLi3-pm-1w77aMiBeJzJLKoERDJlzH4IfTyNa421I,9427
 commit_check/engine.py,sha256=O9H39JgqrzWclfVTZYf-tJP8lAhHzGfV7j-CIxAsXWA,19348
-commit_check/imperatives.py,sha256=btNOK7HWYB3-Dc58OdgWnxW0YSHl4Q5oFEiN9jqsByM,3612
-commit_check/main.py,sha256=Hth6h2wrHFnrJro6TKL5AzkTORaUWp-p2xCjgq3v2-4,10977
+commit_check/imperatives.py,sha256=dNLeGUaSjfWtKNcFnmMWWmzcfX5J2sTCWZcOmEKlbm4,3829
+commit_check/main.py,sha256=Ozm-ZJcIo-sjuXA7NZtEQCxP9PzKsKN9yP0_puIBs8Y,12094
 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.4.0.dist-info/licenses/LICENSE,sha256=VAJ9TE1ov8aUKmeoBRYqciMs0CXag1TeDCoLhwbeQmA,1095
-commit_check-2.4.0.dist-info/METADATA,sha256=f18hat-Ayk0bgUFqQSx7yxS09RVvuTdATDeharpmG-k,10723
-commit_check-2.4.0.dist-info/WHEEL,sha256=wUyA8OaulRlbfwMtmQsvNngGrxQHAvkKcvRmdizlJi0,92
-commit_check-2.4.0.dist-info/entry_points.txt,sha256=YMrkFGeub-3-IanV1d9qnopXVaRQM7MA9foXKW9iZ88,86
-commit_check-2.4.0.dist-info/top_level.txt,sha256=Wf46u-ooHBMJNHbhfrBNQw3wC5_m8wt-o_Lfbc4QpRg,13
-commit_check-2.4.0.dist-info/RECORD,,
+commit_check-2.4.2.dist-info/licenses/LICENSE,sha256=VAJ9TE1ov8aUKmeoBRYqciMs0CXag1TeDCoLhwbeQmA,1095
+commit_check-2.4.2.dist-info/METADATA,sha256=h7-PAMqvqWCSMgSCvaz8aCRlom8fp2bs4feYStJhoAY,10724
+commit_check-2.4.2.dist-info/WHEEL,sha256=YCfwYGOYMi5Jhw2fU4yNgwErybb2IX5PEwBKV4ZbdBo,91
+commit_check-2.4.2.dist-info/entry_points.txt,sha256=YMrkFGeub-3-IanV1d9qnopXVaRQM7MA9foXKW9iZ88,86
+commit_check-2.4.2.dist-info/top_level.txt,sha256=Wf46u-ooHBMJNHbhfrBNQw3wC5_m8wt-o_Lfbc4QpRg,13
+commit_check-2.4.2.dist-info/RECORD,,

{commit_check-2.4.0.dist-info → commit_check-2.4.2.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: setuptools (80.10.2)
+Generator: setuptools (82.0.0)
 Root-Is-Purelib: true
 Tag: py3-none-any