cz-path
Commitizen plugin that prefixes commit messages with the common path or prefix of staged files.
Science Score: 44.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (11.4%) to scientific vocabulary
Keywords
Repository
Commitizen plugin that prefixes commit messages with the common path or prefix of staged files.
Basic Info
- Host: GitHub
- Owner: Tatsh
- License: mit
- Language: Python
- Default Branch: master
- Homepage: https://tatsh.github.io/cz-path/
- Size: 1.18 MB
Statistics
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
- Releases: 0
Topics
Metadata Files
README.md
cz-path
Commitizen plugin that prefixes commit messages with the common path or prefix of staged files.
Installation
Poetry
Example with dev group:
shell
poetry add -G dev cz-path
Pip
shell
pip install cz-path
Usage
Pass -n cz_path to cz or add it to your configuration file.
By default, src/ will be removed from any determined prefix. This can be customised by setting
remove_path_prefixes to []. You also may want to add other locations such as a module name.
Adding / is not required.
pyproject.toml
toml
[tool.commitizen]
name = "cz_path"
remove_path_prefixes = ["src", "module_name"]
.cz.json
json
{
"commitizen": {
"name": "cz_path",
"remove_path_prefixes": ["src", "module_name"]
}
}
Scenarios
| Staged files | Path prefix | String prefix |
| ---------------------- | ----------- | ------------- |
| src/a.c, src/b.c | src | src/ |
| src/a1.c, src/a2.c | src | src/a |
| a.c, b.c | (no option) | (no option) |
If no prefix is found amongst the staged files, only the choices project and empty will be given.
Owner
- Login: Tatsh
- Kind: user
- Repositories: 87
- Profile: https://github.com/Tatsh
Citation (CITATION.cff)
authors:
- family-names: 'Udvare'
given-names: 'Andrew'
cff-version: '1.2.0'
date-released: '2025-07-14'
message: 'If you use this software, please cite it as below.'
title: 'cz-path'
version: '0.0.1'
GitHub Events
Total
- Delete event: 12
- Issue comment event: 15
- Push event: 23
- Pull request event: 22
- Create event: 19
Last Year
- Delete event: 12
- Issue comment event: 15
- Push event: 23
- Pull request event: 22
- Create event: 19
Issues and Pull Requests
Last synced: 4 months ago
All Time
- Total issues: 0
- Total pull requests: 11
- Average time to close issues: N/A
- Average time to close pull requests: about 7 hours
- Total issue authors: 0
- Total pull request authors: 1
- Average comments per issue: 0
- Average comments per pull request: 0.64
- Merged pull requests: 4
- Bot issues: 0
- Bot pull requests: 11
Past Year
- Issues: 0
- Pull requests: 11
- Average time to close issues: N/A
- Average time to close pull requests: about 7 hours
- Issue authors: 0
- Pull request authors: 1
- Average comments per issue: 0
- Average comments per pull request: 0.64
- Merged pull requests: 4
- Bot issues: 0
- Bot pull requests: 11
Top Authors
Issue Authors
Pull Request Authors
- dependabot[bot] (11)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 422 last-month
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 1
- Total maintainers: 1
pypi.org: cz-path
Commitizen plugin that prefixes commit messages with the common path or prefix of staged files.
- Homepage: https://tatsh.github.io/cz-path/
- Documentation: https://cz-path.readthedocs.org
- License: MIT
-
Latest release: 0.0.1
published 6 months ago
Rankings
Maintainers (1)
Dependencies
- actions/checkout v4 composite
- github/codeql-action/analyze v3 composite
- github/codeql-action/init v3 composite
- actions/checkout v4 composite
- actions/setup-python v5 composite
- actions/checkout v4 composite
- actions/setup-python v5 composite
- @prettier/plugin-xml ^3.4.2 development
- cspell ^9.1.3 development
- markdownlint-cli2 ^0.18.1 development
- prettier ^3.6.2 development
- prettier-plugin-ini ^1.3.0 development
- prettier-plugin-sort-json ^4.1.1 development
- prettier-plugin-toml ^2.0.6 development
- pyright ^1.1.402 development
- yarn-audit-fix ^10.1.1 development
- 314 dependencies
- 119 dependencies
- commitizen ^4.8.3 develop
- djlint ^1.36.4 develop
- mypy ^1.16.1 develop
- ruff ^0.12.0 develop
- yapf ^0.43.0 develop
- autodoc-pydantic ^2.2.0 docs
- doc8 ^2.0.0 docs
- docutils ^0.21.2 docs
- enum-tools ^0.13.0 docs
- esbonio ^0.16.5 docs
- numpydoc ^1.8.0 docs
- restructuredtext-lint ^1.4.0 docs
- sphinx [{"python" => ">=3.11", "version" => "^8.2.3"}, {"python" => "<3.11", "version" => "^7.2.5"}] docs
- sphinx-click ^6.0.0 docs
- sphinx-datatables ^0.3.0 docs
- sphinx-hoverxref ^1.4.2 docs
- sphinx-immaterial ^0.13.5 docs
- commitizen ^4.8.3
- gitpython ^3.1.44
- python >=3.10,<3.14
- typing-extensions ^4.14.0
- coveralls ^4.0.1 tests
- mock ^5.2.0 tests
- pytest ^8.4.0 tests
- pytest-cov ^6.2.1 tests
- pytest-mock ^3.14.1 tests