Restructured PHPCS Integration (#39)

Since PHPCS can't reliably detect the FQN of the report class, I've
restructured the PHPCS integration so that it will ensure only a
single class file is ever loaded when including the report.
This will ensure we always load the correct report file.

This commit also comes with some changes to the build process.
We don't need to reference the report files anymore, since we aren't
going to require Webpack to compile the assets to find the reports.

.eslintrc.json

@@ -14,9 +14,9 @@
         "plugin:prettier/recommended"
     ],
     "ignorePatterns": [
-        "/dist/",
         "/node_modules/",
-        "webpack.config.js"
+        "webpack.config.js",
+        "extension.js"
     ],
     "rules": {
         "@typescript-eslint/no-unused-vars": "off",

.gitignore

@@ -7,9 +7,9 @@
 !.vscode/tasks.json
 
 # Build Artifacts
-out/
-dist/
 *.vsix
+extension.js
+extension.js.map
 
 # Dependencies
 node_modules/

.vscode/launch.json

@@ -8,7 +8,8 @@
                 "--extensionDevelopmentPath=${workspaceFolder}"
             ],
             "outFiles": [
-                "${workspaceFolder}/dist/**/*.js"
+                "${workspaceFolder}/extension.js",
+                "${workspaceFolder}/assets/**/*.php"
             ],
             "preLaunchTask": "${defaultBuildTask}"
         }

.vscodeignore

@@ -2,11 +2,9 @@
 .github/
 node_modules/
 vendor/
-out/
 src/
-phpcs-reports/
 .eslintrc.json
-jest.config.js
+jest.config.json
 tsconfig.json
 webpack.config.js
 composer.json

CHANGELOG.md

@@ -5,6 +5,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
 ## [Unreleased]
+### Fixed
+- Broken PHPCS integration due to inconsistent class loading behavior.
 
 ## [1.4.0] - 2021-08-13
 ### Added

phpcs-reports/includes/VSCodeFile.php → assets/phpcs-integration/Extension/File.php

@@ -1,17 +1,17 @@
 <?php
 
-namespace VSCode\PHP_CodeSniffer;
+namespace VSCode\PHP_CodeSniffer\Extension;
 
-use PHP_CodeSniffer\Files\File;
+use PHP_CodeSniffer\Files\File as BaseFile;
 use PHP_CodeSniffer\Sniffs\Sniff;
 
 /**
  * A class that supports targeting specific tokens for fixes to allow for
  * tracking the edits that should be created by a single
  *
- * @property Fixer|VSCodeFixer $fixer
+ * @property \VSCode\PHP_CodeSniffer\Extension\Fixer $fixer
  */
-class VSCodeFile extends File
+class File extends BaseFile
 {
     /**
      * A map containing the token pointers indexed by [line][column].
@@ -51,9 +51,9 @@ class VSCodeFile extends File
     /**
      * Constructs an instance from an existing file.
      *
-     * @param File $phpcsFile The file to use.
+     * @param BaseFile $phpcsFile The file to use.
      */
-    public function __construct(File $phpcsFile)
+    public function __construct(BaseFile $phpcsFile)
     {
         // Populate from the original file.
         $this->content = $phpcsFile->content;
@@ -78,9 +78,9 @@ public function parse()
     /**
      * Gets the stack pointer for a position.
      *
-     * @param int $line The line to check.
-     * @param int $column The column to check.
-     * @param bool $useRangeFormat Indicates we should find the VS Code range format.
+     * @param  int  $line           The line to check.
+     * @param  int  $column         The column to check.
+     * @param  bool $useRangeFormat Indicates we should find the VS Code range format.
      * @return int|null
      */
     public function getStackPtrForPosition($line, $column, $useRangeFormat = false)
@@ -103,7 +103,7 @@ public function getStackPtrForPosition($line, $column, $useRangeFormat = false)
     /**
      * Gets a specific token.
      *
-     * @param int $stackPtr The token pointer to fetch.
+     * @param  int $stackPtr The token pointer to fetch.
      * @return array
      */
     public function getToken($stackPtr)
@@ -114,8 +114,8 @@ public function getToken($stackPtr)
     /**
      * Formats a document range and returns the changed content as a result.
      *
-     * @param int|null $startToken The token to start formatting from.
-     * @param int|null $endToken The token to end formatting on.
+     * @param  int|null $startToken The token to start formatting from.
+     * @param  int|null $endToken   The token to end formatting on.
      * @return string
      */
     public function formatRange($startToken, $endToken)
@@ -138,8 +138,8 @@ public function formatRange($startToken, $endToken)
     /**
      * Fixes a single code action and returns the content changed as a result.
      *
-     * @param int $sourceStackPtr The position we want to fix.
-     * @param source $source The problem we want to fix.
+     * @param  int    $sourceStackPtr The position we want to fix.
+     * @param  string $source         The problem we want to fix.
      * @return array
      */
     public function fixCodeAction($sourceStackPtr, $source)
@@ -156,7 +156,7 @@ public function fixCodeAction($sourceStackPtr, $source)
         // Replace the fixer with a custom one that can give us insight into
         // the specific tokens that have been replaced.
         $fixer = $this->fixer;
-        $this->fixer = new VSCodeFixer();
+        $this->fixer = new Fixer();
         $this->fixer->enabled = true;
         $this->fixer->startFile($this);
 
@@ -297,7 +297,7 @@ private function prepareTokensForVSCode()
     /**
      * Fetches the sniff class instance for the given message source.
      *
-     * @param string $source
+     * @param  string $source
      * @return Sniff|null
      */
     private function getSniffFromMessageSource($source)
@@ -316,7 +316,7 @@ private function getSniffFromMessageSource($source)
     /**
      * Takes an array of changed tokens and merged contiguous blocks into text edits.
      *
-     * @param array $changedTokens All of the tokens that changed.
+     * @param  array $changedTokens All of the tokens that changed.
      * @return array
      */
     private function getTextEdits($changedTokens)

phpcs-reports/includes/VSCodeFixer.php → assets/phpcs-integration/Extension/Fixer.php

@@ -1,13 +1,13 @@
 <?php
 
-namespace VSCode\PHP_CodeSniffer;
+namespace VSCode\PHP_CodeSniffer\Extension;
 
-use PHP_CodeSniffer\Fixer;
+use PHP_CodeSniffer\Fixer as BaseFixer;
 
 /**
- * An override of the fixer that we can use to track the changes that sniffs make to the file.
+ * An extension of the fixer that we can use to track the changes that sniffs make to the file.
  */
-class VSCodeFixer extends Fixer
+class Fixer extends BaseFixer
 {
     /**
      * Indicates whether or not the text edit is in a changeset.

phpcs-reports/CodeAction.php → assets/phpcs-integration/Handlers/CodeAction.php

@@ -1,28 +1,24 @@
 <?php
 
-namespace VSCode\PHP_CodeSniffer\Reports;
+namespace VSCode\PHP_CodeSniffer\Handlers;
 
-use VSCode\PHP_CodeSniffer\VSCodeFile;
-
-// @phpcs:disable
-require_once __DIR__ . DIRECTORY_SEPARATOR . 'includes' . DIRECTORY_SEPARATOR . 'VSCodeReport.php';
-// @phpcs:enable
+use VSCode\PHP_CodeSniffer\Extension\File;
 
 /**
- * A custom report for returning information about edits from PHPCS in a way
+ * A handler for returning information about edits from PHPCS in a way
  * that the extension can easily consume.
  */
-class CodeAction extends VSCodeReport
+class CodeAction implements Handler
 {
     /**
      * Executes the actual PHPCS report.
      *
-     * @param array $report The PHPCS report.
-     * @param VSCodeFile $file The file we're reporting on.
-     * @param stdClass|null $data The data object passed from VS Code.
+     * @param  array         $report The PHPCS report.
+     * @param  File          $file   The file we're reporting on.
+     * @param  stdClass|null $data   The data object passed from VS Code.
      * @return bool True if we have processed the file, otherwise false.
      */
-    protected function executeReport($report, VSCodeFile $file, $data)
+    public function execute($report, File $file, $data)
     {
         // Get information about the problem we want to fix.
         $problemSource = $data->code;

phpcs-reports/Diagnostic.php → assets/phpcs-integration/Handlers/Diagnostic.php

@@ -1,28 +1,24 @@
 <?php
 
-namespace VSCode\PHP_CodeSniffer\Reports;
+namespace VSCode\PHP_CodeSniffer\Handlers;
 
-use VSCode\PHP_CodeSniffer\VSCodeFile;
-
-// @phpcs:disable
-require_once __DIR__ . DIRECTORY_SEPARATOR . 'includes' . DIRECTORY_SEPARATOR . 'VSCodeReport.php';
-// @phpcs:enable
+use VSCode\PHP_CodeSniffer\Extension\File;
 
 /**
- * A custom report for returning information from PHPCS in a way that the
+ * A handler for returning information from PHPCS in a way that the
  * extension can more easily consume.
  */
-class Diagnostic extends VSCodeReport
+class Diagnostic implements Handler
 {
     /**
      * Executes the actual PHPCS report.
      *
-     * @param array $report The PHPCS report.
-     * @param VSCodeFile $file The file we're reporting on.
-     * @param stdClass|null $data The data object passed from VS Code.
+     * @param  array         $report The PHPCS report.
+     * @param  File          $file   The file we're reporting on.
+     * @param  stdClass|null $data   The data object passed from VS Code.
      * @return bool True if we have processed the file, otherwise false.
      */
-    protected function executeReport($report, VSCodeFile $file, $data)
+    public function execute($report, File $file, $data)
     {
         $diagnostics = array();
         $codeActions = array();

phpcs-reports/Format.php → assets/phpcs-integration/Handlers/Format.php

@@ -1,27 +1,23 @@
 <?php
 
-namespace VSCode\PHP_CodeSniffer\Reports;
+namespace VSCode\PHP_CodeSniffer\Handlers;
 
-use VSCode\PHP_CodeSniffer\VSCodeFile;
-
-// @phpcs:disable
-require_once __DIR__ . DIRECTORY_SEPARATOR . 'includes' . DIRECTORY_SEPARATOR . 'VSCodeReport.php';
-// @phpcs:enable
+use VSCode\PHP_CodeSniffer\Extension\File;
 
 /**
- * A custom report for formatting a document or range within a document.
+ * A handler for formatting a document or range within a document.
  */
-class Format extends VSCodeReport
+class Format implements Handler
 {
     /**
      * Executes the actual PHPCS report.
      *
-     * @param array $report The PHPCS report.
-     * @param VSCodeFile $file The file we're reporting on.
-     * @param stdClass|null $data The data object passed from VS Code.
+     * @param  array         $report The PHPCS report.
+     * @param  File          $file   The file we're reporting on.
+     * @param  stdClass|null $data   The data object passed from VS Code.
      * @return bool True if we have processed the file, otherwise false.
      */
-    protected function executeReport($report, VSCodeFile $file, $data)
+    public function execute($report, File $file, $data)
     {
         // Apply the formatting restriction if one is given.
         $startToken = null;

assets/phpcs-integration/Handlers/Handler.php

@@ -0,0 +1,21 @@
+<?php
+
+namespace VSCode\PHP_CodeSniffer\Handlers;
+
+use VSCode\PHP_CodeSniffer\Extension\File;
+
+/**
+ * The interface for all PHPCS handlers.
+ */
+interface Handler
+{
+    /**
+     * Executes a handler.
+     *
+     * @param  array      $report The PHPCS report we're processing.
+     * @param  File       $file   The file we're reporting on.
+     * @param  array|null $data   The data object passed from VS Code.
+     * @return bool True if we have processed the file, otherwise false.
+     */
+    public function execute($report, File $file, $data);
+}