Gitblame: fix fatal error on chdir() when basepath is set and phpcs is run from subdir
#3855
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
…cs is run from subdir The `Reporter::prepareFileReport()` method strips the `basepath` off the file name for the `$report['filename']`. https://github.com/squizlabs/PHP_CodeSniffer/blob/276f68cc74a3e4e1855bab6d01f0089337d00ae0/src/Reporter.php#L337 While this is fine in most cases, for "blame" reports, the full path is needed. This changes the path passed to the `getBlameContent()` method in subclasses of the `VersionControl` class to the full path, which fixes the fatal error for the `Gitblame` report (and probably similar/related errors in the `Hgblame` and the `Svnblame` reports, but I don't have any repos to test this on). Fixes 3854
This was referenced Jul 13, 2023
1 task
|
Closing as replaced by PHPCSStandards/PHP_CodeSniffer#67 |
jrfnl
deleted the
feature/reports-gitblame-fix-fatal-error-subdir-basepath
branch
|
FYI: this fix is included in today's PHP_CodeSniffer 3.8.0 release. As per #3932, development on PHP_CodeSniffer will continue in the PHPCSStandards/PHP_CodeSniffer repository. If you want to stay informed, you may want to start "watching" that repo (or watching releases from that repo). |
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.
Description
The
Reporter::prepareFileReport()method strips thebasepathoff the file name for the$report['filename'].PHP_CodeSniffer/src/Reporter.php
Line 337 in 276f68c
While this is fine in most cases, for "blame" reports, the full path is needed.
This changes the path passed to the
getBlameContent()method in subclasses of theVersionControlclass to the full path, which fixes the fatal error for theGitblamereport (and probably similar/related errors in theHgblameand theSvnblamereports, but I don't have any repos to test this on).Suggested changelog entry
Fixed bug #3854 : Fatal error when using Gitblame report in combination with basepath and running from project subdirectory
Related issues/external references
Fixes #3854
Loosely related to #3809
Types of changes