https://github.com/ekino/phpstan-banned-code

Detect banned code through PHPStan
https://github.com/ekino/phpstan-banned-code

php phpstan-extension quality

Last synced: about 2 months ago
JSON representation

Detect banned code through PHPStan

• Host: GitHub
• URL: https://github.com/ekino/phpstan-banned-code
• Owner: ekino
• License: mit
• Created: 2019-01-02T15:50:21.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2023-10-11T08:46:29.000Z (12 months ago)
• Last Synced: 2024-04-14T12:50:58.417Z (5 months ago)
• Topics: php, phpstan-extension, quality
• Language: PHP
• Homepage:
• Size: 94.7 KB
• Stars: 202
• Watchers: 16
• Forks: 18
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# PHPStan Banned Code

[![Latest Stable Version](https://poser.pugx.org/ekino/phpstan-banned-code/v/stable)](https://packagist.org/packages/ekino/phpstan-banned-code)

[![Build Status](https://travis-ci.org/ekino/phpstan-banned-code.svg?branch=master)](https://travis-ci.org/ekino/phpstan-banned-code)

[![Coverage Status](https://coveralls.io/repos/ekino/phpstan-banned-code/badge.svg?branch=master&service=github)](https://coveralls.io/github/ekino/phpstan-banned-code?branch=master)

[![Total Downloads](https://poser.pugx.org/ekino/phpstan-banned-code/downloads)](https://packagist.org/packages/ekino/phpstan-banned-code)

This library is based on [PHPStan](https://phpstan.org/) to detect calls to specific functions you don't want in your project.

For instance, you can add it in your CI process to make sure there is no debug/non standard code (like [var_dump](https://www.php.net/manual/en/function.var-dump.php), [exit](https://www.php.net/manual/en/function.exit.php), ...).

## Basic usage

To use this extension, require it using [Composer](https://getcomposer.org/):

```bash

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

```

When you use https://github.com/phpstan/extension-installer you are done.

If not, include `extension.neon` in your project's PHPStan config:

```

includes:

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

```

## Advanced usage

You can configure this library with parameters:

```

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 Tests\Foo\Bar` in a non-test file

		use_from_tests: true

```

`type` is the returned value of a node, see the method `getType()`.