phpstan banned code

PHPStan 禁止コード

このライブラリは PHPStan に基づいており、プロジェクト内で不要な特定の関数の呼び出しを検出します。たとえば、これを CI プロセスに追加して、デバッグ コードや非標準コード (var_dump、exit など) がないことを確認できます。

基本的な使い方

この拡張機能を使用するには、Composer を使用して拡張機能を要求します。

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

https://github.com/phpstan/extension-installer を使用すると完了です。

そうでない場合は、プロジェクトの PHPStan 構成にextension.neonを含めます。

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

高度な使用法

このライブラリはパラメータを使用して構成できます。

 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ノードの戻り値です。メソッドgetType()を参照してください。