Hi! I found this package extra useful for my workflow at my job. I just wanted to share my experience implementing it and a couple of thoughts.

I felt the "post-install-cmd": "cghooks add --ignore-lock", suggestion very misleading, if I understood correctly, it would add the cghooks.lock file to my gitignore (in my case breaking my gitignore, as the last line was not empty), and my coworker would get the gitignore modified too (as the package would not find a cghooks.lock file.

On the other hand, I had issues when doing a composer install --no-dev deploy.

My first attemp was checking the COMPOSER_DEV_MODE env variable, but it did not work in my Docker environment. I solved it with a command -v call. Also, I had to specify the git-dir because the package was not finding it on my Docker container (and I don't have any clue about why).

My last problem appeared when doing composer install after a composer install --no-dev. I had to solve this by uninstalling the hooks before every installation.

This is an excerpt of my final composer.json file. I think that the readme could be improved, and the workflow rethinked to be easier!

{
	"require-dev": {
		"overtrue/phplint": "^1.1",
		"brainmaestro/composer-git-hooks": "^2.8"
	},
	"scripts": {
		"pre-install-cmd": "command -v vendor/bin/cghooks >/dev/null 2>&1 || exit 0; vendor/bin/cghooks remove --git-dir=.git",
		"post-install-cmd": "command -v vendor/bin/cghooks >/dev/null 2>&1 || exit 0; vendor/bin/cghooks add --git-dir=.git",
		"post-update-cmd": "command -v vendor/bin/cghooks >/dev/null 2>&1 || exit 0; vendor/bin/cghooks update --git-dir=.git",
		"phplint": "./vendor/bin/phplint",
		"test": [
			"@composer run phplint"
		]
	},
	"scripts-descriptions": {
		"test": "Run all tests"
	},
	"extra": {
		"hooks": {
			"pre-commit": [
				"composer run test"
			],
			"post-merge": "composer install"
		}
	}
}

Hi, This prevent adding test command for non valid hooks. For now every scripts of the file and the config section are listed in the possible commands. Thanks

Closes #123

Changed:

• Updated to Symfony\Console ^6.0
• Updated to PHP-CS-Fixer ^3.0
• Updated to PHPUnit ^9.5
  • Rename assertContains to assertStringContainsString
  • Rename assertNotContains to assertStringNotContainsString
  • Rename `assertFileNotExists' to 'assertFileDoesNotExist'
• Updated to PHP ^8.0
• Updated GitHub Actions workflows
• Make constants public (Hook.php)
• Cast shell_exec output to string (src/helpers.php) because trim required a string and not string|ƒalse|null

Added

• Added file_exists check before create a directory

EDIT: For these wanting to try out these changes you can do the following to your composer.json:

{
    "repositories": [
        {
            "type": "git",
            "url": "https://github.com/Jubeki/composer-git-hooks"
        }
    ],
    "require-dev": {
        "brainmaestro/composer-git-hooks": "dev-prepare-for-symfony-6"
    },
    "minimum-stability": "dev",
    "prefer-stable": true
}

This is probably a dumb question or something simple I am overlooking but for some reason no matter what I do I cannot seem to get my git commit -m"message here" to actually commit upon completion of the pre-commit hook. I have seen elsewhere online where if the hook returns 0 then the commit should complete as expected. I have even added multiple variations of exit 0 as the last script within the pre-commit array but with no luck.

• I have tried composer dump-autoload, composer cghooks update, etc.
• I have also installed cghooks both locally within the project and globally within composer.

The pre-commit hooks is running as expected but fails to actually add the new commit upon completion.

Not sure if this helps but I am working on a Laravel 5.8 project using and using the virtual box vm 'laravel/homestead' version '7.1.0'.

I have spent more time than I'd like to admit trying to get this to work so any help would be greatly appreciated. I hope this is the right channel to post this. Thanks!

When running git commit and then git status:

vagrant@homestead:~/code/notiifii$ git commit -m"test" committing as [email protected] Loaded config default from ".php_cs".

Fixed all files in 13.107 seconds, 12.000 MB memory used

vagrant@homestead:~/code/notiifii$ git status On branch master Your branch is up to date with 'origin/master'.

Changes to be committed: (use "git reset HEAD ..." to unstage)

modified:   .gitignore
new file:   .php_cs
modified:   app/Console/Kernel.php
modified:   composer.json
modified:   composer.lock
modified:   routes/web.php

Here is the hooks section of my composer.json file. These are found under the extra section.

"hooks": { "pre-commit": [ "echo committing as $(git config user.email)", "php-cs-fixer fix --config=.php_cs", "git add ." ], "pre-push": [ "php-cs-fixer fix --dry-run --config=.php_cs", "phpunit" ], "post-merge": "composer install" },

I have added, ability to find git directory, this code will try to find out .git directory from the root of the project as well as the parent directory of the project.

Most of have git initialize in their parent directory and composer in root directory so package will create git inside the folder where composer is placed.

This PR issue is mentioned here https://github.com/BrainMaestro/composer-git-hooks/issues/54

Would be awesome if you could support PHP 7.3 Right now the requirements are set to < 7.3 thus its not installable without the --ignore-platform-reqs arg.

brainmaestro/composer-git-hooks v2.6.0 requires php ^5.6 || >=7.0 <7.3 -> your PHP version (7.3.0) does not satisfy that requirement.

Hi, I have the following script that checks that a commit message is formatted properly:

{
  "prepare-commit-msg": [
      "CUR_BRANCH=\"$(git branch | grep '*' | sed 's/* //')\"",
      "if [ \"$CUR_BRANCH\" = '(no branch)' ]; then",
      "  exit 0",
      "fi",
      "COMMIT_REGEX='^(fixup! )*?(build|chore|ci|docs|feat|fix|perf|refactor|revert|style|test)(\\([a-z ]+\\))?: .+$'",
      "if ! grep -qE \"$COMMIT_REGEX\" \"$1\"; then",
      "  echo 'Invalid commit message, aborting... See https://github.com/pvdlg/conventional-changelog-metahub#commit-types' >&2",
      "  exit 1",
      "fi"
  ]
}

Since #106, multiline commands entries are now joined with && \. That brokes the bash script. As json doesn't allow multline strings, I don't see other way to write the script. I find convenient to write these little scripts in composer.json directly and not in separate script files.

Any thoughts? Thanks

Commit failed - exit code 1 received, with output: '.git/hooks/pre-commit: line 2: $'\r': command not found
committing as 
/usr/bin/env: php: No such file or directory'

When trying to commit via GitHub Desktop on Windows 10..

This is what my composer.json looks like...

"extra": {
    "laravel": {
        "dont-discover": []
    },
    "hooks": {
        "pre-commit": [
            "echo committing as $(git config user.name)",
            "vendor/bin/php-cs-fixer fix --using-cache=no ."
        ],
        "commit-msg": "grep -q '[A-Z]+-[0-9]+.*' $1",
        "pre-push": [
            "vendor/bin/php-cs-fixer fix --dry-run --using-cache=no .",
            "phpunit"
        ],
        "post-merge": "composer update"
    }
},

// ... some lines down

"scripts": {
    "post-install-cmd": "cghooks add --ignore-lock",
    "post-update-cmd": "cghooks update",
} 

[Question] How about to add option for lock file path?

Some projects has to have a lot of utility files like lock files and usually all of them are located in the project root. So why not to put cghooks.lock to some other place via cghooks binary option with project root by default?

My hooks are installed in a --absolute-git-dir directory ;)

ls -al
total 2055
drwxrwxrwx 1 root root  12288 Jun 19 15:21 .
drwxrwxrwx 1 root root   4096 Jun 19 11:50 ..
drwxrwxrwx 1 root root      0 Jun 19 15:21 --absolute-git-dir
drwxrwxrwx 1 root root      0 Jan 16 17:33 app
[...]

git --version
git version 2.11.0

git rev-parse --absolute-git-dir
--absolute-git-dir

It seems --absolute-git-dir was introduced in 2.13

Originally posted by @Broutard in https://github.com/BrainMaestro/composer-git-hooks/pull/79#issuecomment-503562745

Hi there! First of all: great tool! I love to keep the setup of repositories simple and having the ability to set up git hooks via composer is just great!

I recently ran into this problem and can't seem to figure it out on my own. I did the following and got this error:

$ vendor/bin/cghooks update
: not foundcghooks: 2: vendor/bin/cghooks:
: not foundcghooks: 4: vendor/bin/cghooks:
vendor/bin/cghooks: 6: vendor/bin/cghooks: Syntax error: word unexpected (expecting "in")

Any ideas? I don't really know what information can be useful so you'll have to tell me. Thanks!

Your requirements could not be resolved to an installable set of packages.

Problem 1 - brainmaestro/composer-git-hooks[v2.8.0, ..., v2.8.2] require symfony/console ^3.2 || ^4.0 -> found symfony/console[v3.2.0-BETA1, ..., 3.4.x-dev, v4.0.0-BETA1, ..., 4.4.x-dev] but the package is fixed to v6.1.5 (lock file version) by a partial update and that version does not match. Make sure you list it as an argument for the update command. - brainmaestro/composer-git-hooks[v2.8.3, ..., v2.8.5] require symfony/console ^3.2 || ^4.0 || ^5.0 -> found symfony/console[v3.2.0-BETA1, ..., 3.4.x-dev, v4.0.0-BETA1, ..., 4.4.x-dev, v5.0.0-BETA1, ..., 5.4.x-dev] but the package is fixed to v6.1.5 (lock file version) by a partial update and that version does not match. Make sure you list it as an argument for the update command. - Root composer.json requires brainmaestro/composer-git-hooks ^2.8 -> satisfiable by brainmaestro/composer-git-hooks[v2.8.0, ..., v2.8.5].

Use the option --with-all-dependencies (-W) to allow upgrades, downgrades and removals for packages currently locked to specific versions. You can also try re-running composer require with an explicit version constraint, e.g. "composer require brainmaestro/composer-git-hooks:*" to figure out if any version is installable, or "composer require brainmaestro/composer-git-hooks:^2.1" if you know which you need.

Installation failed, reverting ./composer.json and ./composer.lock to their original content.

How can I solve this problem in laravel 9 and php 8?

Would it be possible to publish a stable tag for 3.0.0? Unfortunately this package is still broken with Symfony 6 if the projects minimum-stability is stable.

When the hook is a sequence of commands, execution is not stopped when the command fails.

When the first command fails, it proceeds to the next command, and if the next command did not fail, completes the commit.

Hi there,

I changed a pre-commit hook to run on pre-push, ran cghooks update, but now the hook always runs on pre-commit.. All traces of pre-commit have been removed (composer.json, cghooks.lock) yet it still runs, even when opening new terminals.

I'm out of options at this point except composer removing the dependency