Giter VIP home page Giter VIP logo

codingstandard's Introduction

CodingStandard

Soupis firemního coding standardu pro PHP programátory v nástroji 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

Integrace CodeSnifferu do PhpStormu

Návod dostupný v dokumentaci.

codingstandard's People

Contributors

milanpala avatar spilky avatar klobinoid avatar jankaderabek avatar aloisjasa avatar jakubenglicky avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.