Add .yireo-extension-checker.json file for config

Author: jissereitsma

Scan/ScanComposerRequirements.php

@@ -11,24 +11,28 @@
 use Yireo\ExtensionChecker\Config\RuntimeConfig;
 use Yireo\ExtensionChecker\Message\MessageBucket;
 use Yireo\ExtensionChecker\Message\MessageGroupLabels;
+use Yireo\ExtensionChecker\Util\CheckerConfiguration;
 
 class ScanComposerRequirements
 {
     private ComposerFileProvider $composerFileProvider;
     private MessageBucket $messageBucket;
     private ComposerProvider $composerProvider;
     private RuntimeConfig $runtimeConfig;
+    private CheckerConfiguration $checkerConfiguration;
 
     public function __construct(
         ComposerFileProvider $composerFileProvider,
         MessageBucket $messageBucket,
         ComposerProvider $composerProvider,
-        RuntimeConfig $runtimeConfig
+        RuntimeConfig $runtimeConfig,
+        CheckerConfiguration $checkerConfiguration
     ) {
         $this->composerFileProvider = $composerFileProvider;
         $this->messageBucket = $messageBucket;
         $this->composerProvider = $composerProvider;
         $this->runtimeConfig = $runtimeConfig;
+        $this->checkerConfiguration = $checkerConfiguration;
     }
 
     /**
@@ -48,7 +52,7 @@ public function scan(string $moduleName, array $components)
         }
 
         foreach ($requirements as $requirement => $requirementVersion) {
-            $this->scanComposerRequirementWithComponents($requirement, $requirementVersion, $components);
+            $this->scanComposerRequirementWithComponents($moduleName, $requirement, $requirementVersion, $components);
         }
     }
 
@@ -93,11 +97,12 @@ private function scanComponentWithComposerRequirements(
      * @return void
      */
     private function scanComposerRequirementWithComponents(
+        string $moduleName,
         string $requirement,
         string $requirementVersion,
         array $components
     ) {
-        $this->checkIfRequirementIsNeeded($requirement, $components);
+        $this->checkIfRequirementIsNeeded($moduleName, $requirement, $components);
         $this->checkIfComposerRequirementUsesWildCard($requirement, $requirementVersion);
         $this->checkPhpVersion($requirement, $requirementVersion);
     }
@@ -107,12 +112,16 @@ private function scanComposerRequirementWithComponents(
      * @param array $components
      * @return void
      */
-    private function checkIfRequirementIsNeeded(string $requirement, array $components)
+    private function checkIfRequirementIsNeeded(string $moduleName, string $requirement, array $components)
     {
         if ($this->runtimeConfig->isHideNeedless()) {
             return;
         }
 
+        if ($this->checkerConfiguration->isIgnored($moduleName, $requirement)) {
+            return;
+        }
+
         if ($this->isComposerDependencyNeeded($requirement, $components)) {
             return;
         }

Scan/ScanModuleXmlDependencies.php

@@ -7,12 +7,14 @@
 use Yireo\ExtensionChecker\Config\RuntimeConfig;
 use Yireo\ExtensionChecker\Message\MessageBucket;
 use Yireo\ExtensionChecker\Message\MessageGroupLabels;
+use Yireo\ExtensionChecker\Util\CheckerConfiguration;
 
 class ScanModuleXmlDependencies
 {
     private ModuleXmlComponentDetector $moduleXmlComponentDetector;
     private MessageBucket $messageBucket;
     private RuntimeConfig $runtimeConfig;
+    private CheckerConfiguration $checkerConfiguration;
 
     /**
      * @param ModuleXmlComponentDetector $moduleXmlComponentDetector
@@ -21,11 +23,13 @@ class ScanModuleXmlDependencies
     public function __construct(
         ModuleXmlComponentDetector $moduleXmlComponentDetector,
         MessageBucket $messageBucket,
-        RuntimeConfig $runtimeConfig
+        RuntimeConfig $runtimeConfig,
+        CheckerConfiguration $checkerConfiguration
     ) {
         $this->moduleXmlComponentDetector = $moduleXmlComponentDetector;
         $this->messageBucket = $messageBucket;
         $this->runtimeConfig = $runtimeConfig;
+        $this->checkerConfiguration = $checkerConfiguration;
     }
 
     /**
@@ -50,7 +54,7 @@ public function scan(string $moduleName, array $components)
             }
 
             if (!$isComponentFoundInModuleXml) {
-                $message = 'Module "' . $component->getComponentName() . '" has no module.xml entry';
+                $message = 'Module "'.$component->getComponentName().'" has no module.xml entry';
                 $this->messageBucket->add($message, MessageGroupLabels::GROUP_MISSING_MODULEXML_DEP, '', $moduleName);
             }
         }
@@ -62,6 +66,11 @@ public function scan(string $moduleName, array $components)
 
             $isModuleXmlComponentFoundInDetectedComponents = false;
             foreach ($components as $component) {
+                if ($this->checkerConfiguration->isIgnored($moduleName, $moduleXmlComponent->getComponentName())) {
+                    $isModuleXmlComponentFoundInDetectedComponents = true;
+                    break;
+                }
+
                 if ($component->getComponentName() === $moduleXmlComponent->getComponentName()) {
                     $isModuleXmlComponentFoundInDetectedComponents = true;
                     break;

Util/CheckerConfiguration.php

@@ -0,0 +1,39 @@
+<?php declare(strict_types=1);
+
+namespace Yireo\ExtensionChecker\Util;
+
+use Magento\Framework\Component\ComponentRegistrar;
+
+class CheckerConfiguration
+{
+    public function __construct(
+        private ComponentRegistrar $componentRegistrar,
+    ) {
+    }
+
+    public function getIgnoredComponents(string $moduleName): array
+    {
+        $configuration = $this->getConfiguration($moduleName);
+        if (array_key_exists('ignore', $configuration)) {
+            return $configuration['ignore'];
+        }
+
+        return [];
+    }
+
+    public function isIgnored(string $moduleName, string $componentName): bool
+    {
+        return in_array($componentName, $this->getIgnoredComponents($moduleName));
+    }
+
+    private function getConfiguration(string $moduleName): array
+    {
+        $modulePath = $this->componentRegistrar->getPath(ComponentRegistrar::MODULE, $moduleName);
+        $configurationFile = $modulePath.'/.yireo-extension-checker.json';
+        if (false === file_exists($configurationFile)) {
+            return [];
+        }
+
+        return json_decode(file_get_contents($configurationFile), true);
+    }
+}