fix(CoreVersionRequirement): Ensure sniff is only run on project info.yml files (#3133361 by Arkener)

Author: arkener

coder_sniffer/DrupalPractice/Sniffs/InfoFiles/CoreVersionRequirementSniff.php

@@ -49,11 +49,18 @@ public function register()
  */
  public function process(File $phpcsFile, $stackPtr)
  {
- $fileExtension = strtolower(substr($phpcsFile->getFilename(), -9));
+ $filename = $phpcsFile->getFilename();
+ $fileExtension = strtolower(substr($filename, -9));
  if ($fileExtension !== '.info.yml') {
  return ($phpcsFile->numTokens + 1);
  }
 
+ // Exclude config files which might contain the info.yml extension.
+ $filenameWithoutExtension = substr($filename, 0, -9);
+ if (strpos($filenameWithoutExtension, '.') !== false) {
+ return ($phpcsFile->numTokens + 1);
+ }
+
  $contents = file_get_contents($phpcsFile->getFilename());
  try {
  $info = Yaml::parse($contents);
@@ -62,6 +69,11 @@ public function process(File $phpcsFile, $stackPtr)
  return ($phpcsFile->numTokens + 1);
  }
 
+ // Check if the type key is set, to verify if we're inside a project info.yml file.
+ if (isset($info['type']) === false) {
+ return ($phpcsFile->numTokens + 1);
+ }
+
  // Test modules can omit the core_version_requirement key.
  if (isset($info['package']) === true && $info['package'] === 'Testing') {
  return ($phpcsFile->numTokens + 1);

coder_sniffer/DrupalPractice/Test/InfoFiles/CoreVersionRequirementUnitTest.php

@@ -61,6 +61,7 @@ protected function getTestFiles($testFileBase): array
  return [
  __DIR__.'/core_version.info.yml',
  __DIR__.'/core_version_test.info.yml',
+ __DIR__.'/core_version.config.info.yml',
  ];
 
  }//end getTestFiles()

coder_sniffer/DrupalPractice/Test/InfoFiles/core_version.config.info.yml

@@ -0,0 +1,2 @@
+type: coder
+description: 'This is a configuration file.'