dumi 2.1.2 → 2.1.4

package/dist/assetParsers/atom.js

@@ -48,7 +48,8 @@ var AtomAssetsParser = class {
   async parse() {
     if (!this.parseDeferrer || this.unresolvedFiles.length) {
       this.parseDeferrer = (async () => {
-        await this.parser.patch(this.unresolvedFiles.splice(0));
+        this.unresolvedFiles.splice(0);
+        await this.parser.patch([]);
         const resolver = new import_parser.SchemaResolver(await this.parser.parse());
         const result = {
           components: {},

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

@@ -21,6 +21,10 @@ export interface IPreviewerProps {
      * debug mark (will only render in dev by default)
      */
     debug?: boolean;
+    /**
+     * display the source code or not by default
+     */
+    defaultShowCode?: boolean;
     /**
      * url for render current demo in a single page
      */
@@ -85,6 +89,7 @@ export interface IRouteMeta {
         };
         atomId?: string;
         filename?: string;
+        debug?: boolean;
         [key: string]: any;
     };
     toc: {
@@ -110,8 +115,8 @@ export interface IRouteMeta {
     }[];
     tabs?: {
         key: string;
-        name?: string;
-        nameIntlId?: string;
+        title?: string;
+        titleIntlId?: string;
         components: {
             default: ComponentType;
             Extra: ComponentType;
@@ -138,15 +143,15 @@ export declare type ILocalesConfig = ILocale[];
 export interface INavItem {
     title: string;
     link: string;
-    order: number;
+    order?: number;
     activePath?: string;
     [key: string]: any;
 }
 export interface ISidebarItem {
     title: string;
     link: string;
-    order: number;
-    frontmatter: IRouteMeta['frontmatter'];
+    order?: number;
+    frontmatter?: IRouteMeta['frontmatter'];
     [key: string]: any;
 }
 export interface ISidebarGroup {
@@ -163,7 +168,7 @@ export interface IThemeConfig {
         children?: INavItem[];
     })[]>;
     sidebar?: Record<string, ISidebarGroup[]>;
-    footer?: string;
+    footer?: string | false;
     prefersColor: {
         default: 'light' | 'dark' | 'auto';
         switch: boolean;

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;
+    var _a, _b, _c;
     (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") {
@@ -61,12 +61,15 @@ var derivative_default = (api) => {
     }
     try {
       const tsconfig = require(import_path.default.join(api.cwd, "tsconfig.json"));
-      const expected = [".dumi/**/*", ".dumirc.ts"];
+      const expected = [".dumi/**/*"];
+      if ((_c = api.service.configManager) == null ? void 0 : _c.mainConfigFile) {
+        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 `.dumi/**/*` & `.dumirc.ts` 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 \`defineConfig\` works.`);
       }
     } catch {
     }
@@ -106,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

@@ -111,13 +111,26 @@ import deepmerge from '${(0, import_plugin_utils.winPath)(import_path.default.di
 export const patchRoutes = ({ routes }) => {
   Object.values(routes).forEach((route) => {
     if (filesMeta[route.id]) {
-      route.meta = deepmerge(route.meta, filesMeta[route.id]);
+      if (process.env.NODE_ENV === 'production' && (route.meta?.frontmatter?.debug || filesMeta[route.id].frontmatter.debug)) {
+        // hide route in production which set hide frontmatter
+        delete routes[route.id];
+      } else {
+        // merge meta to route object
+        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],
-      }));
+        // apply real tab data from 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/routes.js

@@ -36,7 +36,11 @@ function normalizeDocDir(docDir) {
   return typeof docDir === "object" ? docDir : { dir: docDir };
 }
 function kebabCaseRoutePath(routePath) {
-  return routePath.split("/").map((p) => import_plugin_utils.lodash.kebabCase(p)).join("/");
+  const replacer = (_, s1, s2, i) => {
+    const symbol = ["", "/"].includes(s1) || !i ? "" : "-";
+    return `${s1 || ""}${symbol}${s2.toLowerCase()}`;
+  };
+  return routePath.replace(/(.)?([A-Z][^A-Z/])/g, replacer).replace(/(.)?([A-Z]+)/g, replacer);
 }
 function localizeUmiRoute(route, locales) {
   const locale = locales.find((locale2) => route.path.endsWith(`/${locale2.id}`) && import_path.default.parse(route.file).name.endsWith(`.${locale2.id}`));

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");
@@ -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/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.2",
+  "version": "2.1.4",
   "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/ColorSwitch/index.js

@@ -10,7 +10,7 @@ function _iterableToArrayLimit(arr, i) { var _i = arr == null ? null : typeof Sy
 
 function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
 
-import { FormattedMessage, useIntl, usePrefersColor, useSiteData } from 'dumi';
+import { useIntl, usePrefersColor, useSiteData } from 'dumi';
 import React from 'react';
 import "./index.less";
 
@@ -68,19 +68,14 @@ var ColorSwitch = function ColorSwitch() {
       return setPrefersColor(ev.target.value);
     },
     value: prefersColor
-  }, /*#__PURE__*/React.createElement("option", {
-    value: "light"
-  }, /*#__PURE__*/React.createElement(FormattedMessage, {
-    id: "header.color.mode.light"
-  })), /*#__PURE__*/React.createElement("option", {
-    value: "dark"
-  }, /*#__PURE__*/React.createElement(FormattedMessage, {
-    id: "header.color.mode.dark"
-  })), /*#__PURE__*/React.createElement("option", {
-    value: "auto"
-  }, /*#__PURE__*/React.createElement(FormattedMessage, {
-    id: "header.color.mode.auto"
-  }))));
+  }, ['light', 'dark', 'auto'].map(function (c) {
+    return /*#__PURE__*/React.createElement("option", {
+      value: c,
+      key: c
+    }, intl.formatMessage({
+      id: "header.color.mode.".concat(c)
+    }));
+  })));
 };
 
 export default ColorSwitch;

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/PreviewerActions/index.js

@@ -97,7 +97,7 @@ var PreviewerActions = function PreviewerActions(props) {
     "data-dumi-tooltip": intl.formatMessage({
       id: 'previewer.actions.separate'
     })
-  }, /*#__PURE__*/React.createElement(IconExternalLink, null)), /*#__PURE__*/React.createElement(PreviewerActionsExtra, props), !(props !== null && props !== void 0 && props.forceShowCode) && /*#__PURE__*/React.createElement("button", {
+  }, /*#__PURE__*/React.createElement(IconExternalLink, null)), /*#__PURE__*/React.createElement(PreviewerActionsExtra, props), !props.forceShowCode && /*#__PURE__*/React.createElement("button", {
     className: "dumi-default-previewer-action-btn",
     type: "button",
     onClick: function onClick() {