phpstan banned code

Code banni PHPStan

Cette bibliothèque est basée sur PHPStan pour détecter les appels à des fonctions spécifiques que vous ne souhaitez pas dans votre projet. Par exemple, vous pouvez l'ajouter dans votre processus CI pour vous assurer qu'il n'y a pas de code de débogage/non standard (comme var_dump, exit, ...).

Utilisation de base

Pour utiliser cette extension, exigez-la à l'aide de Composer :

composer require --dev ekino/phpstan-banned-code

Lorsque vous utilisez https://github.com/phpstan/extension-installer, vous avez terminé.

Sinon, incluez extension.neon dans la configuration PHPStan de votre projet :

 includes:
	- vendor/ekino/phpstan-banned-code/extension.neon

Utilisation avancée

Vous pouvez configurer cette bibliothèque avec des paramètres :

 parameters:
	banned_code:
		nodes:
			# enable detection of echo
			-
				type: Stmt_Echo
				functions: null

			# enable detection of eval
			-
				type: Expr_Eval
				functions: null

			# enable detection of die/exit
			-
				type: Expr_Exit
				functions: null

			# enable detection of a set of functions
			-
				type: Expr_FuncCall
				functions:
					- dd
					- debug_backtrace
					- dump
					- exec
					- passthru
					- phpinfo
					- print_r
					- proc_open
					- shell_exec
					- system
					- var_dump

			# enable detection of print statements
			-
				type: Expr_Print
				functions: null

			# enable detection of shell execution by backticks
			-
				type: Expr_ShellExec
				functions: null

		# enable detection of `use TestsFooBar` in a non-test file
		use_from_tests: true

		# errors emitted by the extension are non-ignorable by default, so they cannot accidentally be put into the baseline.
		non_ignorable: false # default is true

type est la valeur renvoyée d'un nœud, voir la méthode getType() .