dolibarr/README.md at 901b9dab72357dad4e162f94d6b53e1e84d20dd5

mirror of https://github.com/Dolibarr/dolibarr.git synced 2025-12-07 10:08:27 +01:00

Files

MDW 8655d5a86b QUAL Use phan to help detect new issues (#27706 )

* Qual: Add phan flow

- Add phan configuration (config, baseline, stubs);
- Add github action;
- Update apstats.php.

* Add directives to ignore false phan notices

* Qual: Add typing hints for extrafields TPL files

# Qual: Add typing hints for extrafields TPL files

Add typing hints for phan on view files

---------

Co-authored-by: Laurent Destailleur <eldy@destailleur.fr>

2024-02-21 18:14:29 +01:00

1.4 KiB

Raw Blame History

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

1.4 KiB Raw Blame History