@antv/dumi-theme-antv 0.7.0 → 0.7.1

package/dist/pages/Example/index.js

@@ -111,8 +111,9 @@ var Example = function Example() {
       var demoId = example.id,
         targetExample = example.targetExample,
         targetTopic = example.targetTopic;
-      // eg: /zh/examples/case/area/#area1
-      var newURL = "/".concat(locale.id, "/examples/").concat(targetTopic === null || targetTopic === void 0 ? void 0 : targetTopic.id, "/").concat(targetExample === null || targetExample === void 0 ? void 0 : targetExample.id, "/#").concat(demoId);
+      // eg: /examples/case/area/#area1
+      var prefix = locale.id === 'en' ? '/en' : "";
+      var newURL = "".concat(prefix, "/examples/").concat(targetTopic === null || targetTopic === void 0 ? void 0 : targetTopic.id, "/").concat(targetExample === null || targetExample === void 0 ? void 0 : targetExample.id, "/#").concat(demoId);
       navigate(newURL);
     },
     exampleTopics: exampleTopics

package/dist/plugin/deadLinkChecker.js

@@ -0,0 +1,250 @@
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/plugin/deadLinkChecker.ts
+var deadLinkChecker_exports = {};
+__export(deadLinkChecker_exports, {
+  default: () => deadLinkChecker_default
+});
+module.exports = __toCommonJS(deadLinkChecker_exports);
+var import_chalk = __toESM(require("chalk"));
+var cheerio = __toESM(require("cheerio"));
+var fs = __toESM(require("fs"));
+var glob = __toESM(require("glob"));
+var import_lodash = __toESM(require("lodash.merge"));
+var import_p_limit = __toESM(require("p-limit"));
+var path = __toESM(require("path"));
+var defaultConfig = {
+  enable: true,
+  distDir: "dist",
+  checkExternalLinks: true,
+  ignorePatterns: ["^#", "^mailto:", "^tel:", "^javascript:", "^data:", ".*stackoverflow\\.com.*"],
+  fileExtensions: [".html"],
+  failOnError: false,
+  externalLinkTimeout: 1e4,
+  maxConcurrentRequests: 5
+};
+var tempCache = {};
+function processConfig(options) {
+  return {
+    ...options,
+    ignorePatterns: options.ignorePatterns.map(
+      (pattern) => typeof pattern === "string" ? new RegExp(pattern) : pattern
+    )
+  };
+}
+function collectLinks(htmlFiles, distDir) {
+  const links = [];
+  htmlFiles.forEach((htmlFile) => {
+    const filePath = path.join(distDir, htmlFile);
+    const content = fs.readFileSync(filePath, "utf-8");
+    const $ = cheerio.load(content);
+    $("a").each((_, element) => {
+      const url = $(element).attr("href");
+      if (!url)
+        return;
+      links.push({
+        url,
+        text: $(element).text().trim() || "[No text]",
+        sourceFile: htmlFile,
+        isExternal: url.startsWith("http://") || url.startsWith("https://")
+      });
+    });
+  });
+  return links;
+}
+function filterIgnoredLinks(links, ignorePatterns) {
+  return links.filter((link) => {
+    return !ignorePatterns.some((pattern) => pattern.test(link.url));
+  });
+}
+function checkInternalLinks(links, existingFiles) {
+  const deadLinks = [];
+  links.forEach((link) => {
+    if (!link.url.startsWith("/") || link.url.startsWith("//"))
+      return;
+    let normalizedLink = link.url.split("#")[0];
+    normalizedLink = normalizedLink.split("?")[0];
+    if (normalizedLink.endsWith("/")) {
+      normalizedLink += "index.html";
+    }
+    const exists = existingFiles.has(normalizedLink) || path.extname(normalizedLink) === "" && (existingFiles.has(normalizedLink + "/") || existingFiles.has(normalizedLink + "/index.html") || existingFiles.has(normalizedLink + ".html"));
+    if (!exists) {
+      deadLinks.push({
+        ...link,
+        reason: "File not found"
+      });
+    }
+  });
+  return deadLinks;
+}
+async function checkExternalLinks(links, config) {
+  const deadLinks = [];
+  const limit = (0, import_p_limit.default)(config.maxConcurrentRequests);
+  const uncachedLinks = [];
+  links.forEach((link) => {
+    if (tempCache[link.url]) {
+      if (!tempCache[link.url].success) {
+        deadLinks.push({
+          ...link,
+          reason: tempCache[link.url].reason || "未知错误"
+        });
+      }
+      console.log(import_chalk.default.gray(`  [cached] ${link.url}`));
+    } else {
+      uncachedLinks.push(link);
+    }
+  });
+  const promises = uncachedLinks.map((link) => {
+    return limit(async () => {
+      try {
+        const controller = new AbortController();
+        const timeoutId = setTimeout(() => controller.abort(), config.externalLinkTimeout);
+        const response = await fetch(link.url);
+        clearTimeout(timeoutId);
+        if (response.status >= 400) {
+          tempCache[link.url] = {
+            success: false,
+            reason: `Status code ${response.status}`
+          };
+          deadLinks.push({
+            ...link,
+            reason: `Status code ${response.status}`
+          });
+        } else {
+          tempCache[link.url] = { success: true };
+        }
+      } catch (error) {
+        const reason = error instanceof Error ? error.message : String(error);
+        tempCache[link.url] = { success: false, reason };
+        deadLinks.push({
+          ...link,
+          reason
+        });
+      }
+    });
+  });
+  await Promise.all(promises);
+  return deadLinks;
+}
+async function runCheck(config) {
+  const distDir = path.resolve(process.cwd(), config.distDir);
+  if (!fs.existsSync(distDir)) {
+    return {
+      totalLinks: 0,
+      deadLinks: [],
+      success: false
+    };
+  }
+  const htmlFiles = glob.sync(`**/*+(${config.fileExtensions.join("|")})`, { cwd: distDir });
+  const existingFiles = /* @__PURE__ */ new Set();
+  glob.sync("**/*", { cwd: distDir, nodir: true }).forEach((file) => {
+    existingFiles.add("/" + file);
+  });
+  const allLinks = collectLinks(htmlFiles, distDir);
+  const linksToCheck = filterIgnoredLinks(allLinks, config.ignorePatterns);
+  const internalDeadLinks = checkInternalLinks(
+    linksToCheck.filter((link) => !link.isExternal),
+    existingFiles
+  );
+  const externalDeadLinks = config.checkExternalLinks ? await checkExternalLinks(
+    linksToCheck.filter((link) => link.isExternal),
+    config
+  ) : [];
+  const deadLinks = [...internalDeadLinks, ...externalDeadLinks];
+  return {
+    totalLinks: allLinks.length,
+    deadLinks,
+    success: deadLinks.length === 0
+  };
+}
+function generateReport(result) {
+  console.log();
+  if (result.deadLinks.length === 0) {
+    console.log(import_chalk.default.green(`✓ Check completed: All ${result.totalLinks} links are valid`));
+    console.log();
+    return;
+  }
+  const linksByFile = result.deadLinks.reduce((acc, link) => {
+    if (!acc[link.sourceFile]) {
+      acc[link.sourceFile] = [];
+    }
+    acc[link.sourceFile].push(link);
+    return acc;
+  }, {});
+  console.log(
+    import_chalk.default.yellow(
+      `📊 Found ${result.deadLinks.length}/${result.totalLinks} dead links in ${Object.keys(linksByFile).length} files`
+    )
+  );
+  Object.entries(linksByFile).forEach(([file, links]) => {
+    console.log();
+    console.log(import_chalk.default.yellow(`📄 ${file}:`));
+    links.forEach((link) => {
+      console.log(import_chalk.default.red(`  ✗ ${link.url}`));
+      console.log(import_chalk.default.gray(`    • Text: ${link.text}`));
+      console.log(import_chalk.default.gray(`    • Reason: ${link.reason}`));
+    });
+  });
+  console.log();
+  console.log(import_chalk.default.cyan(`💡 Tip: Please fix these links and run \`npx dumi check-links\` to verify`));
+  console.log(import_chalk.default.cyan(`💡 Tip: Don't forget to run \`npm run build\` after fixing the links`));
+  console.log();
+}
+var deadLinkChecker_default = (api) => {
+  const getConfig = () => {
+    const themeConfig = api.config.themeConfig || {};
+    let userConfig = themeConfig == null ? void 0 : themeConfig.deadLinkChecker;
+    if (!userConfig) {
+      userConfig = { enable: false };
+    }
+    const config = (0, import_lodash.default)({}, defaultConfig, userConfig);
+    if (!config.enable) {
+      return processConfig({
+        ...config,
+        // 设置为空数组，使插件不执行任何检查
+        fileExtensions: []
+      });
+    }
+    return processConfig(config);
+  };
+  const checkLinks = async (onBeforeCheck) => {
+    const config = getConfig();
+    if (config.fileExtensions.length === 0) {
+      return;
+    }
+    onBeforeCheck == null ? void 0 : onBeforeCheck();
+    console.log(import_chalk.default.gray("🔍 Checking for dead links..."));
+    const result = await runCheck(config);
+    generateReport(result);
+    if (!result.success && config.failOnError) {
+      process.exit(1);
+    }
+  };
+  return checkLinks;
+};

package/dist/plugin/index.js

@@ -32,12 +32,15 @@ __export(plugin_exports, {
   default: () => plugin_default
 });
 module.exports = __toCommonJS(plugin_exports);
+var import_chalk = __toESM(require("chalk"));
 var import_plugin_utils = require("dumi/plugin-utils");
 var path = __toESM(require("path"));
 var import_antVReactTechStack = require("./antVReactTechStack");
+var import_deadLinkChecker = __toESM(require("./deadLinkChecker"));
 var import_examples = require("./examples");
 var import_rehypeObservable = __toESM(require("./rehypeObservable"));
 var import_remarkFeedback = __toESM(require("./remarkFeedback"));
+var import_sitemapGenerator = __toESM(require("./sitemapGenerator"));
 var PAGES_DIR = (0, import_plugin_utils.winPath)(path.join(__dirname, "../pages"));
 var MOCK_META = { frontmatter: { title: "mock-meta" }, texts: [], toc: [] };
 var plugin_default = (api) => {
@@ -172,4 +175,15 @@ export default function ThemeAntVContextWrapper() {
   });
   api.addTmpGenerateWatcherPaths(() => [path.resolve(process.cwd(), "examples")]);
   api.registerTechStack(() => new import_antVReactTechStack.AntVReactTechStack());
+  const checkLinks = (0, import_deadLinkChecker.default)(api);
+  api.registerCommand({
+    name: "check-links",
+    fn: async () => await checkLinks()
+  });
+  api.onBuildHtmlComplete(async () => {
+    await checkLinks(() => {
+      console.log(import_chalk.default.green("🚀 Build completed."));
+    });
+    (0, import_sitemapGenerator.default)(api);
+  });
 };

package/dist/plugin/sitemapGenerator.js

@@ -0,0 +1,103 @@
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/plugin/sitemapGenerator.ts
+var sitemapGenerator_exports = {};
+__export(sitemapGenerator_exports, {
+  default: () => generateSitemap
+});
+module.exports = __toCommonJS(sitemapGenerator_exports);
+var import_chalk = __toESM(require("chalk"));
+var import_fs = __toESM(require("fs"));
+var import_lodash = require("lodash");
+var import_moment = __toESM(require("moment"));
+var import_path = __toESM(require("path"));
+var import_xmlbuilder = __toESM(require("xmlbuilder"));
+var defaultConfig = {
+  enable: true,
+  outputDir: "dist",
+  filename: "sitemap.xml"
+};
+var currentDateTime = (0, import_moment.default)().format("YYYY-MM-DDTHH:mm:ss+00:00");
+function generateUrls(config) {
+  const urls = [];
+  function walkDir(currentPath) {
+    const files = import_fs.default.readdirSync(currentPath);
+    files.forEach((file) => {
+      const fullPath = import_path.default.join(currentPath, file);
+      const stat = import_fs.default.statSync(fullPath);
+      if (stat.isDirectory()) {
+        walkDir(fullPath);
+      } else if (stat.isFile() && import_path.default.extname(file) === ".html") {
+        const relativePath = import_path.default.relative(config.outputDir, fullPath);
+        let url = `${config.siteUrl}/${relativePath.replace(/\\/g, "/")}`;
+        if (url.endsWith("/index.html") && !url.match(/\/:(\w+)/) && !url.includes("/zh/")) {
+          url = url.replace(/\/index\.html$/, "");
+          urls.push(url);
+        }
+      }
+    });
+  }
+  walkDir(config.outputDir);
+  return urls;
+}
+function writeSitemap(config, urls) {
+  const root = import_xmlbuilder.default.create("urlset", {
+    version: "1.0",
+    encoding: "utf-8"
+  }).att("xmlns", "http://www.sitemaps.org/schemas/sitemap/0.9").att("xmlns:xsi", "http://www.w3.org/2001/XMLSchema-instance").att(
+    "xsi:schemaLocation",
+    "http://www.sitemaps.org/schemas/sitemap/0.9 http://www.sitemaps.org/schemas/sitemap/0.9/sitemap.xsd"
+  );
+  root.comment(` Created By G6 Sitemap Generator,  Generated at: ${currentDateTime} `);
+  urls.forEach((url) => {
+    const loc = url.replace(/\/index\.html$/, "");
+    const depth = url.split("/").length - 3;
+    const priority = Math.max(0.5, 1 - depth * 0.1).toFixed(2);
+    root.ele("url").ele("loc", loc).up().ele("lastmod", currentDateTime).up().ele("priority", priority);
+  });
+  const sitemapContent = root.end({ pretty: true });
+  import_fs.default.writeFileSync(import_path.default.join(config.outputDir, config.filename), sitemapContent);
+  console.log(import_chalk.default.green(`✅ Sitemap generated including ${urls.length} urls. `));
+}
+function generateSitemap(api) {
+  const getConfig = () => {
+    const themeConfig = api.config.themeConfig || {};
+    let userConfig = themeConfig == null ? void 0 : themeConfig.sitemap;
+    if (!userConfig) {
+      userConfig = { enable: false };
+    }
+    return (0, import_lodash.merge)({ siteUrl: themeConfig.siteUrl }, defaultConfig, userConfig);
+  };
+  const config = getConfig();
+  if (!config.enable) {
+    return;
+  }
+  const urls = generateUrls(config);
+  writeSitemap(config, urls);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@antv/dumi-theme-antv",
-  "version": "0.7.0",
+  "version": "0.7.1",
   "description": "AntV website theme based on dumi2.",
   "keywords": [
     "dumi",
@@ -52,6 +52,8 @@
     "@petercatai/assistant": "^2.0.24",
     "@stackblitz/sdk": "^1.11.0",
     "antd": "^4.24.16",
+    "chalk": "^4.1.2",
+    "cheerio": "^1.0.0-rc.12",
     "classnames": "^2.5.1",
     "codesandbox": "^2.2.3",
     "d3-dsv": "^3.0.1",
@@ -64,8 +66,10 @@
     "insert-css": "^2.0.0",
     "leancloud-storage": "^4.15.2",
     "lodash-es": "^4.17.21",
+    "lodash.merge": "^4.6.2",
     "monaco-editor": "^0.25.2",
     "nprogress": "^0.2.0",
+    "p-limit": "^3.1.0",
     "parse-github-url": "^1.0.3",
     "rc-drawer": "^4.4.3",
     "rc-footer": "^0.6.8",
@@ -92,7 +96,8 @@
     "unist-util-visit": "^4.1.2",
     "uri-parse": "^1.0.0",
     "valtio": "^1.13.2",
-    "video-react": "^0.16.0"
+    "video-react": "^0.16.0",
+    "xmlbuilder": "^15.1.1"
   },
   "devDependencies": {
     "@commitlint/cli": "^17.8.1",