feat(sitemap2): add legacy option

packages/sitemap2/src/node/compact/convert.ts

@@ -0,0 +1,28 @@
+import { deprecatedLogger } from "./utils";
+import type { SitemapOptions } from "../../shared";
+
+/** @deprecated */
+export const covertOptions = (
+  options: SitemapOptions & Record<string, unknown>
+): void => {
+  deprecatedLogger({
+    options,
+    deprecatedOption: "urls",
+    newOption: "extraUrls",
+  });
+  deprecatedLogger({
+    options,
+    deprecatedOption: "exclude",
+    newOption: "excludeUrls",
+  });
+  deprecatedLogger({
+    options,
+    deprecatedOption: "outFile",
+    newOption: "sitemapFilename",
+  });
+  deprecatedLogger({
+    options,
+    deprecatedOption: "dateFormatter",
+    newOption: "modifyTimeGetter",
+  });
+};

packages/sitemap2/src/node/compact/index.ts

@@ -0,0 +1 @@
+export * from "./convert";

packages/sitemap2/src/node/compact/utils.ts

@@ -0,0 +1,41 @@
+import { logger } from "../utils";
+
+export interface DeprecatedLoggerOptions {
+  options: Record<string, unknown>;
+  deprecatedOption: string;
+  newOption: string;
+  msg?: string;
+  scope?: string;
+}
+
+export const deprecatedLogger = ({
+  options,
+  deprecatedOption,
+  newOption,
+  msg = "",
+  scope = "",
+}: DeprecatedLoggerOptions): void => {
+  if (deprecatedOption in options) {
+    logger.warn(
+      `"${deprecatedOption}" is deprecated${
+        scope ? ` in ${scope}` : ""
+      }, please use "${newOption}" instead.${msg ? `\n${msg}` : ""}`
+    );
+
+    if (newOption.includes(".")) {
+      const keys = newOption.split(".");
+      let temp = options;
+
+      keys.forEach((key, index) => {
+        if (index !== keys.length - 1) {
+          // ensure level exists
+          temp[key] = temp[key] || {};
+
+          temp = temp[key] as Record<string, unknown>;
+        } else temp[key] = options[deprecatedOption];
+      });
+    } else options[newOption] = options[deprecatedOption];
+
+    delete options[deprecatedOption];
+  }
+};

packages/sitemap2/src/node/plugin.ts

@@ -1,13 +1,17 @@
 import { chalk } from "@vuepress/utils";
+import { covertOptions } from "./compact";
 import { generateSiteMap } from "./generateSitemap";
 import { logger } from "./utils";
 
 import type { PluginObject, PluginFunction } from "@vuepress/core";
 import type { SitemapOptions } from "../shared";
 
 export const sitemapPlugin =
-  (options: SitemapOptions): PluginFunction =>
+  (options: SitemapOptions, legacy = false): PluginFunction =>
   (app) => {
+    // TODO: Remove it in v2 stable
+    if (legacy)
+      covertOptions(options as SitemapOptions & Record<string, unknown>);
     if (app.env.isDebug) logger.info(`Options: ${options.toString()}`);
 
     const plugin: PluginObject = {