<p align="center">
<a href="https://sumi.rs">
<img src="https://raw.githubusercontent.com/welpo/git-sumi/main/website/static/img/logo.png" width="300" alt="git-sumi logo: a lantern held on a bamboo stick over the sea">
</a>
<br><br>
<a href="https://github.com/welpo/git-sumi">
<img src="https://img.shields.io/badge/clean_commits-git--sumi-0?style=flat-square&labelColor=202b2d&color=b05275" alt="Clean commits"></a>
<a href="CONTRIBUTING.md#pull-requests">
<img src="https://img.shields.io/badge/PRs-welcome-0?style=flat-square&labelColor=202b2d&color=b05275" alt="PRs welcome"></a>
<a href="https://github.com/welpo/git-sumi/releases">
<img src="https://img.shields.io/github/v/release/welpo/git-sumi?style=flat-square&labelColor=202b2d&color=b05275" alt="Latest release"></a>
<a href="https://crates.io/crates/git-sumi">
<img src="https://img.shields.io/crates/v/git-sumi?style=flat-square&labelColor=202b2d&color=b05275" alt="Crates.io"></a>
<a href="https://codecov.io/gh/welpo/git-sumi">
<img src="https://img.shields.io/codecov/c/gh/welpo/git-sumi?style=flat-square&labelColor=202b2d&color=b05275" alt="Codecov"></a>
<br>
<a href="https://github.com/welpo/git-sumi/actions/workflows/ci.yml">
<img src="https://img.shields.io/github/actions/workflow/status/welpo/git-sumi/ci.yml?style=flat-square&labelColor=202b2d&color=b05275" alt="CI"></a>
<a href="https://github.com/welpo/git-sumi/actions/workflows/release.yml">
<img src="https://img.shields.io/github/actions/workflow/status/welpo/git-sumi/release.yml?style=flat-square&labelColor=202b2d&color=b05275&label=deploy" alt="Deployment"></a>
<a href="https://sumi.rs/docs">
<img src="https://img.shields.io/website?url=https%3A%2F%2Fsumi.rs&style=flat-square&label=docs&labelColor=202b2d&color=b05275" alt="Documentation"></a>
<a href="#-license">
<img src="https://img.shields.io/badge/license-MIT%20or%20Apache%202.0-0?style=flat-square&labelColor=202b2d&color=b05275" alt="MIT or Apache 2.0 License"></a>
</p>
<h4 align="center">
<a href="https://sumi.rs/docs">Documentation</a> |
<a href="https://sumi.rs">Website</a>
</h4>
<h1 align="center">git-sumi</h1>
<h3 align="center">The non-opinionated Rust-based commit message linter</h4>
Transform your commit practices with flexible linting for consistently high-quality Git commit messages that adhere to your project's standards.
> sumi (墨, /<span title="/s/: 's' in 'sigh'">s</span><span title="/ɯ/: like 'u' in 'flute', but unrounded">ɯ</span><span title="/m/: 'm' in 'my'">m</span><span title="/i/: 'i' in 'fleece'">i</span>/): ink, especially the type used in [traditional ink wash painting](https://en.wikipedia.org/wiki/Ink_wash_painting).
## 🎥 Demo
See how git-**sumi** can help you write better commit messages:
https://github.com/welpo/git-sumi/assets/6399341/cf1b4f00-3f79-454f-a533-5b36812dd464
## ✨ Main features
- **Customizable rules**: Tailor git-**sumi** to each project's specific requirements. Easily configure [rules](https://sumi.rs/docs/rules/) to enforce [Conventional Commits](https://www.conventionalcommits.org/), length limits, gitmoji usage, and more through a [simple TOML file](https://sumi.rs/docs/configuration/).
- **Clear error reporting**: git-**sumi**'s detailed error reporting makes fixing commit messages straightforward and educational.
- **Seamless integration**: git-**sumi** is a [single binary](https://github.com/welpo/git-sumi/releases), making it easy to [integrate into your existing workflow](https://sumi.rs/docs/integration) with minimal setup.
## 📝 Documentation
Learn how to use git-**sumi** from the [documentation](https://sumi.rs/docs).
- [Quick setup](https://sumi.rs/docs/#quickstart)
- [Configuration](https://sumi.rs/docs/configuration)
- [Rules](https://sumi.rs/docs/rules)
- [Examples](https://sumi.rs/docs/examples)
- [Integration](https://sumi.rs/docs/integration)
- [Frequently Asked Questions](https://sumi.rs/docs/faq)
## 👥 Contributing
Please do! Contributions are always welcome. We appreciate improvements to the documentation, development of new rules, code cleanup, resolving issues, requesting or developing new functionality…
Take a look at our [Contributing Guidelines](/CONTRIBUTING.md) for more information on how to get started.
## 📄 License
This project is licensed under the terms of both the [MIT license](/LICENSE-MIT) and the [Apache License (Version 2.0)](/LICENSE-APACHE), at your option.
Raw data
{
"_id": null,
"home_page": "https://sumi.rs",
"name": "git-sumi",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "git, commit, lint, linter, rust, conventional commits",
"author": "\u00d3scar Fern\u00e1ndez <osc@osc.garden>",
"author_email": "\u00d3scar Fern\u00e1ndez <osc@osc.garden>",
"download_url": null,
"platform": null,
"description": "<p align=\"center\">\n <a href=\"https://sumi.rs\">\n <img src=\"https://raw.githubusercontent.com/welpo/git-sumi/main/website/static/img/logo.png\" width=\"300\" alt=\"git-sumi logo: a lantern held on a bamboo stick over the sea\">\n </a>\n <br><br>\n <a href=\"https://github.com/welpo/git-sumi\">\n <img src=\"https://img.shields.io/badge/clean_commits-git--sumi-0?style=flat-square&labelColor=202b2d&color=b05275\" alt=\"Clean commits\"></a>\n <a href=\"CONTRIBUTING.md#pull-requests\">\n <img src=\"https://img.shields.io/badge/PRs-welcome-0?style=flat-square&labelColor=202b2d&color=b05275\" alt=\"PRs welcome\"></a>\n <a href=\"https://github.com/welpo/git-sumi/releases\">\n <img src=\"https://img.shields.io/github/v/release/welpo/git-sumi?style=flat-square&labelColor=202b2d&color=b05275\" alt=\"Latest release\"></a>\n <a href=\"https://crates.io/crates/git-sumi\">\n <img src=\"https://img.shields.io/crates/v/git-sumi?style=flat-square&labelColor=202b2d&color=b05275\" alt=\"Crates.io\"></a>\n <a href=\"https://codecov.io/gh/welpo/git-sumi\">\n <img src=\"https://img.shields.io/codecov/c/gh/welpo/git-sumi?style=flat-square&labelColor=202b2d&color=b05275\" alt=\"Codecov\"></a>\n <br>\n <a href=\"https://github.com/welpo/git-sumi/actions/workflows/ci.yml\">\n <img src=\"https://img.shields.io/github/actions/workflow/status/welpo/git-sumi/ci.yml?style=flat-square&labelColor=202b2d&color=b05275\" alt=\"CI\"></a>\n <a href=\"https://github.com/welpo/git-sumi/actions/workflows/release.yml\">\n <img src=\"https://img.shields.io/github/actions/workflow/status/welpo/git-sumi/release.yml?style=flat-square&labelColor=202b2d&color=b05275&label=deploy\" alt=\"Deployment\"></a>\n <a href=\"https://sumi.rs/docs\">\n <img src=\"https://img.shields.io/website?url=https%3A%2F%2Fsumi.rs&style=flat-square&label=docs&labelColor=202b2d&color=b05275\" alt=\"Documentation\"></a>\n <a href=\"#-license\">\n <img src=\"https://img.shields.io/badge/license-MIT%20or%20Apache%202.0-0?style=flat-square&labelColor=202b2d&color=b05275\" alt=\"MIT or Apache 2.0 License\"></a>\n</p>\n\n<h4 align=\"center\">\n <a href=\"https://sumi.rs/docs\">Documentation</a> |\n <a href=\"https://sumi.rs\">Website</a>\n</h4>\n\n<h1 align=\"center\">git-sumi</h1>\n\n<h3 align=\"center\">The non-opinionated Rust-based commit message linter</h4>\n\nTransform your commit practices with flexible linting for consistently high-quality Git commit messages that adhere to your project's standards.\n\n> sumi (\u58a8, /<span title=\"/s/: 's' in 'sigh'\">s</span><span title=\"/\u026f/: like 'u' in 'flute', but unrounded\">\u026f</span><span title=\"/m/: 'm' in 'my'\">m</span><span title=\"/i/: 'i' in 'fleece'\">i</span>/): ink, especially the type used in [traditional ink wash painting](https://en.wikipedia.org/wiki/Ink_wash_painting).\n\n## \ud83c\udfa5 Demo\n\nSee how git-**sumi** can help you write better commit messages:\n\nhttps://github.com/welpo/git-sumi/assets/6399341/cf1b4f00-3f79-454f-a533-5b36812dd464\n\n## \u2728 Main features\n\n- **Customizable rules**: Tailor git-**sumi** to each project's specific requirements. Easily configure [rules](https://sumi.rs/docs/rules/) to enforce [Conventional Commits](https://www.conventionalcommits.org/), length limits, gitmoji usage, and more through a [simple TOML file](https://sumi.rs/docs/configuration/).\n\n- **Clear error reporting**: git-**sumi**'s detailed error reporting makes fixing commit messages straightforward and educational.\n\n- **Seamless integration**: git-**sumi** is a [single binary](https://github.com/welpo/git-sumi/releases), making it easy to [integrate into your existing workflow](https://sumi.rs/docs/integration) with minimal setup.\n\n## \ud83d\udcdd Documentation\n\nLearn how to use git-**sumi** from the [documentation](https://sumi.rs/docs).\n\n- [Quick setup](https://sumi.rs/docs/#quickstart)\n- [Configuration](https://sumi.rs/docs/configuration)\n- [Rules](https://sumi.rs/docs/rules)\n- [Examples](https://sumi.rs/docs/examples)\n- [Integration](https://sumi.rs/docs/integration)\n- [Frequently Asked Questions](https://sumi.rs/docs/faq)\n\n## \ud83d\udc65 Contributing\n\nPlease do! Contributions are always welcome. We appreciate improvements to the documentation, development of new rules, code cleanup, resolving issues, requesting or developing new functionality\u2026\n\nTake a look at our [Contributing Guidelines](/CONTRIBUTING.md) for more information on how to get started.\n\n## \ud83d\udcc4 License\n\nThis project is licensed under the terms of both the [MIT license](/LICENSE-MIT) and the [Apache License (Version 2.0)](/LICENSE-APACHE), at your option.\n\n",
"bugtrack_url": null,
"license": "MIT OR Apache-2.0",
"summary": "The non-opinionated Rust-powered commit message linter",
"version": "0.0.9",
"project_urls": {
"Changelog": "https://github.com/welpo/git-sumi/blob/main/CHANGELOG.md",
"Documentation": "https://sumi.rs/docs/",
"Homepage": "https://sumi.rs",
"Repository": "https://github.com/welpo/git-sumi"
},
"split_keywords": [
"git",
" commit",
" lint",
" linter",
" rust",
" conventional commits"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "52d1912e87107ddc972a379b61ef6d4a5d47fe28992735f4be1e7e9d9678008e",
"md5": "c4fe05a52778ee11a51a4bb83a00ad6a",
"sha256": "38a8cd255b927f73fe5d31050f1a41569b6bfb6b72d00aa8959024f985f477c2"
},
"downloads": -1,
"filename": "git_sumi-0.0.9-py3-none-macosx_10_12_x86_64.whl",
"has_sig": false,
"md5_digest": "c4fe05a52778ee11a51a4bb83a00ad6a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 1009508,
"upload_time": "2024-05-06T22:47:24",
"upload_time_iso_8601": "2024-05-06T22:47:24.654289Z",
"url": "https://files.pythonhosted.org/packages/52/d1/912e87107ddc972a379b61ef6d4a5d47fe28992735f4be1e7e9d9678008e/git_sumi-0.0.9-py3-none-macosx_10_12_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "725a811cec74ad69599c126b93df926826986d59bcbfa2407a12f1949448ae98",
"md5": "f8e1c4fb9d432156618a7f91e1b7378e",
"sha256": "c365f273b081530baedd0f4182cae0747af520cea7753dadc5261ffc97b2bd29"
},
"downloads": -1,
"filename": "git_sumi-0.0.9-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"has_sig": false,
"md5_digest": "f8e1c4fb9d432156618a7f91e1b7378e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 1070112,
"upload_time": "2024-05-06T22:47:27",
"upload_time_iso_8601": "2024-05-06T22:47:27.255470Z",
"url": "https://files.pythonhosted.org/packages/72/5a/811cec74ad69599c126b93df926826986d59bcbfa2407a12f1949448ae98/git_sumi-0.0.9-py3-none-manylinux_2_17_x86_64.manylinux2014_x86_64.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "d5cf378198a2eb43d5cdc799c7d422045a5ea5d14645e6cf3f30bfd770f4e7d1",
"md5": "c413b7f56d799a07fb529d09748ab62d",
"sha256": "dba3c8dd77aaa636cb489f7de2001a9eaa94cdf48f60112c4f65be37b47a1acc"
},
"downloads": -1,
"filename": "git_sumi-0.0.9-py3-none-win_amd64.whl",
"has_sig": false,
"md5_digest": "c413b7f56d799a07fb529d09748ab62d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 976025,
"upload_time": "2024-05-06T22:47:29",
"upload_time_iso_8601": "2024-05-06T22:47:29.189689Z",
"url": "https://files.pythonhosted.org/packages/d5/cf/378198a2eb43d5cdc799c7d422045a5ea5d14645e6cf3f30bfd770f4e7d1/git_sumi-0.0.9-py3-none-win_amd64.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-05-06 22:47:24",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "welpo",
"github_project": "git-sumi",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "git-sumi"
}
JSON
