svelte-sitemap 2.3.2 → 2.5.0-beta.0

package/README.md

@@ -4,11 +4,11 @@
 
 # Svelte `sitemap.xml` generator
 
-> Small helper which scans your Svelte routes and generates static sitemap.xml
+> Small helper which scans your Svelte routes and generates _sitemap.xml_
 >
+> - Designed for Svelte `adapter-static` with `prerender` option
 > - TypeScript, JavaScript, CLI version
 > - Useful options
-> - Compatible with Svelte `adapter-static`
 > - Workaround for [this official SvelteKit issue](https://github.com/sveltejs/kit/issues/1142)
 
 ## Install

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "svelte-sitemap",
-  "version": "2.3.2",
+  "version": "2.5.0-beta.0",
   "description": "Small helper which scans your Svelte routes folder and generates static sitemap.xml",
   "main": "./index.js",
   "author": "BART! <bart@bartweb.cz>",
@@ -29,7 +29,7 @@
   },
   "dependencies": {
     "fast-glob": "^3.2.11",
-    "minimist": "^1.2.5",
+    "minimist": "^1.2.6",
     "xmlbuilder2": "^3.0.2"
   },
   "repository": {

package/src/helpers/global.helper.d.ts

@@ -1,3 +1,8 @@
 import { Options, PagesJson } from '../interfaces/global.interface';
+export declare const removeHtml: (fileName: string) => string;
 export declare function prepareData(domain: string, options?: Options): Promise<PagesJson[]>;
+export declare const showErrors: (ERRORS: {
+    folder: boolean;
+    htmlFiles: boolean;
+}) => void;
 export declare const writeSitemap: (items: PagesJson[], options: Options) => void;

package/src/helpers/global.helper.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.writeSitemap = exports.prepareData = void 0;
+exports.writeSitemap = exports.showErrors = exports.prepareData = exports.removeHtml = void 0;
 const fast_glob_1 = __importDefault(require("fast-glob"));
 const fs_1 = __importDefault(require("fs"));
 const xmlbuilder2_1 = require("xmlbuilder2");
@@ -18,19 +18,41 @@ const getUrl = (url, domain, options) => {
         .split(((_a = options === null || options === void 0 ? void 0 : options.outDir) !== null && _a !== void 0 ? _a : vars_1.OUT_DIR) + '/')
         .pop()
         .replace('index.html', '');
-    // Remove trailing slashes
-    if (!(options === null || options === void 0 ? void 0 : options.trailingSlashes)) {
+    trimmed = (0, exports.removeHtml)(trimmed);
+    // Add all traling slashes
+    if (options === null || options === void 0 ? void 0 : options.trailingSlashes) {
+        trimmed = trimmed.length && !trimmed.endsWith('/') ? trimmed + '/' : trimmed;
+    }
+    else {
         trimmed = trimmed.endsWith('/') ? trimmed.slice(0, -1) : trimmed;
         slash = trimmed ? slash : '';
     }
     return `${domain}${slash}${trimmed}`;
 };
+const removeHtml = (fileName) => {
+    if (fileName === null || fileName === void 0 ? void 0 : fileName.endsWith('.html')) {
+        return fileName.slice(0, -5);
+    }
+    return fileName;
+};
+exports.removeHtml = removeHtml;
 async function prepareData(domain, options) {
     var _a;
     console.log(vars_helper_1.cliColors.cyanAndBold, `> Using ${vars_1.APP_NAME}`);
+    const FOLDER = (_a = options === null || options === void 0 ? void 0 : options.outDir) !== null && _a !== void 0 ? _a : vars_1.OUT_DIR;
+    const ERRORS = {
+        folder: false,
+        htmlFiles: false
+    };
     const ignore = prepareIgnored(options === null || options === void 0 ? void 0 : options.ignore, options === null || options === void 0 ? void 0 : options.outDir);
     const changeFreq = prepareChangeFreq(options);
-    const pages = await (0, fast_glob_1.default)(`${(_a = options === null || options === void 0 ? void 0 : options.outDir) !== null && _a !== void 0 ? _a : vars_1.OUT_DIR}/**/*.html`, { ignore });
+    const pages = await (0, fast_glob_1.default)(`${FOLDER}/**/*.html`, { ignore });
+    if (!fs_1.default.existsSync(FOLDER)) {
+        ERRORS.folder = true;
+    }
+    if (!pages.length) {
+        ERRORS.htmlFiles = true;
+    }
     const results = pages.map((page) => {
         return {
             page: getUrl(page, domain, options),
@@ -38,9 +60,20 @@ async function prepareData(domain, options) {
             lastMod: (options === null || options === void 0 ? void 0 : options.resetTime) ? new Date().toISOString().split('T')[0] : ''
         };
     });
+    (0, exports.showErrors)(ERRORS);
     return results;
 }
 exports.prepareData = prepareData;
+const showErrors = (ERRORS) => {
+    if (ERRORS.folder && ERRORS.htmlFiles) {
+        console.error(vars_helper_1.cliColors.red, (0, vars_helper_1.errorMsgFolder)(vars_1.OUT_DIR));
+    }
+    else if (ERRORS.htmlFiles) {
+        // If no page exists, then the static adapter is probably not used
+        console.error(vars_helper_1.cliColors.red, (0, vars_helper_1.errorMsgHtmlFiles)(vars_1.OUT_DIR));
+    }
+};
+exports.showErrors = showErrors;
 const writeSitemap = (items, options) => {
     var _a;
     const sitemap = (0, xmlbuilder2_1.create)({ version: '1.0', encoding: 'UTF-8' }).ele('urlset', {
@@ -66,7 +99,7 @@ const writeSitemap = (items, options) => {
         console.log(vars_helper_1.cliColors.green, (0, vars_helper_1.successMsg)(outDir));
     }
     catch (e) {
-        console.error(vars_helper_1.cliColors.red, (0, vars_helper_1.errorMsg)(outDir), e);
+        console.error(vars_helper_1.cliColors.red, (0, vars_helper_1.errorMsgWrite)(outDir), e);
     }
 };
 exports.writeSitemap = writeSitemap;

package/src/helpers/vars.helper.d.ts

@@ -4,4 +4,6 @@ export declare const cliColors: {
     red: string;
 };
 export declare const successMsg: (outDir: string) => string;
-export declare const errorMsg: (outDir: string) => string;
+export declare const errorMsgWrite: (outDir: string) => string;
+export declare const errorMsgFolder: (outDir: string) => string;
+export declare const errorMsgHtmlFiles: (outDir: string) => string;

package/src/helpers/vars.helper.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.errorMsg = exports.successMsg = exports.cliColors = void 0;
+exports.errorMsgHtmlFiles = exports.errorMsgFolder = exports.errorMsgWrite = exports.successMsg = exports.cliColors = void 0;
 exports.cliColors = {
     cyanAndBold: '\x1b[36m\x1b[1m%s\x1b[22m\x1b[0m',
     green: '\x1b[32m%s\x1b[0m',
@@ -8,5 +8,9 @@ exports.cliColors = {
 };
 const successMsg = (outDir) => `  ✔ done. Check your new sitemap here: ./${outDir}/sitemap.xml`;
 exports.successMsg = successMsg;
-const errorMsg = (outDir) => `  × Make sure you are using this script as 'postbuild' so '${outDir}' folder was successfully created before running this script. See https://github.com/bartholomej/svelte-sitemap#readme`;
-exports.errorMsg = errorMsg;
+const errorMsgWrite = (outDir) => `  × File '${outDir}/sitemap.xml' could not be created.`;
+exports.errorMsgWrite = errorMsgWrite;
+const errorMsgFolder = (outDir) => `  × Folder '${outDir}/' doesn't exist.\n    Make sure you are using this library as 'postbuild' so '${outDir}/' folder was successfully created before running this script. See https://github.com/bartholomej/svelte-sitemap#readme`;
+exports.errorMsgFolder = errorMsgFolder;
+const errorMsgHtmlFiles = (outDir) => `  × There is no static html file in your '${outDir}/' folder. Are you sure you are using Svelte adapter-static with prerender option? See https://github.com/bartholomej/svelte-sitemap#readme`;
+exports.errorMsgHtmlFiles = errorMsgHtmlFiles;

package/src/index.js

@@ -17,7 +17,7 @@ const createSitemap = async (domain = vars_1.DOMAIN, options) => {
         (0, global_helper_1.writeSitemap)(json, options);
     }
     else {
-        console.error(vars_helper_1.cliColors.red, (0, vars_helper_1.errorMsg)((_a = options.outDir) !== null && _a !== void 0 ? _a : vars_1.OUT_DIR));
+        console.error(vars_helper_1.cliColors.red, (0, vars_helper_1.errorMsgWrite)((_a = options.outDir) !== null && _a !== void 0 ? _a : vars_1.OUT_DIR));
     }
 };
 exports.createSitemap = createSitemap;