fix(pre-commit): Confine hook to commit-msg stage

The Commitizen pre-commit hook runs cz check, which only makes sense to
do on a commit message, not at other Git hook stages. By default the
hook is currently run on staged files pre-commit, which is nonsensical
unless the files in the repository themselves contain Git commit
messages. The hook is an implausible candidate even for the
prepare-commit-msg stage since this stage is intended for hooks that
modify the commit message rather than check it. Specifying the hook
stage centrally makes it less error-prone to use and saves one line of
configuration for users of the pre-commit hook.

Author: Kurt-von-Laven

.pre-commit-hooks.yaml

@@ -2,6 +2,7 @@
   name: commitizen check
   description: "Check whether the commit message follows commiting rules"
   entry: cz check --commit-msg-file
+  stages: [commit-msg]
   language: python
   language_version: python3
   minimum_pre_commit_version: "1.4.3"

commitizen/commands/init.py

@@ -114,7 +114,7 @@ def _install_pre_commit_hook(self):
         cz_hook_config = {
             "repo": "https://github.com/commitizen-tools/commitizen",
             "rev": f"v{__version__}",
-            "hooks": [{"id": "commitizen", "stages": ["commit-msg"]}],
+            "hooks": [{"id": "commitizen"}],
         }
 
         config_data = {}

docs/README.md

@@ -111,7 +111,6 @@ repos:
     rev: master
     hooks:
       - id: commitizen
-        stages: [commit-msg]
 ```
 
 After the configuration is added, you'll need to run

docs/auto_check.md

@@ -22,7 +22,6 @@ repos:
     rev: v1.17.0
     hooks:
       - id: commitizen
-        stages: [commit-msg]
 ```
 
 * Step 3: Install the configuration into git hook through `pre-commit`

tests/commands/test_init_command.py

@@ -21,7 +21,7 @@ def ask(self):
 cz_hook_config = {
     "repo": "https://github.com/commitizen-tools/commitizen",
     "rev": f"v{__version__}",
-    "hooks": [{"id": "commitizen", "stages": ["commit-msg"]}],
+    "hooks": [{"id": "commitizen"}],
 }
 
 expected_config = (