svelte-sitemap 2.2.0 → 2.3.2-beta.1

package/README.md

@@ -22,7 +22,30 @@ yarn add svelte-sitemap --dev
 
 ## Usage
 
-### CLI method (recommended)
+### Config file method (recommended)
+
+Create config file `svelte-sitemap.cjs` in the root of your project:
+
+`svelte-sitemap.cjs`
+
+```js
+module.exports = {
+  domain: 'https://www.example.com'
+  // ...more options
+};
+```
+
+Add `svelte-sitemap` as your postbuild script in `package.json` file:
+
+`package.json`
+
+```json
+{
+  "postbuild": "npx svelte-sitemap"
+}
+```
+
+### CLI method (Alternative 1)
 
 Run in your project root folder to see how it works.
 
@@ -35,32 +58,32 @@ yarn svelte-sitemap --domain https://example.com
 
 It scans your routes in `build/` folder and generates `build/sitemap.xml` file
 
-### TypeScript or JavaScript method (optional)
+### TypeScript or JavaScript method (Alternative 2)
 
 Sometimes it can be useful to call the script directly from JavaScript or TypeScript. Of course there is also this option, but in most cases you will need the [CLI method](#cli-method-recommended) as a postbuild hook.
 
 ```typescript
 import { createSitemap } from 'svelte-sitemap/src/index.js';
 
-createSitemap('https://example.com', { debug: true });
+createSitemap({ domain: 'https://example.com', debug: true });
 ```
 
 And now you can run your script like this: `node my-script.js`
 
 ## Example
 
-Highly recommended to use as `postbuild` hook in your `package.json`
+Highly recommended to use as `postbuild` hook in your `package.json` with config file `svelte-sitemap.cjs` in your project root.
 
 ```json
 {
   "name": "my-project",
   "scripts": {
-    "postbuild": "npx svelte-sitemap --domain https://mydomain.com"
+    "postbuild": "npx svelte-sitemap"
   }
 }
 ```
 
-## Options
+## ⚙️ Options
 
 | Option                 | Description                                                                                                                     | default               | example                                |
 | ---------------------- | ------------------------------------------------------------------------------------------------------------------------------- | --------------------- | -------------------------------------- |
@@ -74,7 +97,7 @@ Highly recommended to use as `postbuild` hook in your `package.json`
 | -v, --version          | Show version                                                                                                                    | -                     | `-h`                                   |
 | --debug                | Show some useful logs                                                                                                           | -                     | `--debug`                              |
 
-## FAQ
+## 🙋 FAQ
 
 #### How to exclude directory?
 
@@ -84,12 +107,14 @@ Highly recommended to use as `postbuild` hook in your `package.json`
 npx svelte-sitemap --domain https://www.example.com --ignore 'pages/my-secret-page' --ignore '**/admin/**'
 ```
 
-## Development
+## 🤝 Contributing
 
 I welcome you to customize this according to your needs ;)
 
 Pull requests for any improvements would be great!
 
+Feel free to check [issues page](https://github.com/bartholomej/svelte-sitemap/issues).
+
 ### Developing and debugging this library
 
 ```bash
@@ -107,17 +132,20 @@ You can find and modify it in [`./demo.ts`](./demo.ts) file
 yarn demo
 ```
 
-## Credits
+## 🙏 Credits
 
 - svelte-sitemap is workaround for [this official SvelteKit issue](https://github.com/sveltejs/kit/issues/1142)
 - Brand new version is inspired by [Richard's article](https://r-bt.com/learning/sveltekit-sitemap/)
 - Thanks to [@auderer](https://github.com/auderer) because [his issue](https://github.com/bartholomej/svelte-sitemap/issues/1) changed the direction of this library
+- Config files inspired by [next-sitemap](https://github.com/iamvishnusankar/next-sitemap)
+
+## ⭐️ Show your support
 
-## Donation
+Give a ⭐️ if this project helped you!
 
-If this project have helped you save time please consider [making a donation](https://github.com/sponsors/bartholomej) for some 🍺 or 🍵 ;)
+Or if you are brave enough consider [making a donation](https://github.com/sponsors/bartholomej) for some 🍺 or 🍵 ;)
 
-## Privacy Policy
+## 🕵️ Privacy Policy
 
 I DO NOT STORE ANY DATA. PERIOD.
 
@@ -125,9 +153,9 @@ I physically can't. I have nowhere to store it. I don't even have a server datab
 
 That's why, with this library, what happens on your device stays on your device till disappear.
 
-## License
+## 📝 License
 
-Copyright © 2021 [Lukas Bartak](http://bartweb.cz)
+Copyright © 2022 [Lukas Bartak](http://bartweb.cz)
 
 Proudly powered by nature 🗻, wind 💨, tea 🍵 and beer 🍺 ;)
 

package/index.js

@@ -3,12 +3,19 @@
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
+var _a, _b;
 Object.defineProperty(exports, "__esModule", { value: true });
 const minimist_1 = __importDefault(require("minimist"));
 const package_json_1 = require("./package.json");
+const config_1 = require("./src/helpers/config");
+const vars_helper_1 = require("./src/helpers/vars.helper");
 const index_1 = require("./src/index");
+const vars_1 = require("./src/vars");
+console.log(vars_helper_1.cliColors.cyanAndBold, `> Using ${vars_1.APP_NAME}`);
 const REPO_URL = 'https://github.com/bartholomej/svelte-sitemap';
 let stop = false;
+// Load svelte-sitemap.cjs
+const config = (0, config_1.loadConfig)(vars_1.CONFIG_FILE);
 const args = (0, minimist_1.default)(process.argv.slice(2), {
     string: ['domain', 'out-dir', 'ignore', 'change-freq'],
     boolean: ['attribution', 'reset-time', 'trailing-slashes', 'debug', 'version'],
@@ -55,11 +62,14 @@ if (args.help || args.version === '' || args.version === true) {
     log(' ');
     process.exit(args.help ? 0 : 1);
 }
-else if (!args.domain) {
+else if (!config.domain && !args.domain) {
     console.log(`⚠ svelte-sitemap: --domain argument is required.\n\nSee instructions: ${REPO_URL}\n\nExample:\n\n  svelte-sitemap --domain https://mydomain.com\n`);
     process.exit(0);
 }
-else if (!args.domain.includes('http')) {
+else if (
+// (config.domain || args.domain) &&
+!((_a = config.domain) === null || _a === void 0 ? void 0 : _a.includes('http')) &&
+    !((_b = args.domain) === null || _b === void 0 ? void 0 : _b.includes('http'))) {
     console.log(`⚠ svelte-sitemap: --domain argument must starts with https://\n\nSee instructions: ${REPO_URL}\n\nExample:\n\n  svelte-sitemap --domain https://mydomain.com\n`);
     process.exit(0);
 }
@@ -75,14 +85,23 @@ else {
     const outDir = args['out-dir'];
     const ignore = args['ignore'];
     const attribution = args['attribution'] === '' || args['attribution'] === false ? false : true;
-    const options = {
+    const optionsCli = {
         debug,
         resetTime,
         changeFreq,
         outDir,
+        domain,
         attribution,
         ignore,
         trailingSlashes
     };
-    (0, index_1.createSitemap)(domain, options);
+    // Config file is preferred
+    if (config && Object.keys(config).length === 0) {
+        console.log(vars_helper_1.cliColors.cyanAndBold, `  ✔ Using CLI options. Config file ${vars_1.CONFIG_FILE} not found.`);
+        (0, index_1.createSitemap)(optionsCli);
+    }
+    else {
+        console.log(vars_helper_1.cliColors.green, `  ✔ Loading config from ${vars_1.CONFIG_FILE}. CLI options are ignored now.`);
+        (0, index_1.createSitemap)((0, config_1.withDefaultConfig)(config));
+    }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "svelte-sitemap",
-  "version": "2.2.0",
+  "version": "2.3.2-beta.1",
   "description": "Small helper which scans your Svelte routes folder and generates static sitemap.xml",
   "main": "./index.js",
   "author": "BART! <bart@bartweb.cz>",
@@ -28,7 +28,7 @@
     "release:major": "git checkout master && npm version major -m \"chore(update): major release %s 💥 \""
   },
   "dependencies": {
-    "fast-glob": "^3.2.7",
+    "fast-glob": "^3.2.11",
     "minimist": "^1.2.5",
     "xmlbuilder2": "^3.0.2"
   },

package/src/helpers/config.d.ts

@@ -0,0 +1,5 @@
+import { OptionsSvelteSitemap } from '../interfaces/global.interface';
+export declare const loadConfig: (path: string) => OptionsSvelteSitemap;
+export declare const defaultConfig: OptionsSvelteSitemap;
+export declare const updateConfig: (currConfig: OptionsSvelteSitemap, newConfig: OptionsSvelteSitemap) => OptionsSvelteSitemap;
+export declare const withDefaultConfig: (config: OptionsSvelteSitemap) => OptionsSvelteSitemap;

package/src/helpers/config.js

@@ -0,0 +1,28 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.withDefaultConfig = exports.updateConfig = exports.defaultConfig = exports.loadConfig = void 0;
+const vars_1 = require("./../vars");
+const file_1 = require("./file");
+const loadConfig = (path) => {
+    const baseConfig = (0, file_1.loadFile)(path);
+    return baseConfig;
+};
+exports.loadConfig = loadConfig;
+exports.defaultConfig = {
+    debug: false,
+    changeFreq: null,
+    resetTime: false,
+    outDir: vars_1.OUT_DIR,
+    attribution: true,
+    ignore: null,
+    trailingSlashes: false,
+    domain: null
+};
+const updateConfig = (currConfig, newConfig) => {
+    return Object.assign(Object.assign({}, currConfig), newConfig);
+};
+exports.updateConfig = updateConfig;
+const withDefaultConfig = (config) => {
+    return (0, exports.updateConfig)(exports.defaultConfig, config);
+};
+exports.withDefaultConfig = withDefaultConfig;

package/src/helpers/file.d.ts

@@ -0,0 +1 @@
+export declare const loadFile: <T>(fileName: string, throwError?: boolean) => T;

package/src/helpers/file.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loadFile = void 0;
+const fs_1 = require("fs");
+const path_1 = require("path");
+const loadFile = (fileName, throwError = true) => {
+    const filePath = (0, path_1.resolve)((0, path_1.resolve)(process.cwd(), fileName));
+    if ((0, fs_1.existsSync)(filePath)) {
+        return require(filePath);
+    }
+    if (throwError) {
+        new Error(`${filePath} does not exist.`);
+    }
+    return null;
+};
+exports.loadFile = loadFile;

package/src/helpers/global.helper.js

@@ -27,7 +27,6 @@ const getUrl = (url, domain, options) => {
 };
 async function prepareData(domain, options) {
     var _a;
-    console.log(vars_helper_1.cliColors.cyanAndBold, `> Using ${vars_1.APP_NAME}`);
     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 });
@@ -43,7 +42,7 @@ async function prepareData(domain, options) {
 exports.prepareData = prepareData;
 const writeSitemap = (items, options) => {
     var _a;
-    const sitemap = (0, xmlbuilder2_1.create)({ version: '1.0' }).ele('urlset', {
+    const sitemap = (0, xmlbuilder2_1.create)({ version: '1.0', encoding: 'UTF-8' }).ele('urlset', {
         xmlns: 'http://www.sitemaps.org/schemas/sitemap/0.9'
     });
     if (options === null || options === void 0 ? void 0 : options.attribution) {

package/src/helpers/vars.helper.js

@@ -6,7 +6,7 @@ exports.cliColors = {
     green: '\x1b[32m%s\x1b[0m',
     red: '\x1b[31m%s\x1b[0m'
 };
-const successMsg = (outDir) => `  ✔ done. Check your new sitemap here: ./${outDir}/sitemap.xml`;
+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;

package/src/index.d.ts

@@ -1,2 +1,2 @@
-import { Options } from './interfaces/global.interface';
-export declare const createSitemap: (domain?: string, options?: Options) => Promise<void>;
+import { OptionsSvelteSitemap } from './interfaces/global.interface';
+export declare const createSitemap: (options: OptionsSvelteSitemap) => Promise<void>;

package/src/index.js

@@ -3,13 +3,11 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.createSitemap = void 0;
 const global_helper_1 = require("./helpers/global.helper");
 const vars_helper_1 = require("./helpers/vars.helper");
-const vars_1 = require("./vars");
-const createSitemap = async (domain = vars_1.DOMAIN, options) => {
-    var _a;
+const createSitemap = async (options) => {
     if (options === null || options === void 0 ? void 0 : options.debug) {
         console.log('OPTIONS', options);
     }
-    const json = await (0, global_helper_1.prepareData)(domain, options);
+    const json = await (0, global_helper_1.prepareData)(options.domain, options);
     if (options === null || options === void 0 ? void 0 : options.debug) {
         console.log('RESULT', json);
     }
@@ -17,7 +15,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.errorMsg)(options.outDir));
     }
 };
 exports.createSitemap = createSitemap;

package/src/interfaces/global.interface.d.ts

@@ -11,6 +11,9 @@ export interface Options {
     ignore?: string | string[];
     trailingSlashes?: boolean;
 }
+export interface OptionsSvelteSitemap extends Options {
+    domain: string;
+}
 export interface PagesJson {
     page: string;
     changeFreq?: ChangeFreq;

package/src/vars.d.ts

@@ -1,5 +1,4 @@
-import { Options } from './interfaces/global.interface';
 export declare const APP_NAME = "svelte-sitemap";
 export declare const DOMAIN = "https://example.com";
-export declare const OPTIONS: Options;
 export declare const OUT_DIR = "build";
+export declare const CONFIG_FILE = "svelte-sitemap.cjs";

package/src/vars.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.OUT_DIR = exports.OPTIONS = exports.DOMAIN = exports.APP_NAME = void 0;
+exports.CONFIG_FILE = exports.OUT_DIR = exports.DOMAIN = exports.APP_NAME = void 0;
 exports.APP_NAME = 'svelte-sitemap';
 exports.DOMAIN = 'https://example.com';
-exports.OPTIONS = { resetTime: false, debug: false, changeFreq: 'weekly' };
 exports.OUT_DIR = 'build';
+exports.CONFIG_FILE = 'svelte-sitemap.cjs';