cyclops-infobook-html 4.0.1 → 5.1.0

package/lib/serialize/HtmlInfoBookSerializer.js

@@ -1,7 +1,15 @@
 "use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.HtmlInfoBookSerializer = void 0;
-const tslib_1 = require("tslib");
 const fs_1 = require("fs");
 const mkdirp = require("mkdirp");
 const ncp_1 = require("ncp");
@@ -15,20 +23,20 @@ const FileWriter_1 = require("../infobook/FileWriter");
  */
 class HtmlInfoBookSerializer {
     constructor() {
-        this.templateIndex = pug_1.compileFile(__dirname + '/../../template/index.pug');
-        this.templateSection = pug_1.compileFile(__dirname + '/../../template/section.pug');
-        this.appendixWrapper = pug_1.compileFile(__dirname + '/../../template/appendix/appendix_base.pug');
-        this.templateItem = pug_1.compileFile(__dirname + '/../../template/appendix/item.pug');
+        this.templateIndex = (0, pug_1.compileFile)(__dirname + '/../../template/index.pug');
+        this.templateSection = (0, pug_1.compileFile)(__dirname + '/../../template/section.pug');
+        this.appendixWrapper = (0, pug_1.compileFile)(__dirname + '/../../template/appendix/appendix_base.pug');
+        this.templateItem = (0, pug_1.compileFile)(__dirname + '/../../template/appendix/item.pug');
     }
     serialize(infobook, context, assetsPaths) {
-        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        return __awaiter(this, void 0, void 0, function* () {
             context = Object.assign(Object.assign({}, context), { basePath: context.path, breadcrumbs: [] });
             this.fileWriter = new FileWriter_1.FileWriter(context);
             yield this.ensureDirExists(context.path);
-            yield this.ensureDirExists(path_1.join(context.path, 'assets'));
-            yield this.ensureDirExists(path_1.join(context.path, 'assets', 'icons'));
+            yield this.ensureDirExists((0, path_1.join)(context.path, 'assets'));
+            yield this.ensureDirExists((0, path_1.join)(context.path, 'assets', 'icon'));
             // Create a .nojekyll file to ensure _lang directories are served via GitHub pages.
-            yield fs_1.promises.writeFile(path_1.join(context.path, '.nojekyll'), '');
+            yield fs_1.promises.writeFile((0, path_1.join)(context.path, '.nojekyll'), '');
             // Serialize sections in all languages
             for (const language of context.resourceHandler.getLanguages()) {
                 const langPath = this.getLanguagePath(language, context.path);
@@ -37,21 +45,21 @@ class HtmlInfoBookSerializer {
                 yield this.serializeSectionFiles(infobook, context, language, langPath, sectionIndex);
             }
             // Serialize assets
-            yield util_1.promisify(ncp_1.ncp)(__dirname + '/../../assets/', path_1.join(context.path, 'assets'));
+            yield (0, util_1.promisify)(ncp_1.ncp)(__dirname + '/../../assets/', (0, path_1.join)(context.path, 'assets'));
             for (const assetsPath of assetsPaths) {
-                yield util_1.promisify(ncp_1.ncp)(assetsPath, path_1.join(context.path, 'assets'));
+                yield (0, util_1.promisify)(ncp_1.ncp)(assetsPath, (0, path_1.join)(context.path, 'assets'));
             }
         });
     }
     serializeSectionIndex(infobook, contextRoot, language, langPath) {
-        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        return __awaiter(this, void 0, void 0, function* () {
             const sectionIndex = {
                 linkedPagesList: [],
                 tags: {},
                 urlIndex: {},
             };
             let pageIndex = 0;
-            yield this.serializeSection(infobook.rootSection, Object.assign(Object.assign({}, contextRoot), { language, path: langPath }), ({ index, section, sectionTitle, fileUrl, breadcrumbs }) => tslib_1.__awaiter(this, void 0, void 0, function* () {
+            yield this.serializeSection(infobook.rootSection, Object.assign(Object.assign({}, contextRoot), { language, path: langPath }), (_a) => __awaiter(this, [_a], void 0, function* ({ index, section, sectionTitle, fileUrl, breadcrumbs }) {
                 if (!index) {
                     sectionIndex.urlIndex[fileUrl] = pageIndex++;
                     const name = breadcrumbs.slice(1).map((b) => b.name).join(' / ');
@@ -68,13 +76,13 @@ class HtmlInfoBookSerializer {
         });
     }
     serializeSectionFiles(infobook, contextRoot, language, langPath, sectionIndex) {
-        return tslib_1.__awaiter(this, void 0, void 0, function* () {
-            yield this.serializeSection(infobook.rootSection, Object.assign(Object.assign({}, contextRoot), { language, path: langPath, sectionIndex }), ({ index, breadcrumbs, context, section, sectionTitle, subSectionDatas, filePath, fileUrl }) => tslib_1.__awaiter(this, void 0, void 0, function* () {
+        return __awaiter(this, void 0, void 0, function* () {
+            yield this.serializeSection(infobook.rootSection, Object.assign(Object.assign({}, contextRoot), { language, path: langPath, sectionIndex }), (_a) => __awaiter(this, [_a], void 0, function* ({ index, breadcrumbs, context, section, sectionTitle, subSectionDatas, filePath, fileUrl }) {
                 // Create links to this page in other languages
                 const languages = [];
                 for (const name of contextRoot.resourceHandler.getLanguages()) {
-                    const baseFilePath = filePath.substr(path_1.join(contextRoot.basePath, this.getLanguagePath(language)).length);
-                    const languageFilePath = path_1.join(contextRoot.basePath, this.getLanguagePath(name), baseFilePath);
+                    const baseFilePath = filePath.substr((0, path_1.join)(contextRoot.basePath, this.getLanguagePath(language)).length);
+                    const languageFilePath = (0, path_1.join)(contextRoot.basePath, this.getLanguagePath(name), baseFilePath);
                     const url = this.filePathToUrl(languageFilePath, contextRoot.basePath, context.baseUrl);
                     languages.push({ name, url });
                 }
@@ -97,23 +105,26 @@ class HtmlInfoBookSerializer {
                     if (context.googleAdsense && language === 'en_us') {
                         appendices.unshift(new InfoBookAppendixAd_1.InfoBookAppendixAd());
                     }
-                    // Create leaf file
-                    const fileContents = this.templateSection(Object.assign(Object.assign({}, context), { breadcrumbs, headSuffix: context.headSuffixGetters.map((g) => g(context)).join(''), languages,
-                        nextPage,
-                        previousPage, sectionAppendices: appendices
-                            .filter((appendix) => appendix) // TODO: rm
-                            .map((appendix) => {
-                            const appendixContents = appendix.toHtml(context, this.fileWriter, this);
+                    const sectionAppendices = [];
+                    for (const appendix of appendices) {
+                        if (appendix) {
+                            const appendixContents = yield appendix.toHtml(context, this.fileWriter, this);
                             if (appendix.skipWrapper) {
-                                return appendixContents;
+                                sectionAppendices.push(appendixContents);
                             }
                             else {
-                                return this.appendixWrapper({
+                                sectionAppendices.push(this.appendixWrapper({
                                     appendixContents,
                                     appendixName: appendix.getName ? appendix.getName(context) : null,
-                                });
+                                }));
                             }
-                        }), sectionParagraphs: section.paragraphTranslationKeys
+                        }
+                    }
+                    // Create leaf file
+                    const fileContents = this.templateSection(Object.assign(Object.assign({}, context), { breadcrumbs, headSuffix: context.headSuffixGetters.map((g) => g(context)).join(''), languages,
+                        nextPage,
+                        previousPage,
+                        sectionAppendices, sectionParagraphs: section.paragraphTranslationKeys
                             .map((key) => context.resourceHandler.getTranslation(key, context.language))
                             .map((value) => this.formatString(value)), sectionTitle }));
                     yield fs_1.promises.writeFile(filePath, fileContents);
@@ -122,14 +133,14 @@ class HtmlInfoBookSerializer {
         });
     }
     serializeSection(section, context, onSection) {
-        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        return __awaiter(this, void 0, void 0, function* () {
             const sectionTitle = this.formatString(context.resourceHandler
                 .getTranslation(section.nameTranslationKey, context.language));
             const breadcrumbs = context.breadcrumbs.concat([{ name: sectionTitle }]);
             // Go in a subfolder when we are handling a different mod
             if (section.modId !== context.modId) {
-                yield this.ensureDirExists(path_1.join(context.path, section.modId));
-                context = Object.assign(Object.assign({}, context), { modId: section.modId, path: path_1.join(context.path, section.modId) });
+                yield this.ensureDirExists((0, path_1.join)(context.path, section.modId));
+                context = Object.assign(Object.assign({}, context), { modId: section.modId, path: (0, path_1.join)(context.path, section.modId) });
             }
             if (section.subSections && section.subSections.length > 0) {
                 // Navigation section
@@ -141,11 +152,11 @@ class HtmlInfoBookSerializer {
                         url: fileUrl,
                     }]);
                 for (const subSection of section.subSections) {
-                    const subSectionData = yield this.serializeSection(subSection, Object.assign(Object.assign({}, context), { breadcrumbs: subBreadcrumbs, path: path_1.join(context.path, subSection.nameTranslationKey
+                    const subSectionData = yield this.serializeSection(subSection, Object.assign(Object.assign({}, context), { breadcrumbs: subBreadcrumbs, path: (0, path_1.join)(context.path, subSection.nameTranslationKey
                             .substr(subSection.nameTranslationKey.lastIndexOf('.') + 1)), root: false }), onSection);
                     subSectionDatas.push(Object.assign(Object.assign({}, subSectionData), { url: this.filePathToUrl(subSectionData.filePath, context.basePath, context.baseUrl) }));
                 }
-                const filePath = path_1.join(context.path, 'index.html');
+                const filePath = (0, path_1.join)(context.path, 'index.html');
                 yield onSection({ index: true, breadcrumbs, context, sectionTitle, section, subSectionDatas, filePath, fileUrl });
                 return { filePath: context.path, sectionTitle };
             }
@@ -173,43 +184,47 @@ class HtmlInfoBookSerializer {
         }
         return { link, linkTarget };
     }
-    createItemDisplay(resourceHandler, context, fileWriter, item, slot, annotation = '') {
-        if (item.item === 'minecraft:air') {
-            return slot ? '<div class="item item-slot">&nbsp;</div>' : '<div class="item">&nbsp;</div>';
-        }
-        const icon = resourceHandler.getItemIconFile(item.item, item.components);
-        if (!icon) {
-            throw new Error(`Could not find an icon for item ${JSON.stringify(item)}`);
-        }
-        const iconUrl = fileWriter.write('icons/' + path_1.basename(icon), fs_1.createReadStream(icon));
-        const key = resourceHandler.getItemTranslationKey(item);
-        if (!key) {
-            throw new Error(`Could not find translation key for item ${JSON.stringify(item)}`);
-        }
-        const { link, linkTarget } = this.createResourceLink(resourceHandler, context, item.item, key);
-        return this.templateItem(Object.assign(Object.assign({}, context), { annotation, count: item.count || 1, icon: iconUrl, link,
-            linkTarget, name: resourceHandler.getTranslation(resourceHandler.getItemTranslationKey(item), context.language), slot }));
+    createItemDisplay(resourceHandler_1, context_1, fileWriter_1, item_1, slot_1) {
+        return __awaiter(this, arguments, void 0, function* (resourceHandler, context, fileWriter, item, slot, annotation = '') {
+            if (item.item === 'minecraft:air') {
+                return slot ? '<div class="item item-slot">&nbsp;</div>' : '<div class="item">&nbsp;</div>';
+            }
+            const icon = resourceHandler.getItemIconFile(item.item, item.components);
+            if (!icon) {
+                throw new Error(`Could not find an icon for item ${JSON.stringify(item)}`);
+            }
+            const iconUrl = yield fileWriter.write('icon/' + (0, path_1.basename)(icon), () => (0, fs_1.createReadStream)(icon));
+            const key = resourceHandler.getItemTranslationKey(item);
+            if (!key) {
+                throw new Error(`Could not find translation key for item ${JSON.stringify(item)}`);
+            }
+            const { link, linkTarget } = this.createResourceLink(resourceHandler, context, item.item, key);
+            return this.templateItem(Object.assign(Object.assign({}, context), { annotation, count: item.count || 1, icon: iconUrl, link,
+                linkTarget, name: resourceHandler.getTranslation(resourceHandler.getItemTranslationKey(item), context.language), slot }));
+        });
     }
     createFluidDisplay(resourceHandler, context, fileWriter, fluid, slot) {
-        const icon = resourceHandler.getFluidIconFile(fluid.fluid);
-        if (!icon) {
-            throw new Error(`Could not find an icon for fluid ${JSON.stringify(fluid)}`);
-        }
-        const iconUrl = fileWriter.write('icons/' + path_1.basename(icon), fs_1.createReadStream(icon));
-        const key = resourceHandler.getFluidTranslationKey(fluid);
-        if (!key) {
-            throw new Error(`Could not find translation key for fluid ${JSON.stringify(fluid)}`);
-        }
-        const { link, linkTarget } = this.createResourceLink(resourceHandler, context, this.tagFluid(context, fluid.fluid), key);
-        return this.templateItem(Object.assign(Object.assign({}, context), { count: (fluid.amount || 1), icon: iconUrl, link,
-            linkTarget, name: resourceHandler.getTranslation(resourceHandler.getFluidTranslationKey(fluid), context.language), slot }));
+        return __awaiter(this, void 0, void 0, function* () {
+            const icon = resourceHandler.getFluidIconFile(fluid.fluid);
+            if (!icon) {
+                throw new Error(`Could not find an icon for fluid ${JSON.stringify(fluid)}`);
+            }
+            const iconUrl = yield fileWriter.write('icon/' + (0, path_1.basename)(icon), () => (0, fs_1.createReadStream)(icon));
+            const key = resourceHandler.getFluidTranslationKey(fluid);
+            if (!key) {
+                throw new Error(`Could not find translation key for fluid ${JSON.stringify(fluid)}`);
+            }
+            const { link, linkTarget } = this.createResourceLink(resourceHandler, context, this.tagFluid(context, fluid.fluid), key);
+            return this.templateItem(Object.assign(Object.assign({}, context), { count: (fluid.amount || 1), icon: iconUrl, link,
+                linkTarget, name: resourceHandler.getTranslation(resourceHandler.getFluidTranslationKey(fluid), context.language), slot }));
+        });
     }
     tagFluid(context, fluidName) {
         return fluidName;
     }
     getLanguagePath(language, path) {
         path = path || '';
-        return language === 'en_us' ? path : path_1.join(path, '_lang', language);
+        return language === 'en_us' ? path : (0, path_1.join)(path, '_lang', language);
     }
     /**
      * Convert Minecraft formatting codes to HTML formats.
@@ -248,13 +263,13 @@ class HtmlInfoBookSerializer {
         return value;
     }
     ensureDirExists(dirPath) {
-        return tslib_1.__awaiter(this, void 0, void 0, function* () {
+        return __awaiter(this, void 0, void 0, function* () {
             let fstat;
             try {
                 fstat = yield fs_1.promises.stat(dirPath);
             }
             catch (e) {
-                yield util_1.promisify(mkdirp)(dirPath);
+                yield (0, util_1.promisify)(mkdirp)(dirPath);
             }
             if (fstat && !fstat.isDirectory() && fstat.isFile()) {
                 throw new Error(`Could not serialize to a file, must be a directory.`);
@@ -263,7 +278,7 @@ class HtmlInfoBookSerializer {
     }
     filePathToUrl(filePath, basePath, baseUrl) {
         let url = filePath.replace(basePath, baseUrl);
-        const last = path_1.basename(url);
+        const last = (0, path_1.basename)(url);
         if (!url.endsWith('/') && last.indexOf('.') < 0) {
             url = url + '/';
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "cyclops-infobook-html",
-  "version": "4.0.1",
+  "version": "5.1.0",
   "description": "Output Cyclops infobooks as HTML",
   "main": "index.js",
   "repository": "git@github.com:CyclopsMC/infobook-html.git",
@@ -12,7 +12,9 @@
   "license": "MIT",
   "bin": {
     "generate-cyclops-infobook-html": "bin/generate-infobook-html.js",
-    "generate-mod-metadata": "bin/generate-mod-metadata.js"
+    "generate-mod-metadata": "bin/generate-mod-metadata.js",
+    "generate-icons": "bin/generate-icons.js",
+    "compress-icons": "bin/compress-icons.js"
   },
   "files": [
     "bin/**/*.d.ts",
@@ -50,16 +52,16 @@
     "testEnvironment": "node"
   },
   "devDependencies": {
-    "@types/jest": "^28.0.0",
+    "@types/jest": "^30.0.0",
     "@types/minimist": "^1.2.0",
     "coveralls": "^3.0.3",
-    "jest": "^28.0.0",
+    "jest": "^30.0.0",
     "manual-git-changelog": "^1.0.1",
     "pre-commit": "^1.2.2",
-    "ts-jest": "^28.0.0",
+    "ts-jest": "^29.0.0",
     "tslint": "^6.0.0",
     "tslint-eslint-rules": "^5.4.0",
-    "typescript": "^4.0.0"
+    "typescript": "^5.0.0"
   },
   "scripts": {
     "test": "jest ${1}",
@@ -81,9 +83,11 @@
     "@types/rimraf": "^3.0.0",
     "@types/xml2js": "^0.4.4",
     "@types/yauzl": "^2.9.1",
+    "@types/minimist": "^1.2.0",
     "minimist": "^1.2.0",
     "mkdirp": "^0.5.1",
     "mvn-artifact-download": "^5.0.0",
+    "optipng-bin": "^9.0.0",
     "ncp": "^2.0.0",
     "node-fetch": "^2.6.0",
     "pug": "^3.0.0",