feat: load description from description.md

psalm-baseline.xml

@@ -9,11 +9,5 @@
     <ForbiddenCode occurrences="1">
       <code>shell_exec($command)</code>
     </ForbiddenCode>
-    <PossiblyNullReference occurrences="4">
-      <code>getChangeLogMd</code>
-      <code>getInstallationMd</code>
-      <code>getReadmeMd</code>
-      <code>getUsageMd</code>
-    </PossiblyNullReference>
   </file>
 </files>

src/Classes/IndexController.php

@@ -308,6 +308,12 @@ public function invokeLazyModuleInfo()
         $moduleLoader = ModuleLoader::create(Config::getDependenyMode());
         $module = $moduleLoader->loadByArchiveNameAndVersion($archiveName, $version);
 
+        if (!$module) {
+            return ['content' => ''];
+        }
+
+        $description = $module->getDescriptionMd() !== '' ? $module->getDescriptionMd() : $module->getDescription();
+
         if ($data == 'installationMd') {
             return ['content' => $module->getInstallationMd()];
         } elseif ($data == 'usageMd') {
@@ -316,6 +322,8 @@ public function invokeLazyModuleInfo()
             return ['content' => $module->getChangeLogMd()];
         } elseif ($data == 'readmeMd') {
             return ['content' => $module->getReadmeMd()];
+        } elseif ($data == 'descriptionMd') {
+            return ['content' => $description];
         }
     }
 

src/Classes/LazyLoader.php

@@ -46,6 +46,12 @@ public static function loadModuleReadme($module, $target, $default = '')
         return self::createScript($target, $url, $default);
     }
 
+    public static function loadModuleDescription($module, $target, $default = '')
+    {
+        $url = self::createUrl($module, 'descriptionMd');
+        return self::createScript($target, $url, $default);
+    }
+
     public static function loadModuleInstallation($module, $target, $default = '')
     {
         $url = self::createUrl($module, 'installationMd');

src/Classes/Module.php

@@ -415,6 +415,19 @@ public function getReadmeMd(): string
         return FileHelper::readMarkdown($path);
     }
 
+    /**
+     * Liefert die description.md als HTML.
+     */
+    public function getDescriptionMd(): string
+    {
+        $docFilePath = $this->getDocFilePath('description.md');
+        if (!$docFilePath) {
+            return '';
+        }
+        $path = $this->getUrlOrLocalRootPath() . $docFilePath;
+        return FileHelper::readMarkdown($path);
+    }
+
     /**
      * Liefert den absoluten Pfad zur modulehash.json
      *

src/Templates/ModuleInfo.tmpl.php

@@ -1,5 +1,9 @@
 <?php
 
+/**
+ * @phpcs:disable Generic.Files.LineLength.TooLong
+ */
+
 defined('LOADED_FROM_INDEX') && LOADED_FROM_INDEX ?? die('Access denied.');
 
 use RobinTheHood\ModifiedModuleLoaderClient\LazyLoader;
@@ -209,14 +213,10 @@
                             </div>
 
                             <h2>Beschreibung</h2>
-                            <div class="markdown-body">
-                                <p>
-                                    <?php if ($module->getDescription()) { ?>
-                                        <?= $module->getDescription() ?>
-                                    <?php } else { ?>
-                                        Keine Beschreibung vorhanden.
-                                    <?php } ?>
-                                </p>
+                            <div id="description">
+                                <div class="markdown-body" style="padding-bottom: 30px">
+                                        Beschreibung wird geladen. Bitte warten...
+                                </div>
                             </div>
                         </div>
 
@@ -379,7 +379,7 @@
                                     <div class="markdown-body">
                                         README.md Wird geladen. Bitte warten...
                                     </div>
-                                 </div>
+                                </div>
                             </div>
                         </div>
 
@@ -403,6 +403,7 @@
             </div>
         </div>
 
+        <?= LazyLoader::loadModuleDescription($module, '#description .markdown-body', 'Es ist keine Beschreibung vorhanden.'); ?>
         <?= LazyLoader::loadModuleReadme($module, '#readme .markdown-body', 'Es ist keine README.md vorhanden.'); ?>
         <?= LazyLoader::loadModuleInstallation($module, '#v-pills-install .markdown-body', 'Es ist keine manuelle Installationanleitung vorhanden.'); ?>
         <?= LazyLoader::loadModuleUsage($module, '#v-pills-usage .markdown-body', 'Es ist keine Bedienungsanleitung vorhanden.'); ?>