https://github.com/peckadesign/codingstandard

Soupis firemního coding standardu pro PHP programátory
https://github.com/peckadesign/codingstandard

coding-standards phpcs

Last synced: 9 months ago
JSON representation

Soupis firemního coding standardu pro PHP programátory

• Host: GitHub
• URL: https://github.com/peckadesign/codingstandard
• Owner: peckadesign
• Created: 2017-02-27T13:21:05.000Z (about 9 years ago)
• Default Branch: master
• Last Pushed: 2023-09-20T12:46:11.000Z (over 2 years ago)
• Last Synced: 2025-03-23T10:51:11.120Z (about 1 year ago)
• Topics: coding-standards, phpcs
• Language: PHP
• Homepage:
• Size: 502 KB
• Stars: 8
• Watchers: 17
• Forks: 1
• Open Issues: 5
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# CodingStandard

Soupis firemního coding standardu pro PHP programátory v nástroji [PHP CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer).

## Jak začít používat na svém projektu

Každá vydaná verze obsahuje nová pravidla. Je vhodné tak začít na verzi 1.0.0 a postupně navyšovat verzi podle nalezených chyb a varování.

Do projektu je nejsnazší přidat podporu pomocí `composeru`:

```

$ composer require pd/coding-standard --dev

```

CI server spustí kontrolu, pokud `Makefile` na projektu obsahuje cíl `cs`:

```

$ cat Makefile

cs:

	- vendor/bin/phpcs app/ --standard=vendor/pd/coding-standard/src/PeckaCodingStandard/ruleset.xml --report-file=output.cs

```

Lokálně je možné spustit kontrolu přes `make cs` nebo pomocí příkazu:

```

vendor/bin/phpcs app/ --standard=vendor/pd/coding-standard/src/PeckaCodingStandard/ruleset.xml -p

```

## Výstup

Na GitHubu se po spuštění na CI serveru objeví shrnutí výsledků a pod odkazem `Details` je kompletní výstup nástroje PHP CS

![Vzorový výstup na GitHubu](doc/example-github.png)

## Integrace CodeSnifferu do PhpStormu

Návod dostupný v [dokumentaci](doc/phpstorm.md).