dumi 2.1.5 → 2.1.7

package/dist/assetParsers/atom.d.ts

@@ -4,6 +4,7 @@ declare class AtomAssetsParser {
     private resolveDir;
     private unresolvedFiles;
     private parser;
+    private isParsing;
     private parseDeferrer;
     private watcher;
     private cbs;
@@ -21,5 +22,6 @@ declare class AtomAssetsParser {
     }>;
     watch(cb: AtomAssetsParser['cbs'][number]): void;
     unwatch(cb: AtomAssetsParser['cbs'][number]): void;
+    destroyWorker(): void;
 }
 export default AtomAssetsParser;

package/dist/assetParsers/atom.js

@@ -33,6 +33,7 @@ var MAX_PARSE_SIZE = 1024 * 512;
 var AtomAssetsParser = class {
   constructor(opts) {
     this.unresolvedFiles = [];
+    this.isParsing = false;
     this.watcher = null;
     this.cbs = [];
     const absEntryFile = import_path.default.resolve(opts.resolveDir, opts.entryFile);
@@ -42,28 +43,33 @@ var AtomAssetsParser = class {
     this.parser = new import_parser.SchemaParser({
       entryPath: absEntryFile,
       basePath: (0, import_utils.getProjectRoot)(opts.resolveDir),
-      unPkgHost: opts.unpkgHost ?? "https://unpkg.com"
+      unPkgHost: opts.unpkgHost ?? "https://unpkg.com",
+      mode: "worker"
     });
   }
   async parse() {
-    if (!this.parseDeferrer || this.unresolvedFiles.length) {
+    if (!this.parseDeferrer || this.unresolvedFiles.length && !this.isParsing) {
+      this.isParsing = true;
       this.parseDeferrer = (async () => {
-        this.unresolvedFiles.splice(0);
-        await this.parser.patch([]);
-        const resolver = new import_parser.SchemaResolver(await this.parser.parse());
+        await this.parser.patch(this.unresolvedFiles.splice(0));
+        const resolver = new import_parser.SchemaResolver(await this.parser.parse(), {
+          mode: "worker"
+        });
         const result = {
           components: {},
           functions: {}
         };
         const fallbackProps = { type: "object", properties: {} };
         const fallbackSignature = { arguments: [] };
-        resolver.componentList.forEach((id) => {
+        const componentList = await resolver.componentList;
+        const functionList = await resolver.functionList;
+        for (const id of componentList) {
           const needResolve = this.resolveFilter({
             id,
             type: "COMPONENT",
-            ids: resolver.componentList
+            ids: componentList
           });
-          let propsConfig = needResolve ? resolver.getComponent(id).props : fallbackProps;
+          let propsConfig = needResolve ? (await resolver.getComponent(id)).props : fallbackProps;
           const size = Buffer.byteLength(JSON.stringify(propsConfig));
           if (size > MAX_PARSE_SIZE) {
             propsConfig = fallbackProps;
@@ -75,14 +81,14 @@ var AtomAssetsParser = class {
             title: id,
             propsConfig
           };
-        });
-        resolver.functionList.forEach((id) => {
+        }
+        for (const id of functionList) {
           const needResolve = this.resolveFilter({
             id,
             type: "FUNCTION",
-            ids: resolver.functionList
+            ids: functionList
           });
-          let signature = needResolve ? resolver.getFunction(id).signature : fallbackSignature;
+          let signature = needResolve ? (await resolver.getFunction(id)).signature : fallbackSignature;
           const size = Buffer.byteLength(JSON.stringify(signature));
           if (size > MAX_PARSE_SIZE) {
             signature = fallbackSignature;
@@ -94,7 +100,9 @@ var AtomAssetsParser = class {
             title: id,
             signature
           };
-        });
+        }
+        resolver.$$destroyWorker();
+        this.isParsing = false;
         return result;
       })();
     }
@@ -117,7 +125,7 @@ var AtomAssetsParser = class {
         ],
         ignoreInitial: true
       }).on("all", (ev, file) => {
-        if (["add", "change"].includes(ev) && /\.(j|t)sx?$/.test(file)) {
+        if (["add", "change"].includes(ev) && /((?<!\.d)\.ts|\.(jsx?|tsx))$/.test(file)) {
           this.unresolvedFiles.push(import_path.default.join(this.resolveDir, file));
           lazyParse();
         }
@@ -128,6 +136,13 @@ var AtomAssetsParser = class {
   unwatch(cb) {
     this.cbs.splice(this.cbs.indexOf(cb), 1);
   }
+  destroyWorker() {
+    if (this.parseDeferrer) {
+      this.parseDeferrer.finally(() => this.parser.$$destroyWorker());
+    } else {
+      this.parser.$$destroyWorker();
+    }
+  }
 };
 var atom_default = AtomAssetsParser;
 // Annotate the CommonJS export names for ESM import in node:

package/dist/client/theme-api/types.d.ts

@@ -159,6 +159,7 @@ export interface ISidebarGroup {
     children: ISidebarItem[];
     [key: string]: any;
 }
+export declare type SocialTypes = 'github' | 'weibo' | 'twitter' | 'gitlab' | 'facebook' | 'zhihu' | 'yuque' | 'linkedin';
 export interface IThemeConfig {
     name?: string;
     logo?: string | false;
@@ -173,6 +174,9 @@ export interface IThemeConfig {
         default: 'light' | 'dark' | 'auto';
         switch: boolean;
     };
+    socialLinks: {
+        [key in SocialTypes]: string;
+    };
     [key: string]: any;
 }
 export declare type IRoutesById = Record<string, {

package/dist/features/configPlugins/index.js

@@ -28,7 +28,8 @@ var configPlugins_default = (api) => {
     resolve: {
       docDirs: ["docs"],
       atomDirs: [{ type: "component", dir: "src" }],
-      codeBlockMode: "active"
+      codeBlockMode: "active",
+      forceKebabCaseRouting: true
     },
     themeConfig: {
       footer: `Copyright \xA9 ${new Date().getFullYear()} | Powered by <a href="https://d.umijs.org" target="_blank" rel="noreferrer">dumi</a>`,

package/dist/features/configPlugins/schema.js

@@ -32,7 +32,8 @@ function getSchemas() {
       atomDirs: Joi.array().items(Joi.object({ type: Joi.string(), dir: Joi.string() })).optional(),
       entityDirs: Joi.forbidden().error(new Error("`entityDirs` is already deprecated, please rename it to `atomDirs` in `.dumirc.ts`")),
       codeBlockMode: Joi.string().valid("active", "passive").optional(),
-      entryFile: Joi.string().optional()
+      entryFile: Joi.string().optional(),
+      forceKebabCaseRouting: Joi.bool().optional()
     }).optional(),
     extraRemarkPlugins: getUnifiedPluginSchema,
     extraRehypePlugins: getUnifiedPluginSchema,

package/dist/features/derivative.js

@@ -50,6 +50,7 @@ var derivative_default = (api) => {
     var _a, _b, _c, _d;
     (0, import_assert.default)(!api.config.mpa, "MPA mode is not supported in dumi!");
     (0, import_assert.default)(!api.config.vite, "Vite mode is not supported yet!");
+    (0, import_assert.default)(!api.config.phantomDependency, "PhantomDependency is not supported yet!");
     if (typeof api.config.mfsu === "object") {
       (0, import_assert.default)(api.config.mfsu.strategy !== "eager", "MFSU eager mode is not supported yet!");
       (0, import_assert.default)(api.config.mfsu.esbuild !== true, "MFSU esbuild bundler is not supported yet!");
@@ -135,6 +136,8 @@ var derivative_default = (api) => {
     }
   });
   api.registerPlugins([require.resolve("../../compiled/@umijs/plugins")]);
+  if (api.isPluginEnable("prepare"))
+    api.skipPlugins(["prepare"]);
 };
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {

package/dist/features/exportStatic.js

@@ -23,6 +23,7 @@ __export(exportStatic_exports, {
 });
 module.exports = __toCommonJS(exportStatic_exports);
 var import_constants = require("../constants");
+var import_plugin_utils = require("umi/plugin-utils");
 var import_assets = require("./assets");
 var exportStatic_default = (api) => {
   const prevExtraRoutePaths = [];
@@ -49,10 +50,14 @@ var exportStatic_default = (api) => {
         memo.exportStatic.extraRoutePaths = async () => {
           const examples = (0, import_assets.getExampleAssets)();
           const userExtraPaths = [];
+          const isSupportDisablePrerender = import_plugin_utils.semver.gte(api.appData.umi.version, "4.0.48");
           for (const prev of prevExtraRoutePaths) {
             userExtraPaths.push(...typeof prev === "function" ? await prev() : prev);
           }
-          return userExtraPaths.concat(examples.map(({ id }) => `/${import_constants.SP_ROUTE_PREFIX}demos/${id}`));
+          return userExtraPaths.concat(examples.map(({ id }) => {
+            const demoPath = `/${import_constants.SP_ROUTE_PREFIX}demos/${id}`;
+            return isSupportDisablePrerender ? { path: demoPath, prerender: false } : demoPath;
+          }));
         };
       }
       return memo;

package/dist/features/parser.js

@@ -51,7 +51,7 @@ var parser_default = (api) => {
     (0, import_assert.default)((_a = api.userConfig.resolve) == null ? void 0 : _a.entryFile, "`resolve.entryFile` must be configured when `apiParser` enable");
     return memo;
   });
-  api.onStart(async () => {
+  api.onCheckPkgJSON(async () => {
     const {
       default: AtomAssetsParser
     } = require("../assetParsers/atom");
@@ -77,6 +77,12 @@ var parser_default = (api) => {
       writeAtomsMetaFile(prevData);
     }
   });
+  api.onBuildComplete({
+    stage: Infinity,
+    fn() {
+      api.service.atomParser.destroyWorker();
+    }
+  });
 };
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {});

package/dist/features/routes.js

@@ -42,16 +42,17 @@ function kebabCaseRoutePath(routePath) {
   };
   return routePath.replace(/(.)?([A-Z][^A-Z/])/g, replacer).replace(/(.)?([A-Z]+)/g, replacer);
 }
-function localizeUmiRoute(route, locales) {
+function localizeUmiRoute(route, locales, forceKebabCase) {
   const locale = locales.find((locale2) => route.path.endsWith(`/${locale2.id}`) && import_path.default.parse(route.file).name.endsWith(`.${locale2.id}`));
+  const format = forceKebabCase ? kebabCaseRoutePath : (str) => str;
   if (locale) {
     const base = !("base" in locale) || locale.base === "/" ? "" : locale.base.replace(/^(\/)(.+)$/, "$2$1");
     const suffix = "suffix" in locale ? locale.suffix : "";
-    route.path = `${base}${kebabCaseRoutePath(route.path.replace(new RegExp(`/${locale.id}$`), "").replace(/((^|\/)(index|README))$/, ""))}${suffix}`;
+    route.path = `${base}${format(route.path.replace(new RegExp(`/${locale.id}$`), "").replace(/((^|\/)(index|README))$/, ""))}${suffix}`;
     route.absPath = route.path !== "/" ? `/${route.path}` : route.path;
   } else {
-    route.path = kebabCaseRoutePath(route.path);
-    route.absPath = kebabCaseRoutePath(route.absPath);
+    route.path = format(route.path);
+    route.absPath = format(route.absPath);
   }
 }
 function flatRoute(route, docLayoutId) {
@@ -174,7 +175,7 @@ var routes_default = (api) => {
     at ${route.file}`);
       } else if (!route.isLayout) {
         flatRoute(route, docLayoutId);
-        localizeUmiRoute(route, api.config.locales);
+        localizeUmiRoute(route, api.config.locales, api.config.resolve.forceKebabCaseRouting);
       }
     });
     if (Object.values(pages).every((route) => route.path !== "*")) {
@@ -191,7 +192,8 @@ var routes_default = (api) => {
       path: `${import_constants.SP_ROUTE_PREFIX}demos/:id`,
       absPath: `/${import_constants.SP_ROUTE_PREFIX}demos/:id`,
       parentId: demoLayoutId,
-      file: getClientPageFile("client/pages/Demo", api.cwd)
+      file: getClientPageFile("client/pages/Demo", api.cwd),
+      prerender: false
     };
     return routes;
   });

package/dist/types.d.ts

@@ -33,6 +33,7 @@ interface IDumiExtendsConfig {
         }[];
         codeBlockMode: 'active' | 'passive';
         entryFile?: string;
+        forceKebabCaseRouting: boolean;
     };
     locales: ILocalesConfig;
     themeConfig: IThemeConfig;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dumi",
-  "version": "2.1.5",
+  "version": "2.1.7",
   "description": "📖 Documentation Generator of React Component",
   "keywords": [
     "generator",
@@ -80,13 +80,13 @@
     "@swc/core": "^1.2.224",
     "@types/hast": "^2.3.4",
     "@types/mdast": "^3.0.10",
-    "@umijs/bundler-utils": "^4.0.33",
-    "@umijs/core": "^4.0.33",
+    "@umijs/bundler-utils": "^4.0.48",
+    "@umijs/core": "^4.0.48",
     "animated-scroll-to": "^2.3.0",
     "classnames": "2.3.2",
     "codesandbox": "^2.2.3",
     "deepmerge": "^4.2.2",
-    "dumi-afx-deps": "^1.0.0-alpha.6",
+    "dumi-afx-deps": "^1.0.0-alpha.12",
     "dumi-assets-types": "2.0.0-alpha.0",
     "enhanced-resolve": "^5.10.0",
     "estree-util-to-js": "^1.1.0",
@@ -122,7 +122,7 @@
     "remark-rehype": "^10.1.0",
     "sass": "^1.55.0",
     "sitemap": "^7.1.1",
-    "umi": "^4.0.33",
+    "umi": "^4.0.48",
     "unified": "^10.1.2",
     "unist-util-visit": "^4.1.0",
     "unist-util-visit-parents": "^5.1.1",
@@ -141,7 +141,7 @@
     "@types/pluralize": "^0.0.29",
     "@types/react": "^18.0.16",
     "@types/react-copy-to-clipboard": "^5.0.4",
-    "@umijs/lint": "^4.0.33",
+    "@umijs/lint": "^4.0.48",
     "@umijs/plugins": "4.0.32",
     "dumi-theme-mobile": "workspace:*",
     "eslint": "^8.20.0",

package/theme-default/locales/en-US.json

@@ -3,6 +3,14 @@
   "header.color.mode.light": "Light Mode",
   "header.color.mode.dark": "Dark Mode",
   "header.color.mode.auto": "Follow System",
+  "header.social.github": "GitHub",
+  "header.social.weibo": "Weibo",
+  "header.social.twitter": "Twitter",
+  "header.social.gitlab": "GitLab",
+  "header.social.facebook": "Facebook",
+  "header.social.zhihu": "Zhihu",
+  "header.social.yuque": "Yuque",
+  "header.social.linkedin": "Linkedin",
   "previewer.actions.code.expand": "Show Code",
   "previewer.actions.code.shrink": "Hide Code",
   "previewer.actions.codesandbox": "Open in CodeSandbox",

package/theme-default/locales/zh-CN.json

@@ -3,6 +3,14 @@
   "header.color.mode.light": "亮色模式",
   "header.color.mode.dark": "暗色模式",
   "header.color.mode.auto": "跟随系统",
+  "header.social.github": "GitHub",
+  "header.social.weibo": "微博",
+  "header.social.twitter": "Twitter",
+  "header.social.gitlab": "GitLab",
+  "header.social.facebook": "Facebook",
+  "header.social.zhihu": "知乎",
+  "header.social.yuque": "语雀",
+  "header.social.linkedin": "Linkedin",
   "previewer.actions.code.expand": "展开代码",
   "previewer.actions.code.shrink": "收起代码",
   "previewer.actions.codesandbox": "在 CodeSandbox 中打开",

package/theme-default/slots/Header/index.js

@@ -20,7 +20,8 @@ import Logo from "dumi/theme/slots/Logo";
 import Navbar from "dumi/theme/slots/Navbar";
 import RtlSwitch from "dumi/theme/slots/RtlSwitch";
 import SearchBar from "dumi/theme/slots/SearchBar";
-import React, { useState } from 'react';
+import React, { useMemo, useState } from 'react';
+import SocialIcon from "../SocialIcon";
 import "./index.less";
 
 var Header = function Header() {
@@ -35,6 +36,14 @@ var Header = function Header() {
   var _useSiteData = useSiteData(),
       themeConfig = _useSiteData.themeConfig;
 
+  var socialIcons = useMemo(function () {
+    return themeConfig.socialLinks ? Object.keys(themeConfig.socialLinks).slice(0, 5).map(function (key) {
+      return {
+        icon: key,
+        link: themeConfig.socialLinks[key]
+      };
+    }) : [];
+  }, [themeConfig.socialLinks]);
   return /*#__PURE__*/React.createElement("div", {
     className: "dumi-default-header",
     "data-static": Boolean(frontmatter.hero) || undefined,
@@ -50,7 +59,13 @@ var Header = function Header() {
     className: "dumi-default-header-right"
   }, /*#__PURE__*/React.createElement(Navbar, null), /*#__PURE__*/React.createElement("div", {
     className: "dumi-default-header-right-aside"
-  }, /*#__PURE__*/React.createElement(SearchBar, null), /*#__PURE__*/React.createElement(LangSwitch, null), /*#__PURE__*/React.createElement(RtlSwitch, null), themeConfig.prefersColor.switch && /*#__PURE__*/React.createElement(ColorSwitch, null), /*#__PURE__*/React.createElement(HeaderExtra, null))), /*#__PURE__*/React.createElement("button", {
+  }, /*#__PURE__*/React.createElement(SearchBar, null), /*#__PURE__*/React.createElement(LangSwitch, null), /*#__PURE__*/React.createElement(RtlSwitch, null), themeConfig.prefersColor.switch && /*#__PURE__*/React.createElement(ColorSwitch, null), socialIcons.map(function (item) {
+    return /*#__PURE__*/React.createElement(SocialIcon, {
+      icon: item.icon,
+      link: item.link,
+      key: item.link
+    });
+  }), /*#__PURE__*/React.createElement(HeaderExtra, null))), /*#__PURE__*/React.createElement("button", {
     type: "button",
     className: "dumi-default-header-menu-btn",
     onClick: function onClick(ev) {

package/theme-default/slots/SocialIcon/index.d.ts

@@ -0,0 +1,13 @@
+import { SocialTypes } from "../../../theme-api/types";
+import { FunctionComponent, type FC } from 'react';
+import './index.less';
+export declare type SocialIconProps = {
+    icon: SocialTypes;
+    link: string;
+};
+export declare type PresetSocialIcon = {
+    Icon: FunctionComponent;
+    titleIntlId: string;
+};
+declare const SocialIcon: FC<SocialIconProps>;
+export default SocialIcon;

package/theme-default/slots/SocialIcon/index.js

@@ -0,0 +1,45 @@
+import { ReactComponent as IconFacebook } from '@ant-design/icons-svg/inline-svg/outlined/facebook.svg';
+import { ReactComponent as IconGitHub } from '@ant-design/icons-svg/inline-svg/outlined/github.svg';
+import { ReactComponent as IconGitlab } from '@ant-design/icons-svg/inline-svg/outlined/gitlab.svg';
+import { ReactComponent as IconLinkedin } from '@ant-design/icons-svg/inline-svg/outlined/linkedin.svg';
+import { ReactComponent as IconTwitter } from '@ant-design/icons-svg/inline-svg/outlined/twitter.svg';
+import { ReactComponent as IconWeiBo } from '@ant-design/icons-svg/inline-svg/outlined/weibo.svg';
+import { ReactComponent as IconYuque } from '@ant-design/icons-svg/inline-svg/outlined/yuque.svg';
+import { ReactComponent as IconZhihu } from '@ant-design/icons-svg/inline-svg/outlined/zhihu.svg';
+import React, { useMemo } from 'react';
+import { useIntl } from 'react-intl';
+import "./index.less";
+var presetIconMap = {
+  github: IconGitHub,
+  weibo: IconWeiBo,
+  twitter: IconTwitter,
+  gitlab: IconGitlab,
+  facebook: IconFacebook,
+  zhihu: IconZhihu,
+  yuque: IconYuque,
+  linkedin: IconLinkedin
+};
+
+var SocialIcon = function SocialIcon(props) {
+  var icon = props.icon,
+      link = props.link;
+  var intl = useIntl();
+  var preset = useMemo(function () {
+    return {
+      Icon: presetIconMap[icon],
+      link: link
+    };
+  }, [icon, link]);
+  return /*#__PURE__*/React.createElement("a", {
+    className: "dumi-default-icon",
+    "data-dumi-tooltip": intl.formatMessage({
+      id: "header.social.".concat(icon)
+    }),
+    "data-dumi-tooltip-bottom": true,
+    target: "_blank",
+    href: preset.link,
+    rel: "noreferrer"
+  }, /*#__PURE__*/React.createElement(preset.Icon, null));
+};
+
+export default SocialIcon;

package/theme-default/slots/SocialIcon/index.less

@@ -0,0 +1,38 @@
+@import (reference) '../../styles/variables.less';
+
+.@{prefix}-icon {
+  font-size: 0;
+  line-height: 0;
+
+  [class*='-switch'] + & {
+    margin-inline-start: 15px;
+    margin-inline-end: -15px;
+    padding-inline: 15px;
+    border-inline-start: 1px solid @c-border;
+
+    @{dark-selector} & {
+      border-inline-start-color: @c-border-dark;
+    }
+  }
+
+  & + & {
+    margin-inline-start: 18px;
+  }
+
+  > svg {
+    height: 16px;
+    fill: @c-text-secondary;
+
+    @{dark-selector} & {
+      fill: @c-text-secondary-dark;
+    }
+  }
+
+  &:hover svg {
+    fill: @c-primary;
+
+    @{dark-selector} & {
+      fill: @c-primary-dark;
+    }
+  }
+}

package/theme-default/styles/variables.less

@@ -22,7 +22,7 @@
 // @dark-selector be injected by less-loader in feature/theme/index.ts
 @dark-solid-amount: 15%;
 @dark-light-amount: 22%;
-@dark-border-amount: 73%;
+@dark-border-amount: 71%;
 @c-primary-dark: darken(@c-primary, @dark-solid-amount);
 @c-warning-dark: darken(@c-warning, @dark-solid-amount);
 @c-success-dark: darken(@c-success, @dark-solid-amount);