PHPackages                             codelegance/grumphp - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Testing & Quality](/categories/testing)
4. /
5. codelegance/grumphp

AbandonedComposer-plugin[Testing & Quality](/categories/testing)

codelegance/grumphp
===================

A composer plugin that enables source code quality checks.

1.1.0(9y ago)06.5k1MITPHPPHP >=5.6.0

Since Mar 18Pushed 9y ago1 watchersCompare

[ Source](https://github.com/Codelegance/grumphp)[ Packagist](https://packagist.org/packages/codelegance/grumphp)[ RSS](/packages/codelegance-grumphp/feed)WikiDiscussions master Synced 2d ago

READMEChangelogDependencies (26)Versions (42)Used By (0)

[![Travic](https://camo.githubusercontent.com/afd4e3d595bbb32dd1e879e26e6220ae6f1a6ea67c4c32507bd78060c69fcf6f/68747470733a2f2f696d672e736869656c64732e696f2f7472617669732f706870726f2f6772756d7068702f6d61737465722e737667)](http://travis-ci.org/phpro/grumphp)[![Insight](https://camo.githubusercontent.com/af225b798c744805967e10dfb7d626ab6c0a461da431f13dcdcd6858bdc90de2/68747470733a2f2f696d672e736869656c64732e696f2f73656e73696f6c6162732f692f39613334353032312d633861312d346634382d393438612d6431356465353164393930392e737667)](https://insight.sensiolabs.com/projects/9a345021-c8a1-4f48-948a-d15de51d9909)[![AppVeyor](https://camo.githubusercontent.com/72841147b570431a0721c901a2f679f7b122565b8f504fdf7b34711139114016/68747470733a2f2f63692e6170707665796f722e636f6d2f6170692f70726f6a656374732f7374617475732f74746c62617532736a673336657030312f6272616e63682f6d61737465723f7376673d74727565)](https://ci.appveyor.com/project/veewee/grumphp/branch/master)[![Installs](https://camo.githubusercontent.com/fcfc8c6560b6b537c2e704f495b8a12432846fdd1ad21aaa9a86f44c793032ed/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f706870726f2f6772756d7068702e737667)](https://packagist.org/packages/phpro/grumphp/stats)[![Packagist](https://camo.githubusercontent.com/bda5683ca58abbcda0eb1f2004ebb1f7777b02b94acbe700b3e4bca66b759ed6/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f706870726f2f6772756d7068702e737667)](https://packagist.org/packages/phpro/grumphp)[![Twitter](https://camo.githubusercontent.com/3ad7806e46497f7175017013c2054020c1ff23c522ee6914121b70f79fdfb465/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f547769747465722d2534306772756d7068702d626c75652e737667)](https://twitter.com/intent/user?screen_name=grumphp)[![Freenode](https://camo.githubusercontent.com/6b10c90d88ffa6776306424b6b7d822c31905c771ea6e26fa14ec14a81f6f788/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f467265656e6f64652d2532336772756d7068702d626c75652e737667)](http://webchat.freenode.net?channels=%23grumphp&uio=d4)

GrumPHP
=======

[](#grumphp)

[![](https://raw.githubusercontent.com/phpro/grumphp/master/resources/logo/grumphp-grumpy.png)](https://raw.githubusercontent.com/phpro/grumphp/master/resources/logo/grumphp-grumpy.png)

Sick and tired of defending code quality over and over again? GrumPHP will do it for you! This composer plugin will register some git hooks in your package repository. When somebody commits changes, GrumPHP will run some tests on the committed code. If the tests fail, you won't be able to commit your changes. This handy tool will not only improve your codebase, it will also teach your co-workers to write better code following the best practices you've determined as a team.

GrumPHP has a set of common tasks built-in. You will be able to use GrumPHP with a minimum of configuration.

We don't want to bore you with all the details, so quick: install it yourself and unleash the power of GrumPHP!

Demo
----

[](#demo)

[![demo](https://github.com/phpro/grumphp/wiki/images/demo.gif)](https://github.com/phpro/grumphp/wiki/images/demo.gif)

Installation
------------

[](#installation)

*If you are trying to install GrumPHP on Windows: please read the windows pre-install section.*

This package is a composer plugin and should be installed to your project's dev dependency using composer:

```
composer require --dev phpro/grumphp
```

When the package is installed, GrumPHP will attach itself to the git hooks of your project. You will see following message in the composer logs:

*Watch out! GrumPHP is sniffing your commits!*

To make GrumPHP even more awesome, it will suggest installing some extra packages:

- atoum/atoum : ~2.7
- behat/behat : ~3.0
- codegyre/robo : ~0.7
- doctrine/orm: ~2.5
- friendsofphp/php-cs-fixer : ~1|~2
- malukenho/kawaii-gherkin : ~0.1
- phing/phing : ~2.0
- sstalle/php7cc : ~1.1
- phpspec/phpspec : ~2.1
- phpunit/phpunit : ~4.5
- roave/security-advisories : dev-master@dev
- sebastian/phpcpd : ~2.0
- squizlabs/php\_codesniffer : ~2.3
- codeception/codeception : ~2.1
- sensiolabs/security-checker : ~3.0
- phpmd/phpmd : ~2.4
- nikic/php-parser: ~2.1
- kahlan/kahlan: ~3

GrumPHP will never push you into using a specific task. You can choose the tasks that fit your needs, and activate or deactivate any task in no time!

Having trouble installing GrumPHP? Find out how to:

- [Install globally](doc/installation/global.md)
- [Install with an exotic project structure](doc/installation/exotic.md)
- [Install on Windows](doc/installation/windows.md)

Configuration
-------------

[](#configuration)

Some things in GrumPHP can be configured in a `grumphp.yml` or `grumphp.yml.dist` file in the root of your project (the directory where you run the grumphp command). You can specify a custom config filename and location in `composer.json` or in the `--config` option of the console commands.

```
# grumphp.yml
parameters:
    bin_dir: "./vendor/bin"
    git_dir: "."
    hooks_dir: ~
    hooks_preset: local
    stop_on_failure: false
    ignore_unstaged_changes: false
    process_async_limit: 10
    process_async_wait: 1000
    process_timeout: 60
    ascii:
        failed: grumphp-grumpy.txt
        succeeded: grumphp-happy.txt
    tasks:
        ant: ~
        atoum: ~
        behat: ~
        brunch: ~
        clover_coverage: ~
        codeception: ~
        composer: ~
        composer_script: ~
        doctrine_orm: ~
        gherkin: ~
        git_blacklist: ~
        git_commit_message: ~
        git_conflict: ~
        grunt: ~
        gulp: ~
        jsonlint: ~
        kahlan: ~
        npm_script: ~
        phing: ~
        php7cc: ~
        phpcpd: ~
        phpcs: ~
        phpcsfixer: ~
        phpcsfixer2: ~
        phplint: ~
        phpmd: ~
        phpparser: ~
        phpspec: ~
        phpunit: ~
        phpversion: ~
        robo: ~
        securitychecker: ~
        shell: ~
        xmllint: ~
        yamllint: ~
    testsuites: []
    extensions: []
```

You can find a detailed overview of the configurable options in these sections:

- [Parameters](doc/parameters.md)
- [Tasks](doc/tasks.md)
- [Events](doc/events.md)
- [TestSuites](doc/testsuites.md)
- [Extensions](doc/extensions.md)

Commands
--------

[](#commands)

Since GrumPHP is just a CLI tool, these commands can be triggered:

- [configure](doc/commands.md#installation)
- [git:init](doc/commands.md#installation)
- [git:deinit](doc/commands.md#installation)
- [git:pre-commit](doc/commands.md#git-hooks)
- [git:commit-msg](doc/commands.md#git-hooks)
- [run](doc/commands.md#run)

Compatibility
-------------

[](#compatibility)

GrumPHP works with PHP 5.4 or above, and is also tested to work with HHVM.

This package has been tested with following git clients:

- CLI Unix
- CLI Mac
- CLI Windows
- PhpStorm Git
- Atlassian SourceTree
- Syntevo SmartGit

Roadmap
-------

[](#roadmap)

Lots of tasks are already available to make sure your team writes great code. There are still 1 major parts that are missing before we can release a v1.0.0:

- [A PHAR executable](https://github.com/phpro//grumphp/issues/61)

We are always looking to support new tasks. Feel free to log an issue or create a pull request for a task we forgot.

Are you missing a feature or did you find a bug? Log it in the [issue tracker](https://github.com/phpro/grumphp/issues)! Want to help out? Feel free to contact us!

Build your own conventions checker
----------------------------------

[](#build-your-own-conventions-checker)

You can see an [example](https://github.com/linkorb/conventions-checker)of how to build your own conventions checker.

Solving issues
--------------

[](#solving-issues)

- [GrumPHP does not work with submodules](doc/issues/grumphp-is-not-working-with-submodules.md)

About
-----

[](#about)

### Submitting bugs and feature requests

[](#submitting-bugs-and-feature-requests)

Bugs and feature request are tracked on [GitHub](https://github.com/phpro/grumphp/issues). Please take a look at our rules before [contributing your code](CONTRIBUTING.md).

### License

[](#license)

GrumPHP is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.

###  Health Score

35

—

LowBetter than 77% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity19

Limited adoption so far

Community21

Small or concentrated contributor base

Maturity70

Established project with proven stability

 Bus Factor1

Top contributor holds 70.9% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~17 days

Recently: every ~3 days

Total

41

Last Release

3412d ago

Major Versions

v0.11.1 → 1.0.02017-02-14

0.11.2 → 1.0.12017-02-14

PHP version history (3 changes)v0.1.0PHP >=5.3

v0.2.0PHP >=5.3.6

v0.10.0PHP >=5.6.0

### Community

Maintainers

![](https://avatars.githubusercontent.com/u/470626?v=4)[Bilge](/maintainers/Bilge)[@Bilge](https://github.com/Bilge)

---

Top Contributors

[![veewee](https://avatars.githubusercontent.com/u/1618158?v=4)](https://github.com/veewee "veewee (482 commits)")[![Bilge](https://avatars.githubusercontent.com/u/470626?v=4)](https://github.com/Bilge "Bilge (31 commits)")[![Kanti](https://avatars.githubusercontent.com/u/471387?v=4)](https://github.com/Kanti "Kanti (27 commits)")[![aaa2000](https://avatars.githubusercontent.com/u/163941?v=4)](https://github.com/aaa2000 "aaa2000 (20 commits)")[![aderuwe](https://avatars.githubusercontent.com/u/1125184?v=4)](https://github.com/aderuwe "aderuwe (19 commits)")[![igormukhingmailcom](https://avatars.githubusercontent.com/u/6544038?v=4)](https://github.com/igormukhingmailcom "igormukhingmailcom (14 commits)")[![jyggen](https://avatars.githubusercontent.com/u/264300?v=4)](https://github.com/jyggen "jyggen (10 commits)")[![mgeoffray](https://avatars.githubusercontent.com/u/1154299?v=4)](https://github.com/mgeoffray "mgeoffray (9 commits)")[![bertptrs](https://avatars.githubusercontent.com/u/861864?v=4)](https://github.com/bertptrs "bertptrs (8 commits)")[![Devolicious](https://avatars.githubusercontent.com/u/360302?v=4)](https://github.com/Devolicious "Devolicious (6 commits)")[![lykciv](https://avatars.githubusercontent.com/u/3390098?v=4)](https://github.com/lykciv "lykciv (5 commits)")[![klipach](https://avatars.githubusercontent.com/u/1453641?v=4)](https://github.com/klipach "klipach (5 commits)")[![llaville](https://avatars.githubusercontent.com/u/364342?v=4)](https://github.com/llaville "llaville (5 commits)")[![pwassermann](https://avatars.githubusercontent.com/u/166525143?v=4)](https://github.com/pwassermann "pwassermann (4 commits)")[![adam-paterson](https://avatars.githubusercontent.com/u/1008727?v=4)](https://github.com/adam-paterson "adam-paterson (4 commits)")[![ceesvanegmond](https://avatars.githubusercontent.com/u/883497?v=4)](https://github.com/ceesvanegmond "ceesvanegmond (3 commits)")[![Big-Shark](https://avatars.githubusercontent.com/u/646054?v=4)](https://github.com/Big-Shark "Big-Shark (3 commits)")[![jhuet](https://avatars.githubusercontent.com/u/372409?v=4)](https://github.com/jhuet "jhuet (3 commits)")[![xtcat](https://avatars.githubusercontent.com/u/1425622?v=4)](https://github.com/xtcat "xtcat (2 commits)")[![j3rrey](https://avatars.githubusercontent.com/u/5716777?v=4)](https://github.com/j3rrey "j3rrey (2 commits)")

###  Code Quality

TestsPHPUnit

Code StylePHP CS Fixer

### Embed Badge

![Health badge](/badges/codelegance-grumphp/health.svg)

```
[![Health](https://phpackages.com/badges/codelegance-grumphp/health.svg)](https://phpackages.com/packages/codelegance-grumphp)
```

###  Alternatives

[phpro/grumphp

A composer plugin that enables source code quality checks.

4.3k16.7M1.0k](/packages/phpro-grumphp)[shopware/core

Shopware platform is the core for all Shopware ecommerce products.

585.6M560](/packages/shopware-core)[shopware/platform

The Shopware e-commerce core

3.4k1.5M3](/packages/shopware-platform)[oro/platform

Business Application Platform (BAP)

645143.5k114](/packages/oro-platform)[sylius/sylius

E-Commerce platform for PHP, based on Symfony framework.

8.5k5.9M728](/packages/sylius-sylius)[open-dxp/opendxp

Content & Product Management Framework (CMS/PIM)

9421.6k60](/packages/open-dxp-opendxp)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)