dumi 2.1.3 → 2.1.5

package/dist/client/theme-api/openCodeSandbox.js

@@ -50,7 +50,7 @@ function getCSBData(opts) {
 
   files['sandbox.config.json'] = {
     content: JSON.stringify({
-      template: isTSX ? 'create-react-app-typescript' : 'create-react-app'
+      template: 'create-react-app'
     }, null, 2),
     isBinary: false
   }; // append package.json

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

@@ -115,8 +115,8 @@ export interface IRouteMeta {
     }[];
     tabs?: {
         key: string;
-        name?: string;
-        nameIntlId?: string;
+        title?: string;
+        titleIntlId?: string;
         components: {
             default: ComponentType;
             Extra: ComponentType;
@@ -161,7 +161,7 @@ export interface ISidebarGroup {
 }
 export interface IThemeConfig {
     name?: string;
-    logo?: string;
+    logo?: string | false;
     nav?: (INavItem & {
         children?: INavItem[];
     })[] | Record<string, (INavItem & {

package/dist/features/derivative.js

@@ -47,7 +47,7 @@ function safeExcludeInMFSU(api, excludes) {
 var derivative_default = (api) => {
   api.describe({ key: "dumi:derivative" });
   api.onCheck(() => {
-    var _a, _b, _c;
+    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!");
     if (typeof api.config.mfsu === "object") {
@@ -62,14 +62,14 @@ var derivative_default = (api) => {
     try {
       const tsconfig = require(import_path.default.join(api.cwd, "tsconfig.json"));
       const expected = [".dumi/**/*"];
-      if ((_c = api.service.configManager) == null ? void 0 : _c.mainConfigFile) {
+      if ((_d = (_c = api.service.configManager) == null ? void 0 : _c.mainConfigFile) == null ? void 0 : _d.endsWith(".ts")) {
         expected.push((0, import_plugin_utils.winPath)(import_path.default.relative(api.cwd, api.service.configManager.mainConfigFile)));
       }
       if (!expected.every((f) => {
         var _a2;
         return (_a2 = tsconfig.include) == null ? void 0 : _a2.includes(f);
       })) {
-        import_plugin_utils.logger.warn(`Please append ${expected.map((e) => `\`${e}\``).join(" & ")} into \`include\` option of \`tsconfig.json\`, to make sure \`defineConfig\` works.`);
+        import_plugin_utils.logger.warn(`Please append ${expected.map((e) => `\`${e}\``).join(" & ")} into \`include\` option of \`tsconfig.json\`, to make sure the types exported by framework works.`);
       }
     } catch {
     }
@@ -109,6 +109,9 @@ var derivative_default = (api) => {
   });
   api.modifyConfig((memo) => {
     var _a;
+    if (api.userConfig.mfsu === true) {
+      memo.mfsu = {};
+    }
     if ((_a = api.userConfig.alias) == null ? void 0 : _a["@"]) {
       memo.alias["@"] = api.userConfig.alias["@"];
     } else {

package/dist/features/meta.js

@@ -119,10 +119,17 @@ export const patchRoutes = ({ routes }) => {
         route.meta = deepmerge(route.meta, filesMeta[route.id]);
 
         // apply real tab data from id
-        route.meta.tabs = route.meta.tabs?.map(id => ({
-          ...tabs[id],
-          meta: filesMeta[id],
-        }));
+        route.meta.tabs = route.meta.tabs?.map((id) => {
+          const meta = {
+            frontmatter: { title: tabs[id].title },
+            toc: [],
+            texts: [],
+          }
+          return {
+            ...tabs[id],
+            meta: filesMeta[id] || meta,
+          }
+        });
       }
     }
   });

package/dist/features/parser.js

@@ -61,7 +61,9 @@ var parser_default = (api) => {
       unpkgHost: api.config.apiParser.unpkgHost,
       resolveFilter: api.config.apiParser.resolveFilter
     });
-    if (api.env === "development") {
+  });
+  api.onDevCompileDone(({ isFirstCompile }) => {
+    if (isFirstCompile) {
       api.service.atomParser.watch((data) => {
         prevData = data;
         writeAtomsMetaFile(prevData);

package/dist/features/routes.js

@@ -61,14 +61,16 @@ function flatRoute(route, docLayoutId) {
   }
 }
 function getClientPageFile(file, cwd) {
+  let clientFile;
   try {
-    return import_plugin_utils.resolve.sync(`dumi/dist/${file}`, {
+    clientFile = import_plugin_utils.resolve.sync(`dumi/dist/${file}`, {
       basedir: cwd,
       preserveSymlinks: false
     });
   } catch {
-    return require.resolve(`../${file}`);
+    clientFile = require.resolve(`../${file}`);
   }
+  return (0, import_plugin_utils.winPath)(clientFile);
 }
 var routes_default = (api) => {
   var _a, _b, _c;

package/dist/features/tabs.d.ts

@@ -3,8 +3,8 @@ export interface IContentTab {
     key: string;
     id?: string;
     test?: RegExp;
-    name?: string;
-    nameIntlId?: string;
+    title?: string;
+    titleIntlId?: string;
     component: string;
 }
 export declare function isTabRouteFile(file: string): boolean;

package/dist/features/tabs.js

@@ -86,8 +86,8 @@ var tabs_default = (api) => {
       index: tabs.length + index,
       key: tab.key,
       id: tab.id,
-      name: tab.name,
-      nameIntlId: tab.nameIntlId,
+      title: tab.title || import_plugin_utils.lodash.startCase(import_path.default.parse(tab.component).name),
+      titleIntlId: tab.titleIntlId,
       file: tab.component
     })));
     return routes;
@@ -101,11 +101,14 @@ var tabs_default = (api) => {
         }
       });
       tabs.forEach((tab) => {
-        metaFiles.push({
-          id: tab.id,
-          file: tab.file,
-          index: metaFiles.length
-        });
+        const isFromPlugin = tabsFromPlugins.some((item) => item.id === tab.id);
+        if (!isFromPlugin) {
+          metaFiles.push({
+            id: tab.id,
+            file: tab.file,
+            index: metaFiles.length
+          });
+        }
       });
       return metaFiles;
     }
@@ -120,7 +123,7 @@ import * as tab{{{index}}} from '{{{file}}}';
 
 export const tabs = {
   {{#tabs}}
-  '{{{id}}}': { key: '{{{key}}}', name: '{{{name}}}', nameIntlId: '{{{nameIntlId}}}', components: tab{{{index}}} },
+  '{{{id}}}': { key: '{{{key}}}', title: '{{{title}}}', titleIntlId: '{{{titleIntlId}}}', components: tab{{{index}}} },
   {{/tabs}}
 }
 `, { tabs })

package/dist/loaders/markdown/transformer/rehypeDemo.js

@@ -163,6 +163,12 @@ function rehypeDemo(opts) {
                 "snapshot",
                 "keywords"
               ];
+              const techStackOpts = {
+                type: codeType,
+                mdAbsPath: opts.fileAbsPath,
+                fileAbsPath: codeType === "external" ? parseOpts.fileAbsPath : void 0,
+                entryPointCode: parseOpts.entryPointCode
+              };
               Object.keys(restAttrs).forEach((key) => {
                 if (restAttrs[key] === "")
                   restAttrs[key] = true;
@@ -179,12 +185,7 @@ function rehypeDemo(opts) {
                   component
                 };
               }
-              Object.assign(previewerProps, await ((_b = techStack.generatePreviewerProps) == null ? void 0 : _b.call(techStack, originalProps, {
-                type: codeType,
-                mdAbsPath: opts.fileAbsPath,
-                fileAbsPath: codeType === "external" ? parseOpts.fileAbsPath : void 0,
-                entryPointCode: parseOpts.entryPointCode
-              })) || originalProps);
+              Object.assign(previewerProps, await ((_b = techStack.generatePreviewerProps) == null ? void 0 : _b.call(techStack, originalProps, techStackOpts)) || originalProps);
               if (previewerProps.description) {
                 const { unified } = await import("unified");
                 const { default: remarkParse } = await import("remark-parse");
@@ -192,7 +193,7 @@ function rehypeDemo(opts) {
                 const { default: remarkRehype } = await import("remark-rehype");
                 const { default: rehypeStringify } = await import("rehype-stringify");
                 const { convert } = require("html-to-text");
-                const result = await unified().use(remarkParse).use(remarkGfm).use(remarkRehype, { allowDangerousHtml: true }).use(rehypeStringify).process(previewerProps.description);
+                const result = await unified().use(remarkParse).use(remarkGfm).use(remarkRehype, { allowDangerousHtml: true }).use(rehypeStringify, { allowDangerousHtml: true }).process(previewerProps.description);
                 previewerProps.description = String(result.value);
                 asset.description = convert(result.value, {
                   wordwrap: false
@@ -201,7 +202,7 @@ function rehypeDemo(opts) {
               return {
                 id: asset.id,
                 component,
-                asset: techStack.generateMetadata ? await techStack.generateMetadata(asset) : asset,
+                asset: techStack.generateMetadata ? await techStack.generateMetadata(asset, techStackOpts) : asset,
                 sources
               };
             }));

package/dist/techStacks/react.js

@@ -27,20 +27,96 @@ __export(react_exports, {
 module.exports = __toCommonJS(react_exports);
 var import_core = require("@swc/core");
 var import_Visitor = __toESM(require("@swc/core/Visitor"));
+function createReturnStmt(exp, span) {
+  return {
+    type: "ReturnStatement",
+    span,
+    argument: {
+      type: "ObjectExpression",
+      span,
+      properties: [
+        {
+          type: "KeyValueProperty",
+          key: {
+            type: "Identifier",
+            span,
+            value: "default",
+            optional: false
+          },
+          value: exp
+        }
+      ]
+    }
+  };
+}
 var ReactDemoVisitor = class extends import_Visitor.default {
+  visitImportDeclaration(n) {
+    if (!n.typeOnly) {
+      const namespaceImport = n.specifiers.find((s) => s.type === "ImportNamespaceSpecifier");
+      const id = namespaceImport ? namespaceImport.local : {
+        type: "ObjectPattern",
+        span: n.span,
+        properties: n.specifiers.map((s) => {
+          var _a;
+          if (s.type === "ImportDefaultSpecifier" || s.type === "ImportSpecifier" && ((_a = s.imported) == null ? void 0 : _a.type) === "Identifier") {
+            return {
+              type: "KeyValuePatternProperty",
+              span: s.span,
+              key: s.type === "ImportSpecifier" ? s.imported : {
+                type: "Identifier",
+                span: s.span,
+                value: "default",
+                optional: false
+              },
+              value: s.local
+            };
+          }
+          return {
+            type: "AssignmentPatternProperty",
+            span: s.span,
+            key: s.local
+          };
+        }),
+        optional: false
+      };
+      return {
+        type: "VariableDeclaration",
+        kind: "const",
+        declare: false,
+        span: n.span,
+        declarations: [
+          {
+            type: "VariableDeclarator",
+            span: n.span,
+            definite: false,
+            id,
+            init: {
+              span: n.span,
+              type: "AwaitExpression",
+              argument: {
+                type: "CallExpression",
+                span: n.span,
+                callee: {
+                  type: "Import",
+                  span: n.span
+                },
+                arguments: [{ expression: n.source }]
+              }
+            }
+          }
+        ]
+      };
+    }
+    return n;
+  }
   visitExportDefaultDeclaration(n) {
-    return {
-      type: "ReturnStatement",
-      span: n.span,
-      argument: n.decl
-    };
+    if (n.decl.type !== "TsInterfaceDeclaration") {
+      return createReturnStmt(n.decl, n.span);
+    }
+    return n;
   }
   visitExportDefaultExpression(n) {
-    return {
-      type: "ReturnStatement",
-      span: n.span,
-      argument: n.expression
-    };
+    return createReturnStmt(n.expression, n.span);
   }
   visitTsType(n) {
     return n;
@@ -66,14 +142,13 @@ var ReactTechStack = class {
           target: "es2022"
         },
         module: {
-          type: "commonjs",
-          strictMode: false
+          type: "es6"
         },
         plugin: (m) => new ReactDemoVisitor().visitProgram(m)
       });
-      return `(function () {
+      return `React.lazy(async () => {
 ${code}
-})()`;
+})`;
     }
     return raw;
   }

package/dist/types.d.ts

@@ -71,16 +71,16 @@ export declare abstract class IDumiTechStack {
     /**
      * generator for return asset metadata
      */
-    abstract generateMetadata?(asset: ExampleBlockAsset): Promise<ExampleBlockAsset> | ExampleBlockAsset;
-    /**
-     * generator for return previewer props
-     */
-    abstract generatePreviewerProps?(props: IDumiDemoProps['previewerProps'], opts: {
+    abstract generateMetadata?(asset: ExampleBlockAsset, opts: {
         type: Parameters<IDumiTechStack['transformCode']>[1]['type'];
         mdAbsPath: string;
         fileAbsPath?: string;
         entryPointCode?: string;
-    }): Promise<IDumiDemoProps['previewerProps']> | IDumiDemoProps['previewerProps'];
+    }): Promise<ExampleBlockAsset> | ExampleBlockAsset;
+    /**
+     * generator for return previewer props
+     */
+    abstract generatePreviewerProps?(props: IDumiDemoProps['previewerProps'], opts: Parameters<NonNullable<IDumiTechStack['generateMetadata']>>[1]): Promise<IDumiDemoProps['previewerProps']> | IDumiDemoProps['previewerProps'];
 }
 export declare type IApi = IUmiApi & {
     config: IDumiConfig & {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dumi",
-  "version": "2.1.3",
+  "version": "2.1.5",
   "description": "📖 Documentation Generator of React Component",
   "keywords": [
     "generator",
@@ -107,7 +107,7 @@
     "prism-themes": "^1.9.0",
     "prismjs": "^1.29.0",
     "raw-loader": "^4.0.2",
-    "rc-tabs": "12.1.0-alpha.1",
+    "rc-tabs": "^12.5.6",
     "react-copy-to-clipboard": "^5.1.0",
     "react-error-boundary": "^3.1.4",
     "react-intl": "^6.1.1",

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

@@ -28,9 +28,9 @@ var ContentTabs = function ContentTabs(_ref) {
       "data-active": key === tab.key || undefined
     }, /*#__PURE__*/React.createElement("button", {
       type: "button"
-    }, tab.nameIntlId ? intl.formatMessage({
-      id: tab.nameIntlId
-    }) : tab.name || tab.meta.frontmatter.title));
+    }, tab.titleIntlId ? intl.formatMessage({
+      id: tab.titleIntlId
+    }) : tab.meta.frontmatter.title));
   })) : null;
 };
 

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

@@ -10,7 +10,7 @@ var Logo = function Logo() {
   return /*#__PURE__*/React.createElement(Link, {
     className: "dumi-default-logo",
     to: 'base' in locale ? locale.base : '/'
-  }, /*#__PURE__*/React.createElement("img", {
+  }, themeConfig.logo !== false && /*#__PURE__*/React.createElement("img", {
     src: themeConfig.logo || 'data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAIQAAACCCAMAAACww5CIAAACf1BMVEUAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAD///8YkP8AAAACCxMamv/6+voaGhoXi/YYjv8aoP8cq/8dr/8bo/8cqP8bpv8Ykv8drv8BAwUcrP8Zlf8Xjf/s7OzLy8scp/8anP8ZmP/d3d0BBArg4ODT09O7u7sEGCsKCgoanf8YlP/8/Pz09PTIyMgMTIV1dXUGKEVEREQ0NDQODg4GBgYdsv8dsf8Zl//m5uYVgOXj4+MWgtfW1tYTc87BwcERbLWzs7Ovr6+np6cQX6OgoKCTk5MMSXlwcHBra2tiYmIVFRUetf/39/fp6ekWhOkXi+QVfNvY2NjPz88TdcUSb7u6urq3t7cPYK0NUJGQkJCLi4ttbW0JO2cINFtVVVVRUVEHMFEHLEs6OjoEHDEiIiIcHBwXj/vx8fEWh+4Sb8gRbL+rq6upqakOVZiWlpaJiYmGhoYMSIF9fX15eXkKPnQLRHJMTExHR0c9PT0FHzkqKiomJiYEFyUBBw8bovfu7u4Wht4UedsUeMrFxcW9vb0RZrOkpKSampoPXZqAgIALQmtlZWUJOGJZWVkIMFcFIUExMTEwMDAtLS0DEh8Zl/v4+PgXj/QWhvEWhvAYku8YjuwUfNcUfNAVfc0RaLkSaKsRZ6kPWqENUYlbW1sCEBhkSPCkAAAAOHRSTlMA87y4BeKrltbFnUDo0MCup6D67t7ayZKGemtmWS8rEwLNso1wVEpFGaR+UDUlHwmBYls5i1oN/DMym4YAAAfTSURBVHjaxNndS1NxHMfxX5s6t1Kz1KzsuazMnqjgyxv03ovtQrYxUBEfLkREVBQf0AsFBRUUQvEiSVFQ0YsuiiIiqKC/oH+o31lzjtPZg55zttfVNnbx5ffw+X53pmx5UFl2+XLZ4zpVOPWlJFTntYyiBwF/VbX39Sv9upYU9/QHjbXe6qqayrrnylXXi0kov3GVuFiMuNqbHhIu3FcuuohZZ+jDh7mdXkwqlGtKMGmOSFzrGiYe5ZL4+vdsd/SHFyYxtIQlIdiD4ftCa39osTlxRtzwHO1tUOLm0XYk6T3asMRtdKHdUs6qv+L1l/vKgak2SYjqN+1yYg2G5NgR4Pd5/F7fk9sO3YhSkoYkaW40KCk2Rj9KUoikqmtOn8YpydE6J7xFyq5yUhxIjvZJcUfZ5EOb6oxGQmPdtEQlR4Mxupc6IoOdzWiVypabaF1BiesIS876OiSufRXtvO0DcSi2dAN+ZcclYFZsCaOps3nYUOKprDTiSWzqAioCnpIX9ep03pxkw7jYtMWx0pdn7Jb2i1jixN3cM6OGFCti0zgpyopOsw6xiZHoyHIPLIhNHdD7bWR+c7znFD3+PNp+vxhmRkNi28BoWAzBPbQHKhdlQLe4ogsoVTl4ijYjrmiKATdUdvfjh9Ely8DVHFvWe3HJMBBQ2QWAd+KSeeBxjtuxKC7ZzG07Ht0DusQlfwDfs2wZ4b2EYVBcESHO81BlcIWESXHFV7Qss5aXY1FxRSj7L7QAhv3tsaVBMVn8Ou1MFUtjW3sYKjL0jO6QWJiA7iZxysBbtDplpRT4KZbQWkUbHRMnGFUUKwuNaH1iaRJ+Tf8bDbqcWJH2HuCV+l9DpkuxtdsuGlpYHNAJ1FqNMjnE9QocOXJCPwJ309zPT9la8e5yUJwwC/jTBNWQ5EkIqEyzHROSJzvWSeFDW5M8OUArsdgMq2EmanOyGB4WSyMYAhZp2TwkJouw2mZvmusUSwtraA//m7DXZ8SsBxiQM5tGSxNuv3+ZU/NmIpfN9qDXxp1sO4LDNrE202J6cHE1TVq2f1uNiA39K9/7JJ0JwGe6nvOSZ4OA1/R0bFbyrBWoMUX2nOTZAOA3pcSXjFW7UOJnU17VAYeZv98pTvsB1KsTRVXAtqQVA/rFWSNo11SKiuRYZeknEBRn7WJ4rZKuX8pcROvBj6g4rLUZQ8NJYBo2Jb/ax2KkhKYf6I1I3oWngKqUhfgkBTCL1pics1elICaS/5Y9jk+XBdEBeJKhHZGCCLZAWTIkBqQgNlr+NbGi2wHgS1tTAbQNAxW3i1R58WWgd725ANZ7gXPFNaqagrvwt1t7aW0qiOIAPlErPqJCq6JWrW8r1ar1xf0n4NxnnpCELEKyCNmkJZSQRSCbQltooS4sVApiC10U2kWhFRUEEdGF4vuNH8g7c9NQ2pjepPcB/r5ADjlnzp2ZM+QMXHeYb+1WfO5hi5QfveYe33XJ4+d8a3MNQHbI75KhMt9z9wF4FRNcIi3wO94bAHJiQHCHNgmgh3QD8D1MCK6I+KeNCUgbgFFRcEX8Qwhov014o/juUlEoxeqrgpsA7oWp4AZprnpv1ANgShFcoU4a+36jMgOuVGYmnuJ1Wb0hKWqCC8QCgI4dqyfRbNCFoqDBX7Xz6C0AS660K3UKQCdhuqAbdqFT+B8mAXQTbhtbpM7ng4Yn1oytOwFMu5AP9QGAa4Qz8lFwvFWIH6G7Qjijc8/LDueDyvd4z151EYBvwOF+lRFTAK6TGi+ACWdLk0ozANqvkpojAFJKRnCSlFt3m8pLc9bJTylVn64ty9rJfEl1cpVKbH3uJ2v1QleUqOCI2h9xeeP0aVqLCA4JSLk6s7hu6CbkqOAIGpyB7iRZ5xLvFWlHEkITyjK/41/v9h0AC3lngpCz0PXWf0yDUcmBhFDt0T/flx8CkNL8VLAZjUhvAHSQek5AtyALdqP5e9BdbPCkZsbuFRKVvlRHs/W1AfC902yNgoriWwCeqw1fSL+J2VkWNBF8vckr6mPQ3ZcjtkVBA/3z4Ju6Bs5ANzck2BQFpUMTxlVZQ4ege95vUxRUHoPOe5s01OWBbryf2hEFDX4Fc4Vs4gaYZ3ZEQeXBJPgMcFPnwYzJVmeE6jGsGCNAE/rAlPIBamkMQv9YCLpzxJRjYMr5BLXyg5EvgTlKTOoEkw2LUct6dTz4ojqCNO04mMm4ZE150mhMuQ+jHppwAUxqUM5QK9qkPLIE5jhpygkvmHJYiW45FaL8IwmdZy9pUtc2MK9HtvgloZngJyMVp3tJ846ASb7Q1NYrg1JN+ukDs4e05LwHTO5bUKG0tRBEeXAKzJ3rpEXdB8C9fBIWKW0hhOBIBdy2K6R11zvALY6EFYE21yHF4OdKEkz7ObIlXXvAhV4OquoApaYbpCo9qayA29lLturibhimSgOSFjG1ILRwYnwShn09xArnT8PwdnHML6n+hl+2gD8Wjj+rLMOwq49Y5dZpVKUWS++VcCwdCdT5/Uhck5SH45VpVO3qJFbq2Y5Vvly2VBgQY5KqKWI6HY+n06KiqVJMSQyP/37wB6v29xGrnThyEDWh5dyr+fJscbQw/OjRcGG0OFvO3n+QSqKm7exlYgsvNgolkyFs1HGV2OQgTGsjNjnVBtO8Owj3nwbhgWnttgWxy2PaoWaC+AuAXqWYKHupMgAAAABJRU5ErkJggg==',
     alt: themeConfig.name
   }), themeConfig.name);