Description

Use new --allow-abort option. Prevent pre-commit hook from complaining when a commit is aborted by default, but allow users to override this option in their pre-commit config by specifying it in args, not entry. Move --commit-msg-file option from entry to args since it has to be the last option.

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.

Change minimum pre-commit version from 0.15.4 to 1.4.3. pre-commit 1.4.3, released 2018年01月02日, is the minimum pre-commit version at which language_version: python3 is translated to the correct py launcher call on Windows.

Don't require serial execution. require_serial is not pertinent to commit-msg hooks or hooks that themselves execute serially. The option is intended to prevent fork-bombing that can occur when pre-commit runs a hook that itself spawns many processes many times in parallel.

Checklist

• Add test cases to all the changes you introduce
• Run ./scripts/format and ./scripts/test locally to ensure this change passes linter check and test
• Test the changes on the local machine manually
• Update the documentation for the changes

Expected behavior

The commit hook continues to work as before but without requiring that the commit-msg stage be specified in your .pre-commit-config.yaml or giving a misleading error message when the commit is aborted by saving an empty commit message in your editor.

Steps to Test This Pull Request

1. Replace your Commitizen hook config in your .pre-commit-config.yaml with the following:

   repos:
    - repo: https://github.com/Kurt-von-Laven/commitizen
    rev: allow-abort
    hooks:
    - id: commitizen

2. Ensure that you have pre-commit 1.4.3 or higher installed.

3. Install commit-msg hooks if you haven't already via: pre-commit install --hook-type commit-msg.

4. Commit some changes to your repository.

5. If the commit message was invalid, the hook will fail, and otherwise it will succeed. Empty commit messages now fall in the latter category, and the commit aborts cleanly without a misleading error.

Additional context

Follows on #512, which added the --allow-abort option to cz check. Reverts #135, which removed stages: [commit-msg].