{"id":13607779,"url":"https://github.com/sidz/phpstan-rules","last_synced_at":"2025-04-14T16:41:47.236Z","repository":{"id":152264093,"uuid":"625638481","full_name":"sidz/phpstan-rules","owner":"sidz","description":"Additional rules for phpstan/phpstan. ","archived":false,"fork":false,"pushed_at":"2024-03-24T08:18:46.000Z","size":45,"stargazers_count":25,"open_issues_count":0,"forks_count":4,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-04-24T16:04:43.801Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sidz.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-04-09T18:21:00.000Z","updated_at":"2024-06-11T01:53:56.901Z","dependencies_parsed_at":null,"dependency_job_id":"63d66b57-a2e0-4989-82c9-dc3079319c27","html_url":"https://github.com/sidz/phpstan-rules","commit_stats":null,"previous_names":[],"tags_count":9,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sidz%2Fphpstan-rules","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sidz%2Fphpstan-rules/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sidz%2Fphpstan-rules/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sidz%2Fphpstan-rules/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sidz","download_url":"https://codeload.github.com/sidz/phpstan-rules/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248918263,"owners_count":21183153,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-01T19:01:21.536Z","updated_at":"2025-04-14T16:41:47.215Z","avatar_url":"https://github.com/sidz.png","language":"PHP","readme":"# phpstan-rules\n\n[![Continuous Integration](https://github.com/sidz/phpstan-rules/workflows/Continuous%20Integration/badge.svg)](https://github.com/sidz/phpstan-rules/actions)\n\nProvides additional rules for [`phpstan/phpstan`](https://github.com/phpstan/phpstan).\n\n## Installation\n\nRun\n\n```sh\ncomposer require --dev sidz/phpstan-rules\n```\n\nIf you use [PHPStan extension installer](https://github.com/phpstan/extension-installer), you're all set. If not, you need to manually register all the rules in your `phpstan.neon`:\n\n```neon\nincludes:\n    - vendor/sidz/phpstan-rules/rules.neon\n```\n\nEach rule by default ignores the following numbers: `0` and `1`. This can be configured by adding the following parameter to your `phpstan.neon`:\n\n```neon\nparameters:\n\tsidzIgnoreMagicNumbers: [0, 1, 100]\n```\n\nEach rule by default detects numeric strings like `'12'` in source code. This behavior could be disabled via parameter:\n\n```neon\nparameters:\n\tsidzIgnoreNumericStrings: true\n```\n\n## Ignoring particular rules\n\nIf you need to ignore particular rule, for example `NoMagicNumberInComparisonOperatorRule`, you can do so by using built-in `ignoreErrors` parameter:\n\n```neon\nparameters:\n    ignoreErrors:\n        - '#^Do not use magic number in comparison operations\\. Move to constant with a suitable name\\.$#'\n```\n\nIf you need to ignore this rule only for particular file or folder, this also can be done by using `ignoreErrors` parameter:\n\n```neon\nparameters:\n    ignoreErrors:\n        -\n            message: '#^Do not use magic number in comparison operations\\. Move to constant with a suitable name\\.$#'\n            path: src/SomeFolder/*\n```\n\nAnd finally, if you want to ignore all the rules from this package for particular files or folders, add this to `phpstan.neon`:\n\n```neon\nparameters:\n    ignoreErrors:\n        -\n            message: '#Do not (use|return|assign) magic number (.)#'\n            paths:\n                - src/DataFixtures/*\n                - tests/*\n```\n\n## Rules\n\nThis package provides the following rules for use with [`phpstan/phpstan`](https://github.com/phpstan/phpstan):\n\n- [`Sid\\PHPStan\\Rules\\MagicNumber\\NoMagicNumberAsFunctionArgumentRule`](https://github.com/sidz/phpstan-rules#magicnumbernomagicnumberasfunctionargumentrule)\n- [`Sid\\PHPStan\\Rules\\MagicNumber\\NoMagicNumberAssignedToPropertyRule`](https://github.com/sidz/phpstan-rules#magicnumbernomagicnumberassignedtopropertyrule)\n- [`Sid\\PHPStan\\Rules\\MagicNumber\\NoMagicNumberInArithmeticOperatorRule`](https://github.com/sidz/phpstan-rules#magicnumbernomagicnumberinarithmeticoperatorrule)\n- [`Sid\\PHPStan\\Rules\\MagicNumber\\NoMagicNumberInBitwiseOperatorRule`](https://github.com/sidz/phpstan-rules#magicnumbernomagicnumberinbitwiseoperatorrule)\n- [`Sid\\PHPStan\\Rules\\MagicNumber\\NoMagicNumberInComparisonOperatorRule`](https://github.com/sidz/phpstan-rules#magicnumbernomagicnumberincomparisonoperatorrule)\n- [`Sid\\PHPStan\\Rules\\MagicNumber\\NoMagicNumberInDefaultParameterRule`](https://github.com/sidz/phpstan-rules#magicnumbernomagicnumberindefaultparameterrule)\n- [`Sid\\PHPStan\\Rules\\MagicNumber\\NoMagicNumberInLogicalOperatorRule`](https://github.com/sidz/phpstan-rules#magicnumbernomagicnumberinlogicaloperatorrule)\n- [`Sid\\PHPStan\\Rules\\MagicNumber\\NoMagicNumberInMatchRule`](https://github.com/sidz/phpstan-rules#magicnumbernomagicnumberinmatchrule)\n- [`Sid\\PHPStan\\Rules\\MagicNumber\\NoMagicNumberInReturnStatementRule`](https://github.com/sidz/phpstan-rules#magicnumbernomagicnumberinreturnstatementrule)\n- [`Sid\\PHPStan\\Rules\\MagicNumber\\NoMagicNumberInSwitchCaseRule`](https://github.com/sidz/phpstan-rules#magicnumbernomagicnumberinswitchcaserule)\n- [`Sid\\PHPStan\\Rules\\MagicNumber\\NoMagicNumberInTernaryOperatorRule`](https://github.com/sidz/phpstan-rules#magicnumbernomagicnumberinternaryoperatorrule)\n- [`Sid\\PHPStan\\Rules\\MagicNumber\\NoMagicNumberVariableAssignmentRule`](https://github.com/sidz/phpstan-rules#magicnumbernomagicnumbervariableassignmentrule)\n\n\n### Classes\n\n#### `MagicNumber\\NoMagicNumberAsFunctionArgumentRule`\n\nThis rule reports an error when magic number is used as function argument:\n\n```php\n\u003c?php\n\nsome_function(10);\n```\n\n#### `MagicNumber\\NoMagicNumberAssignedToPropertyRule`\n\nThis rule reports an error when magic number is assigned to class property:\n\n```php\n\u003c?php\n\nclass Test\n{\n    private $prop1 = 10;\n\n    private $prop2 = -5.5;\n}\n```\n\n#### `MagicNumber\\NoMagicNumberInArithmeticOperatorRule`\n\nThis rule reports an error when magic number is used in various arithmetic operators:\n\n```php\n\u003c?php\n\n$var1 + 2;\n\n$var2 - .3;\n\n$var3 * 2.2;\n\n$var4 / 2;\n\n$var5 % 1000;\n\n$var6 ** 2;\n\n2 + $var1;\n\n1.1 - $var2;\n\n2 * $var3;\n\n-2 / $var4;\n\n1000 % $var5;\n```\n\n#### `MagicNumber\\NoMagicNumberInBitwiseOperatorRule`\n\nThis rule reports an error when magic number is used in various bitwise operators:\n\n```php\n\u003c?php\n\n$a \u0026 1;\n\n$b | 2;\n\n$c ^ 3;\n\n$a \u003c\u003c 4;\n\n$b \u003e\u003e 5;\n\n1 \u0026 $a;\n\n2 | $b;\n\n3 ^ $c;\n\n4 \u003c\u003c $a;\n\n5 \u003e\u003e $b;\n\n6 \u003e\u003e 7;\n```\n\n#### `MagicNumber\\NoMagicNumberInComparisonOperatorRule`\n\nThis rule reports an error when magic number is used in comparison operator:\n\n```php\n\u003c?php\n\n$var1 === 1;\n\n$var2 !== 2;\n\n$var3 !== 3;\n\n$var4 === 4.4;\n\n$var5 !== -5;\n\n$var6 \u003c 6;\n\n$var7 \u003c= 7;\n\n$var8 \u003e .8;\n\n$var9 \u003e= 9;\n\n$var10 \u003c=\u003e 0.1;\n\n$var11 === 11;\n```\n\n#### `MagicNumber\\NoMagicNumberInDefaultParameterRule`\n\nThis rule reports an error when magic number is used as default parameter:\n\n```php\n\u003c?php\n\nclass Test\n{\n    public function testMethod($param = 3): string\n    {\n        return 'string';\n    }\n}\n```\n\n#### `MagicNumber\\NoMagicNumberInLogicalOperatorRule`\n\nThis rule reports an error when magic number is used as part of logical operation:\n\n```php\n\u003c?php\n\n$a and 1;\n\n1 and $a;\n\n$b or 2;\n\n2 or $b;\n\n$c xor 3;\n\n3 xor $c;\n```\n\n#### `MagicNumber\\NoMagicNumberInMatchRule`\n\nThis rule reports an error when magic number is used in arms or conditions:\n\n```php\n\u003c?php\n\nmatch (3) {\n    1 =\u003e 'Hi',\n    2, 4 =\u003e 'There',\n    default =\u003e throw new LogicException(),\n};\n```\n\n#### `MagicNumber\\NoMagicNumberInReturnStatementRule`\n\nThis rule reports an error when magic number is used in `return` statement:\n\n```php\n\u003c?php\n\nclass Test\n{\n\n    public function getNegativeValue(): float\n    {\n        return -20.5;\n    }\n}\n```\n\n#### `MagicNumber\\NoMagicNumberInSwitchCaseRule`\n\nThis rule reports an error when magic number is used in condition or cases:\n\n```php\n\u003c?php\n\nswitch (100) {\n    case 5:\n        break;\n}\n```\n\n#### `MagicNumber\\NoMagicNumberInTernaryOperatorRule`\n\nThis rule reports an error when magic number is used in ternary operator:\n\n```php\n\u003c?php\n\n$a = $b ? 2 : 'string';\n\n$c = $b ?: -3.5;\n\n$d = $b ? 'string' : 6;\n```\n\n#### `MagicNumber\\NoMagicNumberVariableAssignmentRule`\n\nThis rule reports an error when magic number is assigned to some variable:\n\n```php\n\u003c?php\n\n$var1 = 4;\n\n$var2 = -2;\n\nfunction test_func($var4 = 3): void\n{\n    $var5 = 0;\n}\n\n$var6 = .1;\n\n$var7 = 3.5;\n\n$var8 = -2.3;\n```\n\n## License\n\nThis package is licensed using the MIT License.\n\nPlease have a look at [`LICENSE.md`](LICENSE.md).\n","funding_links":[],"categories":["PHP"],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsidz%2Fphpstan-rules","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsidz%2Fphpstan-rules","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsidz%2Fphpstan-rules/lists"}