{"id":17055026,"url":"https://github.com/hyiso/commitlint","last_synced_at":"2025-08-09T16:09:26.684Z","repository":{"id":65191665,"uuid":"586936830","full_name":"hyiso/commitlint","owner":"hyiso","description":"commitlint - Lint commit messages for Dart and Flutter projects","archived":false,"fork":false,"pushed_at":"2024-11-13T10:56:59.000Z","size":160,"stargazers_count":16,"open_issues_count":1,"forks_count":3,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-06-15T11:16:11.990Z","etag":null,"topics":["commit","commit-conventions","commit-hooks","commit-message","commitlint","dart","dart-library","dart-package","flutter","flutter-apps","flutter-package","git","lint"],"latest_commit_sha":null,"homepage":"https://hyiso.github.io/commitlint/","language":"Dart","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hyiso.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","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}},"created_at":"2023-01-09T15:26:48.000Z","updated_at":"2025-04-09T10:23:40.000Z","dependencies_parsed_at":"2023-02-12T16:15:47.432Z","dependency_job_id":"eb731058-8fc3-4389-8de7-6544d93c7810","html_url":"https://github.com/hyiso/commitlint","commit_stats":{"total_commits":95,"total_committers":2,"mean_commits":47.5,"dds":0.03157894736842104,"last_synced_commit":"e818b15a32bdbeb0891a7bd2e81fdeb00f0863de"},"previous_names":[],"tags_count":38,"template":false,"template_full_name":null,"purl":"pkg:github/hyiso/commitlint","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hyiso%2Fcommitlint","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hyiso%2Fcommitlint/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hyiso%2Fcommitlint/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hyiso%2Fcommitlint/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hyiso","download_url":"https://codeload.github.com/hyiso/commitlint/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hyiso%2Fcommitlint/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":265454567,"owners_count":23768377,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","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","commit-conventions","commit-hooks","commit-message","commitlint","dart","dart-library","dart-package","flutter","flutter-apps","flutter-package","git","lint"],"created_at":"2024-10-14T10:16:30.413Z","updated_at":"2025-07-16T12:05:42.290Z","avatar_url":"https://github.com/hyiso.png","language":"Dart","readme":"# commitlint\n\n[![Pub Version](https://img.shields.io/pub/v/commitlint_cli?color=blue)](https://pub.dev/packages/commitlint_cli)\n[![popularity](https://img.shields.io/pub/popularity/commitlint_cli?logo=dart)](https://pub.dev/packages/commitlint_cli/score)\n[![likes](https://img.shields.io/pub/likes/commitlint_cli?logo=dart)](https://pub.dev/packages/commitlint_cli/score)\n[![CI](https://github.com/hyiso/commitlint/actions/workflows/ci.yml/badge.svg)](https://github.com/hyiso/commitlint/actions/workflows/ci.yml)\n\n\u003e Dart version commitlint - A tool to lint commit messages. (Inspired by JavaScript [commitlint](https://github.com/conventional-changelog/commitlint))\n\ncommitlint lint commit messages to satisfy [conventional commit format](https://www.conventionalcommits.org/)\n\ncommitlint helps your team adhere to a commit convention. By supporting pub-installed configurations it makes sharing of commit conventions easy.\n\n## About Package Name\n\nBecause a package `commit_lint` already exists (not in active development), the name `commitlint` can't be used according to [Pub's naming policy](https://pub.dev/policy#naming-policy). So `commitlint_cli` is used currently.\n\n\n## Getting started\n\n### Install\n\nAdd `commitlint_cli` to your `dev_dependencies` in pubspec.yaml\n\n```bash\n# Install commitlint_cli\ndart pub add --dev commitlint_cli\n```\n\n### Configuration\n\n```bash\n# Simply use configuration of a package\necho \"include: package:commitlint_cli/commitlint.yaml\" \u003e commitlint.yaml\n```\nYou can also customize your configuration in `commitlint.yaml`\n```yaml\n# Inherit configuration of a package\ninclude: package:commitlint_cli/commitlint.yaml\n\n# Custom rules\nrules:\n  type-case:\n    - 2\n    - always\n    - 'upper-case'\n\n# Whether commitlint uses the default ignore rules.\ndefaultIgnores: true\n# Pattern that matches commit message if commitlint should ignore the given message.\nignores:\n  - r'^fixup'\n```\n\n\n### Test\n\n```bash\n# Lint from stdin\necho 'foo: bar' | dart run commitlint_cli\n⧗  input: type: add docs\n✖  type must be one of [build, chore, ci, docs, feat, fix, perf, refactor, revert, style, test] type-enum\n\n✖  found 1 errors, 0 warnings\n```\n\n**Note: output on successful commit will be omitted, you can use the `VERBOSE=true` env to get positive output.** (Functionality of [verbose](https://pub.dev/packages/verbose))\n\n```bash\n# Output on successful commit will be omitted\necho 'feat: test message' | dart run commitlint_cli\n# Verbse Output on successful commit\necho 'feat: test message' | VERBOSE=true dart run commitlint_cli\n```\n## Setup git hook\n\nWith [husky](https://pub.dev/packages/husky) (a tool for managing git hooks), commitlint cli can be used in `commmit-msg` git hook\n\n### Set `commit-msg` hook:\n\n```sh\ndart pub add --dev husky\ndart run husky install\ndart run husky set .husky/commit-msg 'dart run commitlint_cli --edit \"$1\"'\n```\n\n### Make a commit:\n\n```sh\ngit add .\ngit commit -m \"Keep calm and commit\"\n# `dart run commitlint_cli --edit \"$1\"` will run\n```\n\n\u003e To get the most out of `commitlint` you'll want to automate it in your project lifecycle. See our [Setup guide](https://hyiso.github.io/commitlint/#/guides-setup) for next steps.\n\n## Documentation\n\nSee [documention](https://hyiso.github.io/commitlint)\n\n- **Guides** - Common use cases explained in a step-by-step pace\n- **Concepts** - Overarching topics important to understand the use of `commitlint`\n- **Reference** - Mostly technical documentation\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhyiso%2Fcommitlint","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhyiso%2Fcommitlint","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhyiso%2Fcommitlint/lists"}