Download the PHP package phpro/grumphp without Composer
On this page you can find all versions of the php package phpro/grumphp. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download phpro/grumphp
More information about phpro/grumphp
Files in phpro/grumphp
Package grumphp
Short Description A composer plugin that enables source code quality checks.
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package grumphp
GrumPHP
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
Installation
In order for this package to work, you have to make sure following tools are discoverable on the command-line:
- php
- composer
- git
This package is a composer plugin and should be installed to your project's dev dependency using composer:
Install GrumPHP as a phar without dependencies:
Install GrumPHP with dependencies:
Install GrumPHP without dependencies and automated git hooks through phive
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!
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! See the suggest section in composer.json.
Note: GrumPHP will overwrite existing hooks unless you run composer install with --no-plugins or --no-scripts.
We do create a backup of your git hook, but it's best to make sure you also have a backup of your custom hooks before you try to install GrumPHP.
Having trouble installing GrumPHP? Find out how to:
- Install globally
- Install with an exotic project structure
Configuration
Some things in GrumPHP can be configured in a grumphp.yml or grumphp.yml.dist or grumphp.dist.yml 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.
Details of the configuration are broken down into the following sections.
- Parameters – Configuration settings for GrumPHP itself.
- Tasks – External tasks performing code validation and their respective configurations.
- TestSuites
- Extensions
- Extending the TaskRunner
- Conventions checker
Commands
Since GrumPHP is just a CLI tool, these commands can be triggered:
- configure
- git:init
- git:deinit
- git:pre-commit
- git:commit-msg
- run
Compatibility
GrumPHP works with PHP 5.6 or above.
This package has been tested with following git clients:
- CLI Unix
- CLI Mac
- CLI Windows
- PhpStorm Git
- Atlassian SourceTree
- Syntevo SmartGit
Roadmap
Lots of tasks are already available to make sure your team writes great code. 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! Want to help out? Feel free to contact us!
FAQ
- FAQ
About
Submitting bugs and feature requests
Bugs and feature request are tracked on GitHub. Please take a look at our rules before contributing your code.
License
GrumPHP is licensed under the MIT License.
All versions of grumphp with dependencies
ext-json Version *
composer-plugin-api Version ^2.0
amphp/amp Version ^3.0
amphp/parallel Version ^2.1
doctrine/collections Version ^1.6.8 || ^2.0
gitonomy/gitlib Version ^1.3
laravel/serializable-closure Version ^1.1
monolog/monolog Version ^2.0 || ^3.0
ondram/ci-detector Version ^4.0
psr/container Version ^1.1 || ^2.0
seld/jsonlint Version ^1.8
symfony/config Version ^5.4 || ^6.0 || ^7.0
symfony/console Version ^5.4 || ^6.0 || ^7.0
symfony/dependency-injection Version ^5.4 || ^6.0 || ^7.0
symfony/dotenv Version ^5.4 || ^6.0 || ^7.0
symfony/event-dispatcher Version ^5.4 || ^6.0 || ^7.0
symfony/filesystem Version ^5.4 || ^6.0 || ^7.0
symfony/finder Version ^5.4 || ^6.0 || ^7.0
symfony/options-resolver Version ^5.4 || ^6.0 || ^7.0
symfony/process Version ^5.4 || ^6.0 || ^7.0
symfony/yaml Version ^5.4 || ^6.0 || ^7.0