synchot/conventionalcommit

Conventional commit for php

v5.0.5 2020-01-24 14:54 UTC

Requires

• php: >=7.1

Requires (Dev)

• codeception/codeception: 4.0.x-dev
• codeception/module-asserts: dev-master
• composer/composer: ^1.10@dev
• myclabs/php-enum: ^1.7
• symfony/console: ^2.0.5|^3.0|^4.0|^5.0
• symfony/filesystem: ^4.4.2
• symfony/yaml: ^4.3
• synchot/changeloggen: ^4.0
• webmozart/assert: dev-master

MIT

• Marcin Jędra

• hooks
• commit
• githooks
• conventionalcommit

README

This package will use .git/hooks/commit-msg to check if git commit -m "Your message" is conventional commit compliant.

Instalation

Add to composer.json

"scripts": {
    "post-install-cmd": [
      "SyncHot\\ConventionalCommit\\Services\\ComposerBuild::copyHooks"
    ],
    "post-update-cmd": [
      "SyncHot\\ConventionalCommit\\Services\\ComposerBuild::copyHooks"
    ]
  }

run

composer require --dev synchot/conventionalcommit

How to run

On windows machines please select git-bash as default console.

git commit -m "Some message"

Something went wrong

In Your project do :

cat .git/hooks/commit-msg

If it has the same value as in vendor/synchot/conventionalcommit/resources/commit-msg Tou should be good to go, else try to copy this value.

User defined config

Create /config/packages/conventionalcommit.yaml

with contents of

/vendor/synchot/conventionalcommit/config/conventionalcommit.yaml

Modify all values to suit Your projects needs.

REMOVING THIS PLUGIN

cd <your project dir>
cd .git/hooks
rm commit-msg

CHANGELOG

https://bitbucket.org/SyncHot/conventionalcommit/src/master/CHANGELOG.md

Todos

• Refactor
• Write Tests

License

MIT Jędra Marcin