{"id":22006231,"url":"https://github.com/shubhexists/conventional_commits","last_synced_at":"2026-03-03T22:01:55.390Z","repository":{"id":265498153,"uuid":"862016799","full_name":"shubhexists/conventional_commits","owner":"shubhexists","description":"A light-weight, conventional commit parser written in Rust","archived":false,"fork":false,"pushed_at":"2025-03-31T04:27:22.000Z","size":11,"stargazers_count":9,"open_issues_count":4,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-12-06T08:56:42.011Z","etag":null,"topics":["commit-msg","commitlint","conventional-commits","git"],"latest_commit_sha":null,"homepage":"","language":"Rust","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/shubhexists.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2024-09-23T22:17:40.000Z","updated_at":"2025-08-14T21:31:10.000Z","dependencies_parsed_at":"2024-11-29T16:48:59.440Z","dependency_job_id":"b1ebf212-9401-4731-8d05-06629cd109df","html_url":"https://github.com/shubhexists/conventional_commits","commit_stats":null,"previous_names":["shubhexists/conventional_commits"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/shubhexists/conventional_commits","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shubhexists%2Fconventional_commits","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shubhexists%2Fconventional_commits/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shubhexists%2Fconventional_commits/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shubhexists%2Fconventional_commits/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/shubhexists","download_url":"https://codeload.github.com/shubhexists/conventional_commits/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/shubhexists%2Fconventional_commits/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30063359,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-03T18:21:05.932Z","status":"ssl_error","status_checked_at":"2026-03-03T18:20:59.341Z","response_time":61,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["commit-msg","commitlint","conventional-commits","git"],"created_at":"2024-11-30T01:10:56.393Z","updated_at":"2026-03-03T22:01:55.369Z","avatar_url":"https://github.com/shubhexists.png","language":"Rust","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Conventional Commits Parser\n\nA robust Rust library for parsing [Conventional Commits](https://www.conventionalcommits.org/), adding human and machine-readable meaning to commit messages.\n\n## Table of Contents\n\n- [Features](#features)\n- [Installation](#installation)\n- [Usage](#usage)\n- [Valid Commit Structure](#valid-commit-structure)\n- [Invalid Commits](#invalid-commits)\n- [API Reference](#api-reference)\n- [Contributing](#contributing)\n- [License](#license)\n\n## Features\n\n- Parse Conventional Commits into structured data\n- Tokenize commit messages for detailed analysis\n- Identify commit type, scope, description, body, and footer\n- Detect breaking changes\n- Robust error handling for invalid commits\n\n## Installation\n\nAdd this to your `Cargo.toml`:\n\n```toml\n[dependencies]\nconventional-commit = \"0.1.0\"\n```\n\n## Usage\n\nHere's a quick example of how to use the Conventional Commits Parser:\n\n```rust\nuse conventional_commit::{parse_commit, Lexer};\n\nfn main() -\u003e Result\u003c(), String\u003e {\n    let input = \"feat(parser): add ability to parse conventional commits\".to_string();\n    let mut lexer = Lexer::new(input);\n    let tokens = lexer.lex()?;\n    let commit = parse_commit(tokens)?;\n    println!(\"{:?}\", commit);\n    Ok(())\n}\n```\n\n## Valid Commit Structure\n\nA valid Conventional Commit has the following structure:\n\n```\n\u003ctype\u003e[optional scope]: \u003cdescription\u003e\n\n[optional body]\n\n[optional footer(s)]\n```\n\n### Components:\n\n1. **Type**: Describes the kind of change (e.g., feat, fix, docs, style, refactor, test, chore).\n\n   - Must be lowercase.\n   - Examples: `feat`, `fix`, `docs`\n\n2. **Scope** (optional): Describes what area of the project is changing.\n\n   - Enclosed in parentheses.\n   - Can use kebab-case, lowercase, or uppercase.\n   - Examples: `(parser)`, `(ui)`, `(docs)`\n\n3. **Breaking Change Indicator** (optional): An exclamation mark (`!`) before the colon.\n\n   - Indicates a breaking change.\n   - Example: `feat!:` or `feat(scope)!:`\n\n4. **Description**: A brief explanation of the change.\n\n   - Separated from the type (and scope) by a colon and space.\n   - Written in the imperative mood.\n   - Example: `add ability to parse conventional commits`\n\n5. **Body** (optional): Provides additional contextual information about the change.\n\n   - Must be separated from the description by a blank line.\n   - Can be multiple paragraphs.\n\n6. **Footer** (optional): Used for referencing issues, noting breaking changes, etc.\n   - Must start with a word token followed by `:\u003cspace\u003e` or `\u003cspace\u003e#`.\n   - Common footers: `BREAKING CHANGE:`, `Refs:`, `Reviewed-by:`\n\n### Examples of Valid Commits:\n\n```\nfeat(parser): add ability to parse conventional commits\n\nThis commit introduces a new parser for Conventional Commits.\nThe parser can identify commit types, scopes, and descriptions.\n\nRefs: #123\n```\n\n```\nfix!: correct critical bug in authentication flow\n\nBREAKING CHANGE: This changes the API for user authentication.\nOld auth tokens will no longer be valid.\n```\n\n```\ndocs: update README with new API examples\n\nUpdated the README to include examples of how to use\nthe new parsing functions introduced in v2.0.0.\n```\n\n## Invalid Commits\n\nThe following are examples of invalid commits and why they're incorrect:\n\n1. Missing type:\n\n   ```\n   add new feature\n   ```\n\n   Error: Commit type is missing.\n\n2. Unclosed scope:\n\n   ```\n   feat(parser: add new parsing logic\n   ```\n\n   Error: Scope is not properly closed with a parenthesis.\n\n3. Missing description:\n\n   ```\n   feat(ui):\n   ```\n\n   Error: Description is missing.\n\n\n## API Reference\n\nFor detailed API documentation, please refer to the rustdoc comments in the source code.\n\n## Contributing\n\nContributions are welcome! Please feel free to submit a Pull Request.\n\n## License\n\nThis project is licensed under the MIT License - see the LICENSE file for details.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshubhexists%2Fconventional_commits","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fshubhexists%2Fconventional_commits","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fshubhexists%2Fconventional_commits/lists"}