phanalist

Crates.io	phanalist
lib.rs	phanalist
version	0.1.21
source	src
created_at	2024-04-16 20:14:41.746539
updated_at	2024-04-16 20:14:41.746539
description	Performant static analyzer for PHP, which is extremely easy to use. It helps you catch common mistakes in your PHP code.
homepage
repository	https://github.com/denzyldick/phanalist
max_upload_size
id	1210641
size	162,716

Denzyl Dick (denzyldick)

documentation

README

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

Installation

The simplest way to install phanalist is to use the installation script.

curl --proto '=https' --tlsv1.2 -sSf https://raw.githubusercontent.com/denzyldick/phanalist/main/bin/init.sh | sh

It will automatically download the executable for your platform:

$ ~/phanalist -V
phanalist 1.0.0

There are also multiple other installation options.

Usage

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

$ ~/phanalist

Example

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
  E0010:
    max_paths: 200
  E0012: 
    include_namespaces: 
      - "App\\Service\\"
      - "App\\Controller\\"
    exclude_namespaces: []

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
E0010	Npath complexity	max_complexity: 200
E0012	Service compatibility with Shared Memory Model	include_namespaces: ["App\Service\"], exclude_namespaces: [], reset_interfaces: ["ResetInterface"]

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.

Commit count: 343