phpinsights.php

<?php
/**
 * PhpInsights configuration file
 *
 * @package sureforms-pro
 */

declare(strict_types=1);

return [

	/*
	|--------------------------------------------------------------------------
	| Default Preset
	|--------------------------------------------------------------------------
	|
	| This option controls the default preset that will be used by PHP Insights
	| to make your code reliable, simple, and clean. However, you can always
	| adjust the `Metrics` and `Insights` below in this configuration file.
	|
	| Supported: "default", "laravel", "symfony", "magento2", "drupal", "wordpress"
	|
	*/

	'preset'       => 'wordpress',

	/*
	|--------------------------------------------------------------------------
	| IDE
	|--------------------------------------------------------------------------
	|
	| This options allow to add hyperlinks in your terminal to quickly open
	| files in your favorite IDE while browsing your PhpInsights report.
	|
	| Supported: "textmate", "macvim", "emacs", "sublime", "phpstorm",
	| "atom", "vscode".
	|
	| If you have another IDE that is not in this list but which provide an
	| url-handler, you could fill this config with a pattern like this:
	|
	| myide://open?url=file://%f&line=%l
	|
	*/

	'ide'          => 'vscode',

	/*
	|--------------------------------------------------------------------------
	| Configuration
	|--------------------------------------------------------------------------
	|
	| Here you may adjust all the various `Insights` that will be used by PHP
	| Insights. You can either add, remove or configure `Insights`. Keep in
	| mind, that all added `Insights` must belong to a specific `Metric`.
	|
	*/

	'exclude'      => [
		'assets',
		'modules',
		'tests/*',
		'inc/lib',
		'phpinsights.php',
	],

	'add'          => [],

	'remove'       => [
		/**
		 * Globals accesses detected
		 * ToDo: Remove this rule after fixing the issue
		 */
		NunoMaduro\PhpInsights\Domain\Insights\ForbiddenGlobals::class,

		/**
		 * Global keyword
		 * ToDo: Remove this rule after fixing the issue
		 */
		PHP_CodeSniffer\Standards\Squiz\Sniffs\PHP\GlobalKeywordSniff::class,

		/**
		 * Defining global helpers is prohibited
		 * ToDo: Remove this rule after fixing the issue
		 */
		NunoMaduro\PhpInsights\Domain\Insights\ForbiddenDefineFunctions::class,

		/**
		 * Forbidden functions (error_log, print_r for logging)
		 */
		PHP_CodeSniffer\Standards\Generic\Sniffs\PHP\ForbiddenFunctionsSniff::class,

		/**
		 * Return, Property, Parameter  type hint
		 */
		SlevomatCodingStandard\Sniffs\TypeHints\ReturnTypeHintSniff::class,
		SlevomatCodingStandard\Sniffs\TypeHints\PropertyTypeHintSniff::class,
		SlevomatCodingStandard\Sniffs\TypeHints\ParameterTypeHintSniff::class,

		/**
		 * Disallow mixed type hint
		 */
		SlevomatCodingStandard\Sniffs\TypeHints\DisallowMixedTypeHintSniff::class,

		/**
		 * Disallow empty
		 */
		SlevomatCodingStandard\Sniffs\ControlStructures\DisallowEmptySniff::class,

		/**
		 * Forbidden public property
		 */
		SlevomatCodingStandard\Sniffs\Classes\ForbiddenPublicPropertySniff::class,

		/**
		 * Having `classes` with more than 5 cyclomatic complexity is prohibited - Consider refactoring.
		 */
		NunoMaduro\PhpInsights\Domain\Insights\CyclomaticComplexityIsHigh::class,

		/**
		 * Function length
		 */
		SlevomatCodingStandard\Sniffs\Functions\FunctionLengthSniff::class,

		/**
		 * Valid class name, not in PascalCase format.
		 */
		PHP_CodeSniffer\Standards\Squiz\Sniffs\Classes\ValidClassNameSniff::class,

		/**
		 * No spaces around offset.
		 */
		PhpCsFixer\Fixer\Whitespace\NoSpacesAroundOffsetFixer::class,

		/**
		 * Side effects.
		 */
		PHP_CodeSniffer\Standards\PSR1\Sniffs\Files\SideEffectsSniff::class,

		/**
		 * Arbitrary parentheses spacing
		 */
		PHP_CodeSniffer\Standards\Generic\Sniffs\WhiteSpace\ArbitraryParenthesesSpacingSniff::class,

		/**
		 * Character before p h p opening tag
		 */
		PHP_CodeSniffer\Standards\Generic\Sniffs\PHP\CharacterBeforePHPOpeningTagSniff::class,

		/**
		 * Disallow tab indent
		 */
		PHP_CodeSniffer\Standards\Generic\Sniffs\WhiteSpace\DisallowTabIndentSniff::class,

		/**
		 * Line length
		 */
		PHP_CodeSniffer\Standards\Generic\Sniffs\Files\LineLengthSniff::class,

		/**
		 * Binary operator spaces.
		 */
		PhpCsFixer\Fixer\Operator\BinaryOperatorSpacesFixer::class,

		/**
		 * No spaces inside parenthesis
		 */
		PhpCsFixer\Fixer\Whitespace\NoSpacesInsideParenthesisFixer::class,

		/**
		 * No spaces after function name
		 */
		PhpCsFixer\Fixer\FunctionNotation\FunctionDeclarationFixer::class,

		/**
		 * Class definition
		 */
		PhpCsFixer\Fixer\ClassNotation\ClassDefinitionFixer::class,

		/**
		 * Method argument space
		 */
		PhpCsFixer\Fixer\FunctionNotation\MethodArgumentSpaceFixer::class,

		/**
		 * Braces fixer
		 */
		PhpCsFixer\Fixer\Basic\BracesFixer::class,

		/**
		 * Declare strict types.
		 */
		SlevomatCodingStandard\Sniffs\TypeHints\DeclareStrictTypesSniff::class,


		/**
		 * DOC comment spacing
		 */
		SlevomatCodingStandard\Sniffs\Commenting\DocCommentSpacingSniff::class,


		/**
		 * Camel caps method name
		 */
		PHP_CodeSniffer\Standards\PSR1\Sniffs\Methods\CamelCapsMethodNameSniff::class,

		/**
		 * Normal classes are forbidden. Classes must be final or abstract
		 * Todo: Remove this rule after fixing the issue
		 */
		NunoMaduro\PhpInsights\Domain\Insights\ForbiddenNormalClasses::class,

		/**
		 * Void return
		 */
		PhpCsFixer\Fixer\FunctionNotation\VoidReturnFixer::class,

		/**
		 * Disallow Yoda comparison
		 * Conflicts with wordpress coding standards
		 */

		\SlevomatCodingStandard\Sniffs\ControlStructures\DisallowYodaComparisonSniff::class,

		/**
		 * This rule conflicts with wpcs comment rules
		 */
		PhpCsFixer\Fixer\Comment\NoTrailingWhitespaceInCommentFixer::class,


		/**
		 * Since we define global constant
		 */
		NunoMaduro\PhpInsights\Domain\Insights\ForbiddenDefineGlobalConstants::class,

		/**
		 * As we use traits.
		 */
		NunoMaduro\PhpInsights\Domain\Insights\ForbiddenTraits::class,

		/**
		 * WordPress convention uses Abstract_ prefix for abstract classes.
		 */
		SlevomatCodingStandard\Sniffs\Classes\SuperfluousAbstractClassNamingSniff::class,
	],

	'config'       => [
		\SlevomatCodingStandard\Sniffs\Functions\UnusedParameterSniff::class => [

			'exclude' => [
				'inc/blocks/base.php',
			],
		],
	],

	/*
	|--------------------------------------------------------------------------
	| Requirements
	|--------------------------------------------------------------------------
	|
	| Here you may define a level you want to reach per `Insights` category.
	| When a score is lower than the minimum level defined, then an error
	| code will be returned. This is optional and individually defined.
	|
	*/

	'requirements' => [
		'min-quality'            => 95,
		'min-complexity'         => 0,
		'min-architecture'       => 84,
		'min-style'              => 98,
		'disable-security-check' => false,
	],

	/*
	|--------------------------------------------------------------------------
	| Threads
	|--------------------------------------------------------------------------
	|
	| Here you may adjust how many threads (core) PHPInsights can use to perform
	| the analysis. This is optional, don't provide it and the tool will guess
	| the max core number available. It accepts null value or integer > 0.
	|
	*/

	'threads'      => null,

	/*
	|--------------------------------------------------------------------------
	| Timeout
	|--------------------------------------------------------------------------
	| Here you may adjust the timeout (in seconds) for PHPInsights to run before
	| a ProcessTimedOutException is thrown.
	| This accepts an int > 0. Default is 60 seconds, which is the default value
	| of Symfony's setTimeout function.
	|
	*/

	'timeout'      => 60,
];