✨ New Modernize.FunctionCalls.Dirname sniff #172
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Includes updating CI and other dev related files to take the new standard into account.
dingo-d
approved these changes
Dec 2, 2022
This new sniff will detect and, when possible, auto-fix two typical code modernizations which can be made related to the `dirname()` function:
1. Since PHP 5.3, calls to `dirname(__FILE__)` can be replaced by `__DIR__`.
Errorcode: `Modernize.FunctionCalls.Dirname.FileConstant`.
2. Since PHP 7.0, nested function calls to `dirname()` can be changed to use the new `$levels` parameter.
Errorcode: `Modernize.FunctionCalls.Dirname.Nested`.
Depending on supported PHP versions of an application, the complete sniff can be enabled and/or just one of the error codes could be enabled.
**Regarding the fixers:**
The sniff - and more importantly, the fixer - take fully qualified function calls, named parameters, as well as trailing comma's in function calls into account.
* If a comment is found in any of the code which would be removed by the fixer, the issues will still be flagged, but not be marked as fixable.
* If the value of a pre-existing `$levels` parameter cannot be determined, the issues will still be flagged, but not be marked as fixable.
Also take note that the fixer does not make any presumptions about the code style of the project. It is recommended to run the code style fixers together with or after this fixer, so those can adjust the code style to the style applicable in the project.
Includes fixer.
Includes unit tests.
Includes documentation.
Notes/Future scope:
* The sniff is not yet compatible with PHPCS 4.x.
* When PHPCSUtils releases its own abstract for sniffing function calls, this sniff should switch to it.
Refs:
* https://www.php.net/manual/en/function.dirname.php
* PHP 5.3: https://php-legacy-docs.zend.com/manual/php5/en/migration53.global-constants
* PHp 7.0: https://www.php.net/manual/en/migration70.changed-functions.php#migration70.changed-functions.core
Note: the parameter was originally called `$depth`, but has since been renamed to `$levels`.
jrfnl
force-pushed
the
universal/new-modernize-dirname-file-sniff
branch
from
bd72ba2
to
1d3943d
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Introduce new Modernize standard
Includes updating CI and other dev related files to take the new standard into account.
P.S.: By rights, this should be a separate standard in the PHPCompatibility organisation, but that's for later. For now, I just want to make sure this sniff becomes available.
✨ New Modernize.FunctionCalls.Dirname sniff
This new sniff will detect and, when possible, auto-fix two typical code modernizations which can be made related to the
dirname()function:dirname(__FILE__)can be replaced by__DIR__.Errorcode:
Modernize.FunctionCalls.Dirname.FileConstant.dirname()can be changed to use the new$levelsparameter.Errorcode:
Modernize.FunctionCalls.Dirname.Nested.Depending on supported PHP versions of an application, the complete sniff can be enabled and/or just one of the error codes could be enabled.
Regarding the fixers:
The sniff - and more importantly, the fixer - take fully qualified function calls, named parameters, as well as trailing comma's in function calls into account.
$levelsparameter cannot be determined, the issues will still be flagged, but not be marked as fixable.Also take note that the fixer does not make any presumptions about the code style of the project. It is recommended to run the code style fixers together with or after this fixer, so those can adjust the code style to the style applicable in the project.
Includes fixer.
Includes unit tests.
Includes documentation.
Notes/Future scope:
Refs:
Note: the parameter was originally called
$depth, but has since been renamed to$levels.