rules.md

Rules and default configuration

How to disable a specific rule?

"namespace-max-files": false,

List of rules:

namespace-max-files

Avoid namespaces with 15+ files:

"namespace-max-files": 15

argument-override

Avoid overriding of a function's arguments:

"argument-override": {
  "allow-pass-by-reference": true,
},

file-max-size

Avoid files with more than 200 lines:

"file-max-size": {
  "max-lines": 200,
  "include-comments": true,
  "include-empty-lines": true,
  "include-brackets": true
},

empty-catch

Avoid empty catch blocks:

"empty-catch": true

class-comment

Avoid a class without a single comment at the top stating purpose:

"class-comment": true

forbidden-functions

Avoid dangerous calls to eval, print_r, var_export, var_dump, phpinfo, exec, ... (forbidden function list):

"forbidden-functions": [
  "eval", "print_r", "var_export", "var_dump", "phpinfo", "exec"
],

missing-braces

Avoid an if statement or for loop without braces:

"missing-braces": true,

variable-length

Avoid variables with names shorter than 3 letters (while whitelisting $i or $id)

"variable-length": {
  "min-length": 3,
  "whitelist": ["$id", "$i"]
}

function-max-size

Avoid any function longer than 50 lines:

"function-max-size": 50,

loop-max-size

Aavoid loops with inside of them more than 15 lines (a block that should be a function):

"loop-max-size": 15,

forbidden-function-prefix

Avoid function names starting with a certain pattern:

"forbidden-function-prefix": ["check"],

if-assigment

Avoid assignment inside of an if statement:

"if-assigment": true,

complex-if

Avoid complicated ifs (eg more than 2 &&, combination of && and ||):

"complex-if": true,

ternary-max-length

Avoid ternary operator combined with line length exceeding 50 chars:

"ternary-max-length": 50,

loop-max-nest

Avoid triple inner for/foreach (eg for within for within for loop):

"loop-max-nest": 2,

max-nest

Avoid indent deeper than 4 (maximum block nesting, eg for loop within an if within a for loop within a for loop):

"max-nest": 3,