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

Automatically install a git pre-commit hook to check your PHP files upon each commit to make sure they comply to the Code Style you have defined in phpcs.xml.
https://github.com/pascal-splotches/php-composter-phpcs

composer githook phpcs

Last synced: 5 days ago
JSON representation

Automatically install a git pre-commit hook to check your PHP files upon each commit to make sure they comply to the Code Style you have defined in phpcs.xml.

• Host: GitHub
• URL: https://github.com/pascal-splotches/php-composter-phpcs
• Owner: pascal-splotches
• License: gpl-3.0
• Created: 2018-09-24T11:23:07.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2018-09-28T05:54:28.000Z (over 6 years ago)
• Last Synced: 2024-11-18T20:16:53.810Z (2 months ago)
• Topics: composer, githook, phpcs
• Language: PHP
• Homepage:
• Size: 35.2 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 PHPCS

![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 comply to the Code Style you have defined in `phpcs.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-phpcs

```

## Usage

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

## Built With

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

- [PHP CodeSniffer Project](https://github.com/squizlabs/PHP_CodeSniffer)

## 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-phpcs/releases).

## Authors

- Pascal Scheepers 

## License

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