@neonwilderness/moveskins 1.1.3 → 1.2.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@neonwilderness/moveskins",
-  "version": "1.1.3",
+  "version": "1.2.0",
   "description": "Download/Upload/Compare modified skins for selected aliases on Twoday",
   "keywords": [
     "antville",
@@ -10,6 +10,9 @@
   ],
   "license": "MIT",
   "author": "NeonWilderness",
+  "bin": {
+    "moveskins": "./dist/index.js"
+  },
   "files": [
     "dist",
     "skins/skinRegister.json",
@@ -22,24 +25,22 @@
   ],
   "type": "module",
   "exports": "./dist/index.js",
-  "bin": {
-    "moveskins": "./dist/index.js"
-  },
   "scripts": {
     "update": "ncu -u && npm i",
     "backup": "node ./src/index --backup --alias=www --from=prod",
     "dev": "vp run node ./src/index.js",
     "build": "vp build",
     "check": "vp check",
+    "check:fix": "vp check --fix",
     "create": "node ./src/create --skin=Site.testskin --alias=talkstraight",
     "//": "For compare function, live-server module must be installed globally!",
     "compare": "node ./src/index --compare --alias=help --to=dev && npm run report",
     "compare:blogs": "node ./src/index --compare --alias=foundation:info --to=prod && npm run report",
-    "download": "node ./src/index --alias=foundation --from=prod",
+    "download": "node ./src/index --alias=www --from=prod --modules",
     "download2": "node ./src/index --alias=info,help --from=prod",
-    "download:clean": "node ./src/index --alias=recycle --from=prod --clean",
-    "download:core": "node ./src/index --alias=* --from=prod",
-    "download:core:clean": "node ./src/index --alias=* --from=prod --clean",
+    "download:clean": "node ./src/index --alias=www --from=prod --clean --modules",
+    "download:core": "node ./src/index --alias=* --from=prod --modules",
+    "download:core:clean": "node ./src/index --alias=* --from=prod --clean --modules",
     "report": "live-server --open=./report.html --quiet",
     "restore": "node ./src/index --backup --alias=www --to=dev",
     "upload": "node ./src/index --alias=neonwilderness --to=dev",
@@ -51,16 +52,16 @@
     "test:ui": "vp test --ui"
   },
   "dependencies": {
-    "@neonwilderness/twoday": "^0.6.2",
+    "@neonwilderness/twoday": "^0.8.0",
     "chalk": "^5.6.2",
     "del": "^8.0.1",
     "dotenv-safe": "^9.1.0",
     "yargs": "^18.0.0"
   },
   "devDependencies": {
-    "@vitest/ui": "4.1.2",
+    "@vitest/ui": "4.1.5",
     "slash": "^5.1.0",
-    "vite-plus": "^0.1.15"
+    "vite-plus": "^0.1.19"
   },
   "engines": {
     "node": ">=20"

package/skins/skinRegister.json

@@ -218,5 +218,9 @@
   "Site.flagReasons": {
     "title": "Globale Texte für Beitragsmarkierungen",
     "description": "In diesem Systemskin werden die gültigen Beitragsmarkierungsgründe mit ihren jeweiligen Texten in Deutsch (de) und Englisch (en) hinterlegt."
+  },
+  "Site.adminnavigation": {
+    "title": "Navigationsleiste für Site Administratoren",
+    "description": "Dieses Skin beinhaltet die zusätzlichen Navigationselemente für Site Administratoren. (z.B. »Einstellungen bearbeiten«, »Skins bearbeiten«, ...)"
   }
 }

package/src/_download.js

@@ -8,6 +8,28 @@ import { existsSync, mkdirSync, writeFileSync } from "node:fs";
 import { resolve } from "node:path";
 import { aliasSkinFolder, skinRegister } from "./_utils.js";
 
+const capitalize = (text) => text.charAt(0).toUpperCase() + text.slice(1);
+
+const findEmbeddedSkinMacros = async (td, alias, skinContent, skinContainer) => {
+  const skinMacros = skinContent.match(/<%\s.*?\.skin name=".*?"\s%>/g);
+  if (skinMacros) {
+    for (let macro of skinMacros) {
+      // example: '<% Site.skin name="legalRefs" %>'
+      const s = macro.match(/(\w+)\.skin name="(\w+)"/);
+      if (!s) continue;
+      const skinName = `${capitalize(s[1])}.${s[2]}`;
+      const layoutUrl = await td.getActiveLayoutUrl(alias);
+      const { skin } = await td.getSkin({
+        name: skinName,
+        url: `${layoutUrl}/skins/edit?key=${skinName}`,
+      });
+      skinContainer[skinName] = skin;
+      skinContainer = await findEmbeddedSkinMacros(td, alias, skin, skinContainer);
+    }
+  }
+  return skinContainer;
+};
+
 /**
  * Downloads all customized skins of one or more aliases and stores them in appropriate
  * subdirectories for subsequent manual edits (or just as backup)
@@ -22,6 +44,7 @@ const downloadModifiedSkins = async (td, aliases, options) => {
       console.log(chalk.green(`\nNow processing alias "${alias}"...`));
       const aliasSkinDir = aliasSkinFolder(alias, options.backup);
       const modifiedSkins = await td.getModifiedSkins(alias);
+      let skinContainer = {};
 
       if (modifiedSkins.length && !existsSync(aliasSkinDir)) mkdirSync(aliasSkinDir);
       console.log(
@@ -37,7 +60,32 @@ const downloadModifiedSkins = async (td, aliases, options) => {
         const { title, description, skin } = await td.getSkin(modSkin);
 
         skinRegister.setData(modSkin.name, title, description);
-        writeFileSync(resolve(aliasSkinDir, `${modSkin.name}.skin`), skin);
+        skinContainer[modSkin.name] = skin;
+        skinContainer = await findEmbeddedSkinMacros(td, alias, skin, skinContainer);
+      }
+
+      if (options.modules) {
+        console.log(chalk.yellow(`Exporting sidebar freetext modules as requested.`));
+        const sidebar = await td.getSidebarModules(alias);
+        const moduleNames = [...sidebar.sidebar01, ...sidebar.sidebar02];
+        for (let module of moduleNames) {
+          if (/FreeText\d{2}/.test(module)) {
+            console.log(chalk.gray(`Reading sidebar module "${module}".`));
+            const { heading, content } = await td.getFreeTextModule(alias, module);
+            skinContainer[`Sidebar.${module}`] = `${heading}\n${content}`;
+          } else {
+            const { skins } = await td.getModuleSkins(alias, module);
+            for (let s of skins) {
+              const { title, description, skin } = await td.getSkin(s);
+              skinRegister.setData(s.name, title, description);
+              skinContainer[s.name] = skin;
+            }
+          }
+        }
+      }
+
+      for (const [name, content] of Object.entries(skinContainer)) {
+        writeFileSync(resolve(aliasSkinDir, `${name}.skin`), content);
       }
     }
     console.log(chalk.green("Download completed."));

package/src/_upload.js

@@ -35,19 +35,41 @@ const uploadModifiedSkins = async (td, aliases, options) => {
         if (!skinFile.endsWith(".skin")) continue;
         if (options.skin && !options.skin.test(skinFile)) continue;
 
-        const skin = skinRegister.getData(skinFile);
-        skin.content = readFileSync(resolve(aliasSkinDir, skinFile))
-          .toString()
-          .replace(/\r\n/g, "\n");
+        const [hoptype, name] = skinFile.split(".");
+        if (hoptype === "Sidebar") {
+          const module = readFileSync(resolve(aliasSkinDir, skinFile))
+            .toString()
+            .replace(/\r\n/g, "\n");
+          let splitAt = module.indexOf("\n");
+          const heading = module.slice(0, splitAt);
+          const content = module.slice(++splitAt);
+          console.log(chalk.blue(`Now updating sidebar module ${name} (len=${content.length}).`));
+          await td.updateFreeTextModule(alias, name, { heading, content });
+          console.log(chalk.green(`Update request completed for module: ${name}`));
+        } else {
+          const { isValid, prototype } = td.isValidHoptype(skinFile.slice(0, -5));
+          if (!isValid) {
+            console.log(
+              chalk.red(
+                `Skipping upload for invalid skin hoptype "${prototype}" (Skin file ${skinFile}).`,
+              ),
+            );
+            continue;
+          }
+          const skin = skinRegister.getData(skinFile);
+          skin.content = readFileSync(resolve(aliasSkinDir, skinFile))
+            .toString()
+            .replace(/\r\n/g, "\n");
 
-        console.log(chalk.blue(`Now updating skin ${skin.name} (len=${skin.content.length}).`));
-        await td.updateSkin(alias, skin.name, {
-          title: skin.title,
-          description: skin.description,
-          skin: skin.content,
-          diff: options.debug,
-        });
-        console.log(chalk.green(`Update request completed for skin: ${skin.name}`));
+          console.log(chalk.blue(`Now updating skin ${skin.name} (len=${skin.content.length}).`));
+          await td.updateSkin(alias, skin.name, {
+            title: skin.title,
+            description: skin.description,
+            skin: skin.content,
+            diff: options.debug,
+          });
+          console.log(chalk.green(`Update request completed for skin: ${skin.name}`));
+        }
 
         if (currentSkins.has(skin.name)) currentSkins.delete(skin.name);
       }

package/src/index.js

@@ -33,6 +33,12 @@ const argv = yargs(process.argv.slice(2)).options({
     description: "Skin selection string (regex) to filter the skins to upload",
     type: "string",
   },
+  modules: {
+    alias: "m",
+    description: "Download sidebar module skins/freetext as well",
+    default: false,
+    type: "boolean",
+  },
   backup: {
     alias: "b",
     description: "Backup skins to the local /backup folder to preserve their former status",
@@ -99,7 +105,10 @@ if (argv.compare) {
   const direction = argv.from ? "from" : "to";
   const execTask = argv.from ? downloadModifiedSkins : uploadModifiedSkins;
 
-  if (action === "down" && argv.clean) cleanupAliasFolder(aliases, argv.backup);
+  if (action === "down" && argv.clean) {
+    cleanupAliasFolder(aliases, argv.backup);
+    console.log(chalk.yellow(`Cleaning target download folder/s for "${aliases}".`));
+  }
 
   console.log(
     `Start ${action}loading modified skins of alias${aliases.length > 1 ? "es" : ""} ${chalk.yellow(
@@ -109,6 +118,7 @@ if (argv.compare) {
   execTask(td, aliases, {
     backup: argv.backup,
     debug: argv.debug,
+    modules: argv.modules,
     skin: argv.skin ? new RegExp(argv.skin) : null,
   });
 }