feat(config): load config file properly (cjs)

README.md

@@ -42,7 +42,7 @@ Sometimes it can be useful to call the script directly from JavaScript or TypeSc
 ```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`

index.ts

@@ -2,17 +2,19 @@
 
 import minimist from 'minimist';
 import { version } from './package.json';
-import { loadConfig } from './src/helpers/config';
-import { mergeOptions } from './src/helpers/global.helper';
+import { loadConfig, withDefaultConfig } from './src/helpers/config';
+import { cliColors } from './src/helpers/vars.helper';
 import { createSitemap } from './src/index';
 import { ChangeFreq, OptionsSvelteSitemap } from './src/interfaces/global.interface';
-import { CONFIG_FILE } from './src/vars';
+import { APP_NAME, CONFIG_FILE } from './src/vars';
+
+console.log(cliColors.cyanAndBold, `> Using ${APP_NAME}`);
 
 const REPO_URL = 'https://github.com/bartholomej/svelte-sitemap';
 
 let stop = false;
 
-// Load svelte-sitemap.js
+// Load svelte-sitemap.cjs
 const config = loadConfig(CONFIG_FILE);
 
 const args = minimist(process.argv.slice(2), {
@@ -90,7 +92,7 @@ if (args.help || args.version === '' || args.version === true) {
   const attribution: boolean =
     args['attribution'] === '' || args['attribution'] === false ? false : true;
 
-  const options: OptionsSvelteSitemap = {
+  const optionsCli: OptionsSvelteSitemap = {
     debug,
     resetTime,
     changeFreq,
@@ -101,5 +103,18 @@ if (args.help || args.version === '' || args.version === true) {
     trailingSlashes
   };
 
-  createSitemap(mergeOptions(options, config));
+  // Config file is preferred
+  if (config && Object.keys(config).length === 0) {
+    console.log(
+      cliColors.cyanAndBold,
+      `  ✔ Using CLI options. Config file ${CONFIG_FILE} not found.`
+    );
+    createSitemap(optionsCli);
+  } else {
+    console.log(
+      cliColors.green,
+      `  ✔ Loading config from ${CONFIG_FILE}. CLI options are ignored now.`
+    );
+    createSitemap(withDefaultConfig(config));
+  }
 }

package.json

@@ -39,9 +39,9 @@
     "@types/jest": "^27.4.0",
     "@types/minimist": "^1.2.2",
     "@types/node": "16.11.18",
-    "@typescript-eslint/eslint-plugin": "^5.9.1",
-    "@typescript-eslint/parser": "^5.9.1",
-    "eslint": "^8.6.0",
+    "@typescript-eslint/eslint-plugin": "^5.10.0",
+    "@typescript-eslint/parser": "^5.10.0",
+    "eslint": "^8.7.0",
     "eslint-config-google": "^0.14.0",
     "eslint-config-prettier": "^8.3.0",
     "eslint-plugin-prettier": "^4.0.0",

src/helpers/config.ts

@@ -4,7 +4,7 @@ import { loadFile } from './file';
 
 export const loadConfig = (path: string): OptionsSvelteSitemap => {
   const baseConfig = loadFile<OptionsSvelteSitemap>(path);
-  return withDefaultConfig(baseConfig!);
+  return baseConfig!;
 };
 
 export const defaultConfig: OptionsSvelteSitemap = {

src/helpers/file.ts

@@ -1,12 +1,10 @@
 import { existsSync } from 'fs';
 import { resolve } from 'path';
-import { cliColors } from './vars.helper';
 
 export const loadFile = <T>(fileName: string, throwError = true): T => {
   const filePath = resolve(resolve(process.cwd(), fileName));
 
   if (existsSync(filePath)) {
-    console.log(cliColors.cyanAndBold, `> Loading config from ${fileName}`);
     return require(filePath);
   }
 

src/helpers/global.helper.ts

@@ -2,14 +2,8 @@ import fg from 'fast-glob';
 import fs from 'fs';
 import { create } from 'xmlbuilder2';
 import { version } from '../../package.json';
-import {
-  changeFreq,
-  ChangeFreq,
-  Options,
-  OptionsSvelteSitemap,
-  PagesJson
-} from '../interfaces/global.interface';
-import { APP_NAME, OUT_DIR } from '../vars';
+import { changeFreq, ChangeFreq, Options, PagesJson } from '../interfaces/global.interface';
+import { OUT_DIR } from '../vars';
 import { cliColors, errorMsg, successMsg } from './vars.helper';
 
 const getUrl = (url: string, domain: string, options: Options) => {
@@ -29,8 +23,6 @@ const getUrl = (url: string, domain: string, options: Options) => {
 };
 
 export async function prepareData(domain: string, options?: Options): Promise<PagesJson[]> {
-  console.log(cliColors.cyanAndBold, `> Using ${APP_NAME}`);
-
   const ignore = prepareIgnored(options?.ignore, options?.outDir);
   const changeFreq = prepareChangeFreq(options);
   const pages: string[] = await fg(`${options?.outDir ?? OUT_DIR}/**/*.html`, { ignore });
@@ -104,14 +96,3 @@ const prepareChangeFreq = (options: Options): ChangeFreq => {
   }
   return result;
 };
-
-export const mergeOptions = (obj1: any, obj2: any): OptionsSvelteSitemap => {
-  const answer: any = {};
-  for (const key in obj1) {
-    if (answer[key] === undefined || answer[key] === null) answer[key] = obj1[key];
-  }
-  for (const key in obj2) {
-    if (answer[key] === undefined || answer[key] === null) answer[key] = obj2[key];
-  }
-  return answer;
-};

src/helpers/vars.helper.ts

@@ -5,7 +5,7 @@ export const cliColors = {
 };
 
 export const successMsg = (outDir: string) =>
-  `  ✔ done. Check your new sitemap here: ./${outDir}/sitemap.xml`;
+  `  ✔ Done! Check your new sitemap here: ./${outDir}/sitemap.xml`;
 
 export const errorMsg = (outDir: string) =>
   `  × 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`;

src/index.ts

@@ -6,7 +6,7 @@ export const createSitemap = async (options: OptionsSvelteSitemap): Promise<void
   if (options?.debug) {
     console.log('OPTIONS', options);
   }
-  console.log('OPTIONS', options);
+
   const json = await prepareData(options.domain, options);
 
   if (options?.debug) {

src/vars.ts

@@ -4,7 +4,7 @@ export const DOMAIN = 'https://example.com';
 
 export const OUT_DIR = 'build';
 
-export const CONFIG_FILE = 'svelte-sitemap.js';
+export const CONFIG_FILE = 'svelte-sitemap.cjs';
 
 // export const OPTIONS: Options = {
 //   domain: DOMAIN,

tsconfig.json

@@ -18,6 +18,6 @@
     "noImplicitAny": true,
     "noImplicitReturns": true
   },
-  "include": ["src", "index.ts", "svelte-sitemap.js"],
+  "include": ["src", "index.ts", "svelte-sitemap.cjs"],
   "exclude": ["dist/**/*", "*/tests/**/*"]
 }