Merge pull request #107 from LiliaFramework/codex/ensure-generate_about_md-is-used

Use Node script to generate about docs

Author: bleonheart

.github/workflows/ci.yml

@@ -230,42 +230,7 @@ jobs:
           done
           shopt -u nullglob
       - name: create-about-md
-        shell: bash
-        run: |
-          set -euo pipefail
-          sudo apt-get update -y
-          sudo apt-get install -y jq
-          if [ -f documentation/modules.json ]; then
-            jq -c '.[]' documentation/modules.json | while read -r mod; do
-              id=$(echo "$mod" | jq -r '.public_uniqueID')
-              dest="documentation/docs/modules/${id}"
-              mkdir -p "$dest"
-              {
-                echo "# $(echo "$mod" | jq -r '.name')"
-                echo ""
-                echo "**Version:** $(echo "$mod" | jq -r '.version')  "
-                author=$(echo "$mod" | jq -r '.author')
-                [ -n "$author" ] && echo "**Author:** $author  "
-                discord=$(echo "$mod" | jq -r '.discord')
-                [ -n "$discord" ] && echo "**Discord:** $discord  "
-                desc=$(echo "$mod" | jq -r '.description')
-                [ -n "$desc" ] && { echo ""; echo "$desc"; echo ""; }
-                if [ "$(echo "$mod" | jq -r '.features | length')" -gt 0 ]; then
-                  echo "## Features"
-                  echo ""
-                  echo "$mod" | jq -r '.features[] | "- " + .'
-                  echo ""
-                fi
-                if [ "$(echo "$mod" | jq -r '.workshop | length')" -gt 0 ]; then
-                  echo "## Workshop Content"
-                  echo ""
-                  echo "$mod" | jq -r '.workshop[] | "- " + .'
-                  echo ""
-                fi
-                echo "[Download]($(echo "$mod" | jq -r '.download'))"
-              } > "$dest/about.md"
-            done
-          fi
+        run: node generate_about_md.js
       - name: clean-obsolete-docs
         run: |
           rm -rf documentation/docs/hooks/modules

generate_about_md.js

@@ -1,8 +1,15 @@
 const fs = require('fs')
 const path = require('path')
 
-const modulesPath = path.join(__dirname, 'modules.json')
-if (!fs.existsSync(modulesPath)) process.exit(1)
+let modulesPath = path.join(__dirname, 'modules.json')
+if (!fs.existsSync(modulesPath)) {
+  const altPath = path.join(__dirname, 'documentation', 'modules.json')
+  if (fs.existsSync(altPath)) {
+    modulesPath = altPath
+  } else {
+    process.exit(1)
+  }
+}
 
 let modules
 try {
@@ -57,4 +64,4 @@ for (const mod of modules) {
   fs.writeFileSync(path.join(dest, 'about.md'), lines.join('\n'))
 }
 
-console.log('about.md files generated.')
+console.log('about.md files generated.')