denzyldick / phanalist

Performant static analyzer for PHP, which is extremely easy to use. It helps you catch common mistakes in your PHP code.

Performant static analyzer for PHP, which is extremely easy to use. It helps you catch common mistakes in your PHP code.

Installation

Download

The simplest way is to download compiled executables for your platform:

• macOS: aarch64, x86_64
• Linux MUSL: aarch64, x86_64
• Linux GNU: aarch64, x86_64

Compile

Alternatively, you can compile it from sources on your local:

# Install RUST
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh
# Get the latest sources
git clone [e-mail]:denzyldick/phanalist.git && cd phanalist
# Compile
cargo build -r
# Run the compiled executable
./target/release/phanalist -V

Docker

Another option is to use official docker image, by running the command at the root of your project:

docker run -it -v $(pwd):/var/src ghcr.io/denzyldick/phanalist:latest

Usage

To analyze your project sources, you just need to run phanalist:

$ phanalist
The new ./phanalist.yaml configuration file as been created

Scanning files in ./src ...
██████████████████████████████████████████████████████████████████████████████ 3/3
./src/rules/examples/e2/empty_catch.php, detected 1 violation:
  E0002:	There is an empty catch. It's not recommended to catch an Exception without doing anything with it.
  9:11	|         } catch(Exception $e) {}

+-----------+-------------+------------+
| Rule Code | Description | Violations |
+-----------+-------------+------------+
| E0002     | Empty catch |          1 |
+-----------+-------------+------------+

Analysed 2 files in 1.31ms, memory usage: 4.6 MiB

On the first run phanalist.yaml will be created with the default configurations. And it will be reused on all the following runs.

There are also a few additional parameters:

• config: path to the configuration file, ./phanalist.yaml is default value.
• src: path to project sources, ./src is default value.
• output-format: format used to output the results. Possible options are text (default) and json.
• summary-only: output only amounts of found violations for each rule.
• quiet: suppresses all the output.

Configuration

The possible options are:

• enabled_rules contains the list of rules to use. All rules will be used if this list is empty.
• disable_rules contains the list of rules to ignore.
• rules rule-specific options.

The default configuration file is:

enabled_rules: []
disable_rules: []
rules:
  E0007:
    check_constructor: true
    max_parameters: 5
  E0009:
    max_complexity: 10

Rules

The following rules are available:

Code	Name	Default options
E0000	Example rule
E0001	Opening tag position
E0002	Empty catch
E0003	Method modifiers
E0004	Uppercase constants
E0005	Capitalized class name
E0006	Property modifiers
E0007	Method parameters count	check_constructor: true, max_parameters: 5
E0008	Return type signature
E0009	Cyclomatic complexity	max_complexity: 10

Adding a new rule is a simple task, and this tutorial explains how to do it.

Articles

Read a series of chapters on https://dev.to/denzyldick to understand the project's internals. It is a great, easy-to-read introduction to this project.

1. Write your own static analyzer for PHP.
2. How I made it impossible to write spaghetti code.
3. Detecting spaghetti code in AST of a PHP source code.