Mirrors/dolibarr
1
0
Fork 0
mirror of https://github.com/Dolibarr/dolibarr.git synced 2025-02-20 13:46:52 +01:00
Code Issues Packages Projects Releases Wiki Activity
c8a1ac578d
dolibarr/dev/tools/phan
History
MDW 6fb924e90b
Qual: Update baseline for phan (because of fixes) (#31008) 
# Qual: Update baseline for phan (because of fixes)

Several fixes to the code (mostly related to phpstan notices) also
fixed several phan notices which are removed from the baseline
with this change.
2024-09-20 02:19:52 +02:00
..
plugins Fix errormessage 2024-05-31 15:57:03 +02:00
stubs Fix phan 2024-04-28 21:56:41 +02:00
.gitignore QUAL Use phan to help detect new issues (#27706) 2024-02-21 18:14:29 +01:00
baseline_extended.txt Exclude false positive 2024-06-16 13:17:10 +02:00
baseline.txt Qual: Update baseline for phan (because of fixes) (#31008) 2024-09-20 02:19:52 +02:00
config_extended.php Removed some warning (not priority) 2024-08-03 14:02:09 +02:00
config_fixer.php Add checks on dol_(mktime|now|print_date) + avoid duplicate phan conf 2024-03-27 10:18:39 +01:00
config.php Qual: Fix new UndeclaredGlobalVariable notices & enable (#30963) 2024-09-16 01:50:58 +02:00
PHAN.BAT Qual: Enable detection of deprecated modulename & GETPOST(...,'int') (#28457) 2024-02-28 23:25:16 +01:00
README.md QUAL Use phan to help detect new issues (#27706) 2024-02-21 18:14:29 +01:00
run-phan.sh QUAL Use phan to help detect new issues (#27706) 2024-02-21 18:14:29 +01:00
runPhanDocker.sh QUAL Use phan to help detect new issues (#27706) 2024-02-21 18:14:29 +01:00

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