dumi 2.1.1 → 2.1.3

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/DumiDemo.js

@@ -29,7 +29,9 @@ export var DumiDemo = function DumiDemo(props) {
 
   var _demos$props$demo$id = demos[props.demo.id],
       component = _demos$props$demo$id.component,
-      asset = _demos$props$demo$id.asset;
+      asset = _demos$props$demo$id.asset; // hide debug demo in production
+
+  if (process.env.NODE_ENV === 'production' && props.previewerProps.debug) return null;
 
   if (props.demo.inline) {
     return /*#__PURE__*/React.createElement(DemoErrorBoundary, null, /*#__PURE__*/createElement(component));

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

@@ -18,10 +18,14 @@ export var DumiDemoGrid = function DumiDemoGrid(props) {
   var _useRouteMeta = useRouteMeta(),
       fm = _useRouteMeta.frontmatter;
 
-  var generator = useCallback(function (fm, items) {
+  var generator = useCallback(function (fm, oItems) {
     var _fm$demo;
 
     var cols = [];
+    var items = process.env.NODE_ENV === 'production' ? // hide debug demo in production
+    oItems.filter(function (d) {
+      return !d.previewerProps.debug;
+    }) : oItems;
 
     if ((_fm$demo = fm.demo) !== null && _fm$demo !== void 0 && _fm$demo.cols && fm.demo.cols > 1 && ( // compatible for ssr env
     typeof window === 'undefined' || window.innerWidth > 1024)) {

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,6 +115,8 @@ export interface IRouteMeta {
     }[];
     tabs?: {
         key: string;
+        name?: string;
+        nameIntlId?: string;
         components: {
             default: ComponentType;
             Extra: ComponentType;
@@ -136,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 {
@@ -161,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 {
     }

package/dist/features/meta.js

@@ -111,13 +111,19 @@ 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 => ({
+          ...tabs[id],
+          meta: filesMeta[id],
+        }));
+      }
     }
   });
 }

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}`));
@@ -133,7 +137,7 @@ var routes_default = (api) => {
       const base = import_path.default.join(api.cwd, dir);
       const dirRoutes = (0, import_core.getConventionRoutes)({
         base,
-        exclude: [/.*(?<!md)$/, /(\/|^)(\.|_\/)/]
+        exclude: [/.*(?<!md)$/, /(\/|^)(\.|_)/]
       });
       Object.entries(dirRoutes).forEach(([key, route]) => {
         route.id = `${dir}/${key}`;

package/dist/features/tabs.d.ts

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

package/dist/features/tabs.js

@@ -86,6 +86,8 @@ var tabs_default = (api) => {
       index: tabs.length + index,
       key: tab.key,
       id: tab.id,
+      name: tab.name,
+      nameIntlId: tab.nameIntlId,
       file: tab.component
     })));
     return routes;
@@ -118,7 +120,7 @@ import * as tab{{{index}}} from '{{{file}}}';
 
 export const tabs = {
   {{#tabs}}
-  '{{{id}}}': { key: '{{{key}}}', components: tab{{{index}}} },
+  '{{{id}}}': { key: '{{{key}}}', name: '{{{name}}}', nameIntlId: '{{{nameIntlId}}}', components: tab{{{index}}} },
   {{/tabs}}
 }
 `, { tabs })

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

@@ -29,7 +29,10 @@ var import_plugin_utils = require("umi/plugin-utils");
 var raw;
 var visit;
 var COMPONENT_NAME_REGEX = /<[A-Z][a-zA-Z\d]*/g;
+var COMPONENT_PROP_REGEX = /\s[a-z][a-z\d]*[A-Z]+[a-zA-Z\d]*(=|\s|>)/g;
 var COMPONENT_STUB_ATTR = "$tag-name";
+var PROP_STUB_ATTR = "-$u";
+var PROP_STUB_ATTR_REGEX = new RegExp(`${PROP_STUB_ATTR.replace("$", "\\$")}[a-z]`, "g");
 var CODE_META_STUB_ATTR = "$code-meta";
 (async () => {
   ({ visit } = await import("unist-util-visit"));
@@ -44,6 +47,9 @@ function rehypeRaw(opts) {
           const tagName = str.slice(1);
           return `${str} ${COMPONENT_STUB_ATTR}="${tagName}"`;
         });
+        node.value = node.value.replace(COMPONENT_PROP_REGEX, (str) => {
+          return str.replace(/[A-Z]/g, (s) => `${PROP_STUB_ATTR}${s.toLowerCase()}`);
+        });
       } else if (node.type === "element" && ((_a = node.data) == null ? void 0 : _a.meta)) {
         node.properties ?? (node.properties = {});
         node.properties[CODE_META_STUB_ATTR] = node.data.meta;
@@ -63,6 +69,14 @@ File: ${opts.fileAbsPath}`);
         node.data = { meta: node.properties[CODE_META_STUB_ATTR] };
         delete node.properties[CODE_META_STUB_ATTR];
       }
+      Object.keys(node.properties || {}).forEach((p) => {
+        if (PROP_STUB_ATTR_REGEX.test(p)) {
+          const originalName = p.replace(PROP_STUB_ATTR_REGEX, (s) => s.slice(PROP_STUB_ATTR.length).toUpperCase());
+          node.properties[originalName] = node.properties[p];
+          node.properties[originalName.toLowerCase()] = node.properties[p];
+          delete node.properties[p];
+        }
+      });
     });
     return newTree;
   };

package/dist/types.d.ts

@@ -50,6 +50,7 @@ export declare type IDumiUserConfig = Subset<Omit<IDumiConfig, 'locales'>> & {
     }>[] | Omit<Exclude<IDumiConfig['locales'][0], {
         suffix: string;
     }>, 'base'>[];
+    [key: string]: any;
 };
 export declare abstract class IDumiTechStack {
     /**
@@ -82,7 +83,9 @@ export declare abstract class IDumiTechStack {
     }): Promise<IDumiDemoProps['previewerProps']> | IDumiDemoProps['previewerProps'];
 }
 export declare type IApi = IUmiApi & {
-    config: IDumiConfig;
+    config: IDumiConfig & {
+        [key: string]: any;
+    };
     userConfig: IDumiUserConfig;
     service: IUmiApi['service'] & {
         themeData: IThemeLoadResult;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dumi",
-  "version": "2.1.1",
+  "version": "2.1.3",
   "description": "📖 Documentation Generator of React Component",
   "keywords": [
     "generator",

package/theme-default/layouts/DocLayout/index.less

@@ -1,5 +1,9 @@
 @import (reference) '../../styles/variables.less';
 
+@{dark-selector} {
+  color-scheme: dark;
+}
+
 body {
   margin: 0;
   padding: 0;

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

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

@@ -62,7 +62,7 @@ var PreviewerActions = function PreviewerActions(props) {
       activeKey = _useState2[0],
       setActiveKey = _useState2[1];
 
-  var _useState3 = useState(props === null || props === void 0 ? void 0 : props.forceShowCode),
+  var _useState3 = useState(props.forceShowCode || props.defaultShowCode),
       _useState4 = _slicedToArray(_useState3, 2),
       showCode = _useState4[0],
       setShowCode = _useState4[1];
@@ -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() {