zendev-commit

zendev-commit owns commit profiles, Conventional Commits and Gitmoji validation, the interactive commit flow, and its vendored data. It can be installed and used without the complete zendev toolkit.

$ uv add --dev zendev-commit
$ uvx --from zendev-commit zendev-commit --help
$ uvx --from zendev-commit zendev-commit-msg --help

zendev-commit-msg validates complete commit messages. zendev-commit interactively builds a message and invokes git commit.

Python API

from zendev.commit import CommitProfile, validate_commit_message

result = validate_commit_message(
    "feat(parser): accept empty input",
    profile=CommitProfile.CONVENTIONAL,
)
assert result.valid

Profiles

Configure the default profile in the consuming repository:

[tool.zendev.commit]
profile = "conventional"

The --profile option overrides repository configuration. auto reads the nearest pyproject.toml and falls back to zendev.

Examples accepted by the default profile:

🎉 init: begin a project
✨ feat: add export
🐛 fix(parser): handle null token
:memo: docs: update README
🚀 deploy: publish the package

Git-generated Merge, Revert, fixup!, squash!, amend!, and reword! messages are accepted.

Commit hook

With .pre-commit-config.yaml:

repos:
  - repo: https://github.com/zendev-lab/zendev
    rev: v0.1.0
    hooks:
      - id: zendev-commit-msg

With prek.toml:

[[repos]]
repo = "https://github.com/zendev-lab/zendev"
rev = "v0.1.0"
hooks = [
  { id = "zendev-commit-msg" },
]

Install the Git hook:

$ uvx prek install --hook-type commit-msg

An explicit command is also available:

$ uvx --from zendev-commit zendev-commit-msg --profile conventional .git/COMMIT_EDITMSG

Gitmoji data

The default profile uses the vendored catalog in src/zendev/data/gitmojis.json and the reviewable pairing table in src/zendev/data/emoji-conventions.toml. Validation is deterministic and does not access the network.

The retained upstream license is in src/zendev/data/LICENSE.gitmoji. Maintainers should follow the vendored-data procedure when refreshing the catalog.