Merge remote-tracking branch 'upstream/master' into feature/improve-sniff-code-error-message

Author: fredden

.github/ISSUE_TEMPLATE/bug_report.md

@@ -66,5 +66,6 @@ Add any other context about the problem here.
 ## Please confirm
 
 - [ ] I have searched the issue list and am not opening a duplicate issue.
+- [ ] I have read the [Contribution Guidelines](https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/.github/CONTRIBUTING.md) and this is not a [support question](https://github.com/PHPCSStandards/PHP_CodeSniffer/discussions).
 - [ ] I confirm that this bug is a bug in PHP_CodeSniffer and not in one of the external standards.
 - [ ] I have verified the issue still exists in the `master` branch of PHP_CodeSniffer.

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: true
+contact_links:
+  - name: Community Support
+    url: https://github.com/PHPCSStandards/PHP_CodeSniffer/discussions?discussions_q=-category%3AAnnouncements
+    about: Support questions belong in Discussions, not in the issue tracker.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -21,4 +21,5 @@ code samples of what should *not* be flagged.
 ## Additional context (optional)
 <!-- Add any other context or screenshots about the feature request here. -->
 
+- [ ] I have read the [Contribution Guidelines](https://github.com/PHPCSStandards/PHP_CodeSniffer/blob/master/.github/CONTRIBUTING.md) and this is not a [support question](https://github.com/PHPCSStandards/PHP_CodeSniffer/discussions).
 - [ ] I intend to create a pull request to implement this feature.

.github/workflows/label-merge-conflicts.yml

@@ -5,6 +5,7 @@ on:
   push:
     branches:
       - master
+      - 4.0
   # Check conflicts in new PRs and for resolved conflicts due to an open PR being updated.
   pull_request_target:
     types:
@@ -20,7 +21,8 @@ jobs:
     name: Check PRs for merge conflicts
 
     steps:
-      - uses: mschilde/auto-label-merge-conflicts@master
+      - name: Check PRs for merge conflicts
+        uses: eps1lon/actions-label-merge-conflict@v3
         with:
-          CONFLICT_LABEL_NAME: "Status: has merge conflict"
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          dirtyLabel: "Status: has merge conflict"
+          repoToken: ${{ secrets.GITHUB_TOKEN }}

src/Config.php

@@ -1556,7 +1556,7 @@ public static function setConfigData($key, $value, $temp=false)
         // standards paths are added to the autoloader.
         if ($key === 'installed_paths') {
             $installedStandards = Standards::getInstalledStandardDetails();
-            foreach ($installedStandards as $name => $details) {
+            foreach ($installedStandards as $details) {
                 Autoload::addSearchPath($details['path'], $details['namespace']);
             }
         }

src/Filters/Filter.php

@@ -179,7 +179,7 @@ protected function shouldProcessFile($path)
         // complete extension list and make sure one is allowed.
         $extensions = [];
         array_shift($fileParts);
-        foreach ($fileParts as $part) {
+        while (empty($fileParts) === false) {
             $extensions[implode('.', $fileParts)] = 1;
             array_shift($fileParts);
         }

src/Reporter.php

@@ -329,7 +329,29 @@ public function cacheFileReport(File $phpcsFile)
      *
      * @param \PHP_CodeSniffer\Files\File $phpcsFile The file that has been processed.
      *
-     * @return array
+     * @return array<string, string|int|array> Prepared report data.
+     *                                         The format of prepared data is as follows:
+     *                                         ```
+     *                                         array(
+     *                                           'filename' => string The name of the current file.
+     *                                           'errors'   => int    The number of errors seen in the current file.
+     *                                           'warnings' => int    The number of warnings seen in the current file.
+     *                                           'fixable'  => int    The number of fixable issues seen in the current file.
+     *                                           'messages' => array(
+     *                                             int <Line number> => array(
+     *                                               int <Column number> => array(
+     *                                                 int <Message index> => array(
+     *                                                   'message'  => string The error/warning message.
+     *                                                   'source'   => string The full error code for the message.
+     *                                                   'severity' => int    The severity of the message.
+     *                                                   'fixable'  => bool   Whether this error/warning is auto-fixable.
+     *                                                   'type'     => string The type of message. Either 'ERROR' or 'WARNING'.
+     *                                                 )
+     *                                               )
+     *                                             )
+     *                                           )
+     *                                         )
+     *                                         ```
      */
     public function prepareFileReport(File $phpcsFile)
     {

src/Reports/Cbf.php

@@ -28,10 +28,11 @@ class Cbf implements Report
      * and FALSE if it ignored the file. Returning TRUE indicates that the file and
      * its data should be counted in the grand totals.
      *
-     * @param array                       $report      Prepared report data.
-     * @param \PHP_CodeSniffer\Files\File $phpcsFile   The file being reported on.
-     * @param bool                        $showSources Show sources?
-     * @param int                         $width       Maximum allowed line width.
+     * @param array<string, string|int|array> $report      Prepared report data.
+     *                                                     See the {@see Report} interface for a detailed specification.
+     * @param \PHP_CodeSniffer\Files\File     $phpcsFile   The file being reported on.
+     * @param bool                            $showSources Show sources?
+     * @param int                             $width       Maximum allowed line width.
      *
      * @return bool
      * @throws \PHP_CodeSniffer\Exceptions\DeepExitException

src/Reports/Checkstyle.php

@@ -24,10 +24,11 @@ class Checkstyle implements Report
      * and FALSE if it ignored the file. Returning TRUE indicates that the file and
      * its data should be counted in the grand totals.
      *
-     * @param array                       $report      Prepared report data.
-     * @param \PHP_CodeSniffer\Files\File $phpcsFile   The file being reported on.
-     * @param bool                        $showSources Show sources?
-     * @param int                         $width       Maximum allowed line width.
+     * @param array<string, string|int|array> $report      Prepared report data.
+     *                                                     See the {@see Report} interface for a detailed specification.
+     * @param \PHP_CodeSniffer\Files\File     $phpcsFile   The file being reported on.
+     * @param bool                            $showSources Show sources?
+     * @param int                             $width       Maximum allowed line width.
      *
      * @return bool
      */

src/Reports/Code.php

@@ -25,10 +25,11 @@ class Code implements Report
      * and FALSE if it ignored the file. Returning TRUE indicates that the file and
      * its data should be counted in the grand totals.
      *
-     * @param array                       $report      Prepared report data.
-     * @param \PHP_CodeSniffer\Files\File $phpcsFile   The file being reported on.
-     * @param bool                        $showSources Show sources?
-     * @param int                         $width       Maximum allowed line width.
+     * @param array<string, string|int|array> $report      Prepared report data.
+     *                                                     See the {@see Report} interface for a detailed specification.
+     * @param \PHP_CodeSniffer\Files\File     $phpcsFile   The file being reported on.
+     * @param bool                            $showSources Show sources?
+     * @param int                             $width       Maximum allowed line width.
      *
      * @return bool
      */
@@ -121,8 +122,8 @@ public function generateFileReport($report, File $phpcsFile, $showSources=false,
 
         // Determine the longest error message we will be showing.
         $maxErrorLength = 0;
-        foreach ($report['messages'] as $line => $lineErrors) {
-            foreach ($lineErrors as $column => $colErrors) {
+        foreach ($report['messages'] as $lineErrors) {
+            foreach ($lineErrors as $colErrors) {
                 foreach ($colErrors as $error) {
                     $length = strlen($error['message']);
                     if ($showSources === true) {
@@ -264,7 +265,7 @@ public function generateFileReport($report, File $phpcsFile, $showSources=false,
 
             echo str_repeat('-', $width).PHP_EOL;
 
-            foreach ($lineErrors as $column => $colErrors) {
+            foreach ($lineErrors as $colErrors) {
                 foreach ($colErrors as $error) {
                     $padding = ($maxLineNumLength - strlen($line));
                     echo 'LINE '.str_repeat(' ', $padding).$line.': ';