https://github.com/pascal-splotches/php-composter-phpmd

Automatically install a git pre-commit hook to check your PHP files upon each commit to make sure they follow the rules defined in phpmd.xml.
https://github.com/pascal-splotches/php-composter-phpmd

composer githook phpmd

Last synced: 25 days ago
JSON representation

Automatically install a git pre-commit hook to check your PHP files upon each commit to make sure they follow the rules defined in phpmd.xml.

• Host: GitHub
• URL: https://github.com/pascal-splotches/php-composter-phpmd
• Owner: pascal-splotches
• License: gpl-3.0
• Created: 2018-09-27T21:25:03.000Z (about 6 years ago)
• Default Branch: master
• Last Pushed: 2018-09-28T12:15:42.000Z (about 6 years ago)
• Last Synced: 2024-09-30T22:41:01.873Z (about 1 month ago)
• Topics: composer, githook, phpmd
• Language: PHP
• Size: 26.4 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# PHP Composter PHPMD 

![standard-readme compliant](https://img.shields.io/badge/standard--readme-OK-green.svg?style=flat-square)

Automatically install a git pre-commit hook to check your PHP files upon each commit to make sure they follow the rules defined in `phpmd.xml`. 

## Table Of Contents

- [Installation](#installation)

- [Usage](#usage)

- [Built With](#built-with)

- [Contributing](#contributing)

- [Versioning](#versioning)

- [Authors](#authors)

- [License](#license)

## Installation

Add as a development requirement to your `composer.json`:

```bash

composer require --dev pascal-splotches/php-composter-phpmd

```

## Usage

It automatically works whenever you execute a `git commit`.

## Configuration

You need to add a configuration section to your `phpmd.xml` ruleset with the correct flags and paths:

```xml

    

    

        src

        

    

    

    

    

        docs

        

    

    

    

    

    

    

    

    

    

    

    

        php

        

    

    

    

    

```

## Built With

- [Composter](https://github.com/php-composter/php-composter)

- [PHP Mess Detector](https://phpmd.org/)

## Contributing

All feedback, bug reports and pull requests are welcomed.

## Versioning

We use [SemVer](https://semver.org/) for versioning. For the versions available, see the [releases on this repository](https://github.com/pascal-splotches/php-composter-phpmd/releases).

## Authors

- Pascal Scheepers 

## License

This project is licensed under the GPL v3 License - see the [LICENSE](./LICENSE) file for details.