mirror of
https://github.com/Dolibarr/dolibarr.git
synced 2025-12-05 09:08:09 +01:00
8655d5a86b
* 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>
197 lines
8.1 KiB
PHP
197 lines
8.1 KiB
PHP
<?php
|
|
/* Copyright (C) 2024 MDW <mdeweerd@users.noreply.github.com>
|
|
*/
|
|
define('DOL_PROJECT_ROOT', __DIR__.'/../../..');
|
|
define('DOL_DOCUMENT_ROOT', DOL_PROJECT_ROOT.'/htdocs');
|
|
define('PHAN_DIR', __DIR__);
|
|
/**
|
|
* This configuration will be read and overlaid on top of the
|
|
* default configuration. Command line arguments will be applied
|
|
* after this file is read.
|
|
*/
|
|
return [
|
|
// 'processes' => 6,
|
|
'backward_compatibility_checks' => false,
|
|
'simplify_ast' => true,
|
|
'analyzed_file_extensions' => ['php','inc'],
|
|
'globals_type_map' => [
|
|
'conf' => '\Conf',
|
|
'db' => '\DoliDB',
|
|
'extrafields' => '\ExtraFields',
|
|
'hookmanager' => '\HookManager',
|
|
'langs' => '\Translate',
|
|
'mysoc' => '\Societe',
|
|
'nblines' => '\int',
|
|
'user' => '\User',
|
|
],
|
|
|
|
// Supported values: `'5.6'`, `'7.0'`, `'7.1'`, `'7.2'`, `'7.3'`, `'7.4'`, `null`.
|
|
// If this is set to `null`,
|
|
// then Phan assumes the PHP version which is closest to the minor version
|
|
// of the php executable used to execute Phan.
|
|
//"target_php_version" => null,
|
|
"target_php_version" => '8.2',
|
|
//"target_php_version" => '7.3',
|
|
//"target_php_version" => '5.6',
|
|
|
|
// A list of directories that should be parsed for class and
|
|
// method information. After excluding the directories
|
|
// defined in exclude_analysis_directory_list, the remaining
|
|
// files will be statically analyzed for errors.
|
|
//
|
|
// Thus, both first-party and third-party code being used by
|
|
// your application should be included in this list.
|
|
'directory_list' => [
|
|
'htdocs',
|
|
PHAN_DIR . '/stubs/',
|
|
],
|
|
|
|
// A directory list that defines files that will be excluded
|
|
// from static analysis, but whose class and method
|
|
// information should be included.
|
|
//
|
|
// Generally, you'll want to include the directories for
|
|
// third-party code (such as "vendor/") in this list.
|
|
//
|
|
// n.b.: If you'd like to parse but not analyze 3rd
|
|
// party code, directories containing that code
|
|
// should be added to the `directory_list` as
|
|
// to `exclude_analysis_directory_list`.
|
|
"exclude_analysis_directory_list" => [
|
|
'htdocs/includes/',
|
|
'htdocs/core/class/lessc.class.php', // External library
|
|
PHAN_DIR . '/stubs/',
|
|
],
|
|
//'exclude_file_regex' => '@^vendor/.*/(tests?|Tests?)/@',
|
|
'exclude_file_regex' => '@^(' // @phpstan-ignore-line
|
|
.'dummy' // @phpstan-ignore-line
|
|
.'|htdocs/.*/canvas/.*/tpl/.*.tpl.php' // @phpstan-ignore-line
|
|
.'|htdocs/modulebuilder/template/.*' // @phpstan-ignore-line
|
|
// Included as stub (old version + incompatible typing hints)
|
|
.'|htdocs/includes/restler/.*' // @phpstan-ignore-line
|
|
// Included as stub (did not seem properly analysed by phan without it)
|
|
.'|htdocs/includes/stripe/.*' // @phpstan-ignore-line
|
|
.')@', // @phpstan-ignore-line
|
|
|
|
// A list of plugin files to execute.
|
|
// Plugins which are bundled with Phan can be added here by providing their name
|
|
// (e.g. 'AlwaysReturnPlugin')
|
|
//
|
|
// Documentation about available bundled plugins can be found
|
|
// at https://github.com/phan/phan/tree/master/.phan/plugins
|
|
//
|
|
// Alternately, you can pass in the full path to a PHP file
|
|
// with the plugin's implementation (e.g. 'vendor/phan/phan/.phan/plugins/AlwaysReturnPlugin.php')
|
|
'plugins' => [
|
|
'DeprecateAliasPlugin',
|
|
//'EmptyMethodAndFunctionPlugin',
|
|
'InvalidVariableIssetPlugin',
|
|
//'MoreSpecificElementTypePlugin',
|
|
'NoAssertPlugin',
|
|
'NotFullyQualifiedUsagePlugin',
|
|
'PHPDocRedundantPlugin',
|
|
'PHPUnitNotDeadCodePlugin',
|
|
//'PossiblyStaticMethodPlugin',
|
|
'PreferNamespaceUsePlugin',
|
|
'PrintfCheckerPlugin',
|
|
'RedundantAssignmentPlugin',
|
|
|
|
'ConstantVariablePlugin', // Warns about values that are actually constant
|
|
//'HasPHPDocPlugin', // Requires PHPDoc
|
|
'InlineHTMLPlugin', // html in PHP file, or at end of file
|
|
'NonBoolBranchPlugin', // Requires test on bool, nont on ints
|
|
'NonBoolInLogicalArithPlugin',
|
|
'NumericalComparisonPlugin',
|
|
'PHPDocToRealTypesPlugin',
|
|
'PHPDocInWrongCommentPlugin', // Missing /** (/* was used)
|
|
//'ShortArrayPlugin', // Checks that [] is used
|
|
//'StrictLiteralComparisonPlugin',
|
|
'UnknownClassElementAccessPlugin',
|
|
'UnknownElementTypePlugin',
|
|
'WhitespacePlugin',
|
|
//'RemoveDebugStatementPlugin', // Reports echo, print, ...
|
|
'SimplifyExpressionPlugin',
|
|
//'StrictComparisonPlugin', // Expects ===
|
|
'SuspiciousParamOrderPlugin',
|
|
'UnsafeCodePlugin',
|
|
//'UnusedSuppressionPlugin',
|
|
|
|
'AlwaysReturnPlugin',
|
|
//'DollarDollarPlugin',
|
|
'DuplicateArrayKeyPlugin',
|
|
'DuplicateExpressionPlugin',
|
|
'PregRegexCheckerPlugin',
|
|
'PrintfCheckerPlugin',
|
|
'SleepCheckerPlugin',
|
|
// Checks for syntactically unreachable statements in
|
|
// the global scope or function bodies.
|
|
'UnreachableCodePlugin',
|
|
'UseReturnValuePlugin',
|
|
'EmptyStatementListPlugin',
|
|
'LoopVariableReusePlugin',
|
|
],
|
|
|
|
// Add any issue types (such as 'PhanUndeclaredMethod')
|
|
// here to inhibit them from being reported
|
|
'suppress_issue_types' => [
|
|
'PhanPluginWhitespaceTab', // Dolibarr used tabs
|
|
'PhanPluginCanUsePHP71Void', // Dolibarr is maintaining 7.0 compatibility
|
|
'PhanPluginShortArray', // Dolibarr uses array()
|
|
'PhanPluginShortArrayList', // Dolibarr uses array()
|
|
// The following may require that --quick is not used
|
|
'PhanPluginCanUseParamType', // Does not seem useful: is reporting types already in PHPDoc?
|
|
'PhanPluginCanUseReturnType', // Does not seem useful: is reporting types already in PHPDoc?
|
|
'PhanPluginCanUseNullableParamType', // Does not seem useful: is reporting types already in PHPDoc?
|
|
'PhanPluginNonBoolBranch', // Not essential - 31240+ occurrences
|
|
'PhanPluginNumericalComparison', // Not essential - 19870+ occurrences
|
|
'PhanTypeMismatchArgument', // Not essential - 12300+ occurrences
|
|
'PhanPluginNonBoolInLogicalArith', // Not essential - 11040+ occurrences
|
|
'PhanPluginConstantVariableScalar', // Not essential - 5180+ occurrences
|
|
'PhanPluginDuplicateConditionalTernaryDuplication', // 2750+ occurrences
|
|
'PhanPluginDuplicateConditionalNullCoalescing', // Not essential - 990+ occurrences
|
|
|
|
],
|
|
// You can put relative paths to internal stubs in this config option.
|
|
// Phan will continue using its detailed type annotations,
|
|
// but load the constants, classes, functions, and classes (and their Reflection types)
|
|
// from these stub files (doubling as valid php files).
|
|
// Use a different extension from php (and preferably a separate folder)
|
|
// to avoid accidentally parsing these as PHP (includes projects depending on this).
|
|
// The 'mkstubs' script can be used to generate your own stubs (compatible with php 7.0+ right now)
|
|
// Note: The array key must be the same as the extension name reported by `php -m`,
|
|
// so that phan can skip loading the stubs if the extension is actually available.
|
|
'autoload_internal_extension_signatures' => [
|
|
// Stubs may be available at https://github.com/JetBrains/phpstorm-stubs/tree/master
|
|
|
|
// Xdebug stubs are bundled with Phan 0.10.1+/0.8.9+ for usage,
|
|
// because Phan disables xdebug by default.
|
|
//'xdebug' => 'vendor/phan/phan/.phan/internal_stubs/xdebug.phan_php',
|
|
//'memcached' => PHAN_DIR . '/your_internal_stubs_folder_name/memcached.phan_php',
|
|
//'PDO' => PHAN_DIR . '/stubs/PDO.phan_php',
|
|
'brotli' => PHAN_DIR . '/stubs/brotli.phan_php',
|
|
'curl' => PHAN_DIR . '/stubs/curl.phan_php',
|
|
'calendar' => PHAN_DIR . '/stubs/calendar.phan_php',
|
|
'fileinfo' => PHAN_DIR . '/stubs/fileinfo.phan_php',
|
|
'ftp' => PHAN_DIR . '/stubs/ftp.phan_php',
|
|
'gd' => PHAN_DIR . '/stubs/gd.phan_php',
|
|
'geoip' => PHAN_DIR . '/stubs/geoip.phan_php',
|
|
'imap' => PHAN_DIR . '/stubs/imap.phan_php',
|
|
'intl' => PHAN_DIR . '/stubs/intl.phan_php',
|
|
'ldap' => PHAN_DIR . '/stubs/ldap.phan_php',
|
|
'mcrypt' => PHAN_DIR . '/stubs/mcrypt.phan_php',
|
|
'memcache' => PHAN_DIR . '/stubs/memcache.phan_php',
|
|
'mysqli' => PHAN_DIR . '/stubs/mysqli.phan_php',
|
|
'pdo_cubrid' => PHAN_DIR . '/stubs/pdo_cubrid.phan_php',
|
|
'pdo_mysql' => PHAN_DIR . '/stubs/pdo_mysql.phan_php',
|
|
'pdo_pgsql' => PHAN_DIR . '/stubs/pdo_pgsql.phan_php',
|
|
'pdo_sqlite' => PHAN_DIR . '/stubs/pdo_sqlite.phan_php',
|
|
'pgsql' => PHAN_DIR . '/stubs/pgsql.phan_php',
|
|
'session' => PHAN_DIR . '/stubs/session.phan_php',
|
|
'simplexml' => PHAN_DIR . '/stubs/SimpleXML.phan_php',
|
|
'soap' => PHAN_DIR . '/stubs/soap.phan_php',
|
|
'sockets' => PHAN_DIR . '/stubs/sockets.phan_php',
|
|
'zip' => PHAN_DIR . '/stubs/zip.phan_php',
|
|
],
|
|
|
|
];
|