Runner: allow suppressing "No files were checked" error

Fixes squizlabs/PHP_CodeSniffer#3556

Author: schlndh

src/Config.php

@@ -65,6 +65,7 @@
  * @property string $stdinContent Content passed directly to PHPCS on STDIN.
  * @property string $stdinPath The path to use for content passed on STDIN.
  * @property bool $trackTime Whether or not to track sniff run time.
+ * @property bool $allowEmptyFileList Suppresses "No files were checked" error.
  *
  * @property array<string, string> $extensions File extensions that should be checked, and what tokenizer is used.
  * E.g., array('inc' => 'PHP');
@@ -160,42 +161,43 @@ class Config
  * @var array<string, mixed>
  */
  private $settings = [
- 'files' => null,
- 'standards' => null,
- 'verbosity' => null,
- 'interactive' => null,
- 'parallel' => null,
- 'cache' => null,
- 'cacheFile' => null,
- 'colors' => null,
- 'explain' => null,
- 'local' => null,
- 'showSources' => null,
- 'showProgress' => null,
- 'quiet' => null,
- 'annotations' => null,
- 'tabWidth' => null,
- 'encoding' => null,
- 'extensions' => null,
- 'sniffs' => null,
- 'exclude' => null,
- 'ignored' => null,
- 'reportFile' => null,
- 'generator' => null,
- 'filter' => null,
- 'bootstrap' => null,
- 'reports' => null,
- 'basepath' => null,
- 'reportWidth' => null,
- 'errorSeverity' => null,
- 'warningSeverity' => null,
- 'recordErrors' => null,
- 'suffix' => null,
- 'stdin' => null,
- 'stdinContent' => null,
- 'stdinPath' => null,
- 'trackTime' => null,
- 'unknown' => null,
+ 'files' => null,
+ 'standards' => null,
+ 'verbosity' => null,
+ 'interactive' => null,
+ 'parallel' => null,
+ 'cache' => null,
+ 'cacheFile' => null,
+ 'colors' => null,
+ 'explain' => null,
+ 'local' => null,
+ 'showSources' => null,
+ 'showProgress' => null,
+ 'quiet' => null,
+ 'annotations' => null,
+ 'tabWidth' => null,
+ 'encoding' => null,
+ 'extensions' => null,
+ 'sniffs' => null,
+ 'exclude' => null,
+ 'ignored' => null,
+ 'reportFile' => null,
+ 'generator' => null,
+ 'filter' => null,
+ 'bootstrap' => null,
+ 'reports' => null,
+ 'basepath' => null,
+ 'reportWidth' => null,
+ 'errorSeverity' => null,
+ 'warningSeverity' => null,
+ 'recordErrors' => null,
+ 'suffix' => null,
+ 'stdin' => null,
+ 'stdinContent' => null,
+ 'stdinPath' => null,
+ 'trackTime' => null,
+ 'unknown' => null,
+ 'allowEmptyFileList' => null,
  ];
 
  /**
@@ -581,6 +583,7 @@ public function restoreDefaults()
  $this->stdinPath = null;
  $this->trackTime = false;
  $this->unknown = [];
+ $this->allowEmptyFileList = false;
 
  $standard = self::getConfigData('default_standard');
  if ($standard !== null) {
@@ -828,6 +831,14 @@ public function processLongArgument(string $arg, int $pos)
  $this->annotations = false;
  $this->overriddenDefaults['annotations'] = true;
  break;
+ case 'allow-empty-file-list':
+ if (isset($this->overriddenDefaults['allowEmptyFileList']) === true) {
+ break;
+ }
+
+ $this->allowEmptyFileList = true;
+ $this->overriddenDefaults['allowEmptyFileList'] = true;
+ break;
  case 'config-set':
  if (isset($this->cliArgs[($pos + 1)]) === false
  || isset($this->cliArgs[($pos + 2)]) === false

src/Runner.php

@@ -351,7 +351,7 @@ private function run()
  }
 
  $numFiles = count($todo);
- if ($numFiles === 0) {
+ if ($numFiles === 0 && $this->config->allowEmptyFileList === false) {
  $error = 'ERROR: No files were checked.' . PHP_EOL;
  $error .= 'All specified files were excluded or did not match filtering rules.' . PHP_EOL . PHP_EOL;
  throw new DeepExitException($error, ExitCode::PROCESS_ERROR);

tests/Core/Runner/RunAllFilesExcludedErrorTest.php

@@ -73,6 +73,62 @@ public function testPhpcbf($sourceDir, $extraArgs)
  }
 
 
+ /**
+ * Verify that the "All files were excluded" error message is not shown when all files are excluded and it is
+ * allowed via --allow-empty-file-list (PHPCS).
+ *
+ * @param string $sourceDir The (fixture) directory to scan for files.
+ * @param array<string> $extraArgs Any extra arguments to pass on the command line.
+ *
+ * @dataProvider data
+ *
+ * @return void
+ */
+ public function testPhpcsAllowEmpty($sourceDir, $extraArgs)
+ {
+ if (PHP_CODESNIFFER_CBF === true) {
+ $this->markTestSkipped('This test needs CS mode to run');
+ }
+
+ $extraArgs[] = '--allow-empty-file-list';
+ $this->setupTest($sourceDir, $extraArgs);
+
+ $runner = new Runner();
+ $runner->runPHPCS();
+
+ $regex = '`^(Time: [0-9]+ms; Memory: [0-9\.]+MB' . PHP_EOL . ')?$`';
+ $this->assertStderrOutputMatchesRegex($regex);
+ }
+
+
+ /**
+ * Verify that the "All files were excluded" error message is not shown when all files are excluded and it is
+ * * allowed via --allow-empty-file-list (PHPCBF).
+ *
+ * @param string $sourceDir The (fixture) directory to scan for files.
+ * @param array<string> $extraArgs Any extra arguments to pass on the command line.
+ *
+ * @dataProvider data
+ * @group CBF
+ *
+ * @return void
+ */
+ public function testPhpcbfAllowEmpty($sourceDir, $extraArgs)
+ {
+ if (PHP_CODESNIFFER_CBF === false) {
+ $this->markTestSkipped('This test needs CBF mode to run');
+ }
+
+ $extraArgs[] = '--allow-empty-file-list';
+ $this->setupTest($sourceDir, $extraArgs);
+
+ $runner = new Runner();
+ $runner->runPHPCBF();
+
+ $this->assertStderrOutputSameString('');
+ }
+
+
  /**
  * Data provider.
  *