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
2b6af8ddfb
dolibarr/dev/tools/phan
History
MDW 32732d37d2
Qual: Improve typing in Export class (#30859) 
* Update baseline

* Qual: Improve typing in Export class

* Add 'abstract' methods to help with typing

* Add some typing

* Improve typing in export modules

* Improve typing for AccountancyExport

* Qual: PHPDoc executeCLI (nullable arguments, range)

* PHPDoc for export function

* Fix $permissiontoClose -> $permissiontoclose

* PHPDoc - Improve AccountingJournal typing

* Improve export_journal tpl typing

* Improve html.formsetup typing

* Impove commonfieldsexport typing

* Improve extrafieldsinexport typing

* Fix typing, initialisation

* Fix typing intracommreport

* Ensure string in $error for CronJob
2024-09-09 03:15:26 +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
baseline_extended.txt Exclude false positive 2024-06-16 13:17:10 +02:00
baseline.txt Qual: Improve typing in Export class (#30859) 2024-09-09 03:15:26 +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 Clean code: fight against global vars 2024-08-27 06:20:04 +02:00
PHAN.BAT Qual: Enable detection of deprecated modulename & GETPOST(...,'int') (#28457) 2024-02-28 23:25:16 +01:00
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