Commitizen pre-commit hook command seems to include random files names

[danielsteman]

Description

I installed the commitizen pre-commit hook along with some other pre-commit hooks:

repos:
  - repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v4.2.0
    hooks:
      - id: check-yaml
        args: [--allow-multiple-documents]
      - id: trailing-whitespace
      - id: end-of-file-fixer
  - repo: https://github.com/psf/black
    rev: 23.7.0
    hooks:
      - id: black
  - repo: https://github.com/astral-sh/ruff-pre-commit
    rev: v0.0.278
    hooks:
      - id: ruff
  - repo: https://github.com/pycqa/isort
    rev: 5.12.0
    hooks:
      - id: isort
  - repo: local
    hooks:
      - id: export-requirements
        name: export requirements from poetry
        entry: bash -c 'cd "$(git rev-parse --show-toplevel)" && poetry export --without-hashes --format=requirements.txt > requirements.txt'
        language: system
  - repo: https://github.com/commitizen-tools/commitizen
    rev: v1.17.0
    hooks:
      - id: commitizen

This config works fine in another project:

commitizen check.........................................................Failed
- hook id: commitizen
- exit code: 14

commit validation: failed!
please enter a commit message in the commitizen format.
commit: asfpaihsagf(semrel): Update semrel stuff in pyproject

pattern: (build|ci|docs|feat|fix|perf|refactor|style|test|chore|revert|bump)(\(\S+\))?:\s.*

But when I run it in another project, it seems to include (arbitrary?) file paths in the cz command:

commitizen check.........................................................Failed
- hook id: commitizen
- exit code: 2

usage: cz [-h] [--debug] [-n NAME] [--version]
          {ls,commit,c,example,info,schema,bump,version,check,init} ...
cz: error: unrecognized arguments: poetry.lock requirements.txt

Steps to reproduce

.pre-commit-config.yaml:

repos:
  - repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v4.2.0
    hooks:
      - id: check-yaml
        args: [--allow-multiple-documents]
      - id: trailing-whitespace
      - id: end-of-file-fixer
  - repo: https://github.com/psf/black
    rev: 23.7.0
    hooks:
      - id: black
  - repo: https://github.com/astral-sh/ruff-pre-commit
    rev: v0.0.278
    hooks:
      - id: ruff
  - repo: https://github.com/pycqa/isort
    rev: 5.12.0
    hooks:
      - id: isort
  - repo: https://github.com/commitizen-tools/commitizen
    rev: v1.17.0
    hooks:
      - id: commitizen

Current behavior

commitizen check.........................................................Failed
- hook id: commitizen
- exit code: 2

usage: cz [-h] [--debug] [-n NAME] [--version]
          {ls,commit,c,example,info,schema,bump,version,check,init} ...
cz: error: unrecognized arguments: poetry.lock requirements.txt

If I then remove poetry.lock and requirements.txt, I get the following:

commitizen check.........................................................Failed
- hook id: commitizen
- exit code: 14

commit validation: failed!
please enter a commit message in the commitizen format.
commit: repos:
  - repo: https://github.com/pre-commit/pre-commit-hooks
    rev: v4.5.0
    hooks:
      - id: check-yaml
        args: [--allow-multiple-documents]
      - id: trailing-whitespace
      - id: end-of-file-fixer
  - repo: https://github.com/psf/black
    rev: 24.2.0
    hooks:
      - id: black
  - repo: https://github.com/astral-sh/ruff-pre-commit
    rev: v0.3.0
    hooks:
      - id: ruff
  - repo: https://github.com/pycqa/isort
    rev: 5.13.2
    hooks:
      - id: isort
  - repo: https://github.com/commitizen-tools/commitizen
    rev: v1.17.0
    hooks:
      - id: commitizen

pattern: (build|ci|docs|feat|fix|perf|refactor|style|test|chore|revert|bump)(\(\S+\))?:\s.*

Where it seems like my whole .pre-commit-config.yaml is included in the cz command ran by the hook.

Desired behavior

commitizen check.........................................................Failed
- hook id: commitizen
- exit code: 14

commit validation: failed!
please enter a commit message in the commitizen format.
commit: asfpaihsagf(semrel): Update semrel stuff in pyproject

pattern: (build|ci|docs|feat|fix|perf|refactor|style|test|chore|revert|bump)(\(\S+\))?:\s.*

Screenshots

No response

Environment

❯ python --version
Python 3.12.2

[noirbizarre]

Hello 👋🏼

Your version of commitizen is really outdated. You should update because there has been numerous changes and fixes since (1.17 was more than 4 years ago).
commitizen is a hook to be used on message validation only (the command was cz check --commit-msg-file) and pre-commit wasn't having anything to specify the expected phase to run a check so you needed to it manually by yourself in your config. So in your case you miss the stages: [commit-msg] statement. In the commit phase, pre-commit is passing modified files as arguments to the hook so it won't ever work without this statement on 1.17.

So either upgrade to 3.x (ideally to the latest) and it will just fix your issue, either if you need to stick with 1.17 for any reason, add the missing statement and consult the matching documentation to avoid more versioning issues: https://github.com/commitizen-tools/commitizen/blob/v1.17.1/docs/check.md

Note: some other plugins in your pre-commit seems outdated too. If you are crafting a new pre-commit file, I strongly advise using the latest version of each plugin to avoid starting with a tech debt.

[danielsteman]

Apologies, I copy+pasted the pre-commit config from this page: https://commitizen-tools.github.io/commitizen/tutorials/auto_check/

Thanks for your reply!