Skip to content

Latest commit

 

History

History
42 lines (29 loc) · 1.11 KB

README.md

File metadata and controls

42 lines (29 loc) · 1.11 KB

Flickerleap code sniffer

This project contains rulesets to be used with phpcs https://github.com/squizlabs/PHP_CodeSniffer

Installation

$ composer global require squizlabs/php_codesniffer flickerleap/phpcs

$ ~/.composer/vendor/bin/phpcs --config-set installed_paths ~/.composer/vendor/flickerleap/phpcs/src/Standards

Usage

$ ~/.composer/vendor/bin/flickerleap/phpcs --standard=flickerleap --extensions=php path/to/src

Rules

Effort has been made to follow Laravel convention as closely as possible.

flickerleap standard

  • All PSR2 rules
  • Require function docblocks
  • Require line endings and lenght of 120
  • Force array indentation and new syntax
  • Force statements in conditions
  • Dissallow statements in conditions
  • Dissallow fix me and todos
  • Force camel case variable names
  • Force indentation
  • Dissallow var_dump() functions

laravel standard

This standard extends the flickerleap standard and includes additional sniffs specific to the framework

  • All flickerleap rules
  • Dissallow dd and dump() functions
  • Disallow env() function usage outside of the config folder