dolibarr

History

MDW 0831c65913 Qual: Update Phan baseline.txt (#36190 ) #Qual: Update Phan baseline.txt Update the Phan baseline.txt file to reflect changes in the number of occurrences of specific issues.		2025-11-09 17:58:08 +01:00
..
plugins
stubs	qual: Update FTP stub for phan (#34796 )	2025-07-24 11:30:54 +02:00
.gitignore
baseline.txt	Qual: Update Phan baseline.txt (#36190 )	2025-11-09 17:58:08 +01:00
baseline_extended.txt
config.php	clean code (#35427 )	2025-09-22 22:25:00 +02:00
config_extended.php
config_fixer.php
PHAN.BAT
README.md
run-phan.sh
runPhanDocker.sh

README.md

Static Code Checks using phan

Installation, running

run-phan.sh can install and run phan.

See instructions in run-phan.sh for installing (or just run it).

The configuration file in PROJECT_DIR/.phan/config.php also allows you to run phan independently from the script.

Run options:

No option : Runs the minimum checks

Option 'full' : Runs all an extensive set of checks

Option '1' : Writes the baseline

Examples:

run-phan.sh runs the default checks
run-phan.sh 1 updates the baseline for the default checks
run-phan.sh full runs the extended checks
run-phan.sh full 1 updates the baseline for the extended checks

Baseline

The baseline.txt file in this directory defines the issues that are currently excluded from the final report. In principle you should not add any more exceptions to that file, but rather fix the issues or add phan annotations that provide more information or to exclude specific cases.

Configuration

config.php : Default configuration file

config_extended.php : Configuration that enables more checks.

baseline.txt : Ignored issues (with config.php)

baseline_extended.txt : Ignored issues (with config_extended.php), not currently in git