dumi 2.1.10 → 2.1.11

package/dist/features/compile/index.js

@@ -55,7 +55,7 @@ var compile_default = (api) => {
       resolve: api.config.resolve,
       extraRemarkPlugins: api.config.extraRemarkPlugins,
       extraRehypePlugins: api.config.extraRehypePlugins,
-      routers: api.appData.routes
+      routes: api.appData.routes
     };
     memo.module.rule("dumi-md").type("javascript/auto").test(/\.md$/).oneOf("md-meta").resourceQuery(/meta$/).use("babel-loader").loader(babelInUmi.loader).options(babelInUmi.options).end().use("md-meta-loader").loader(loaderPath).options({
       ...loaderBaseOpts,

package/dist/features/tabs.d.ts

@@ -9,6 +9,7 @@ export interface IContentTab {
 }
 export declare function isTabRouteFile(file: string): boolean;
 export declare function getTabKeyFromFile(file: string): string;
+export declare function getHostForTabRouteFile(file: string): string;
 /**
  * plugin for add conventional tab and plugin tab into page content
  */

package/dist/features/tabs.js

@@ -23,6 +23,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 var tabs_exports = {};
 __export(tabs_exports, {
   default: () => tabs_default,
+  getHostForTabRouteFile: () => getHostForTabRouteFile,
   getTabKeyFromFile: () => getTabKeyFromFile,
   isTabRouteFile: () => isTabRouteFile
 });
@@ -37,6 +38,9 @@ function isTabRouteFile(file) {
 function getTabKeyFromFile(file) {
   return file.match(/\$tab-([^.]+)/)[1];
 }
+function getHostForTabRouteFile(file) {
+  return file.replace(/\$tab-[^.]+\./, "");
+}
 var tabs_default = (api) => {
   let tabsFromPlugins;
   const routesTabMapping = {};
@@ -132,6 +136,7 @@ export const tabs = {
 };
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
+  getHostForTabRouteFile,
   getTabKeyFromFile,
   isTabRouteFile
 });

package/dist/features/theme/index.js

@@ -115,8 +115,22 @@ var theme_default = (api) => {
     memo.alias["dumi/theme-default"] = DEFAULT_THEME_PATH;
     memo.extraBabelIncludes ?? (memo.extraBabelIncludes = []);
     memo.extraBabelIncludes.push(import_path.default.resolve(__dirname, "../../client/theme-api"));
-    memo.theme ?? (memo.theme = {});
-    memo.theme["dark-selector"] = `~'[${import_constants.PREFERS_COLOR_ATTR}="dark"]'`;
+    return memo;
+  });
+  api.chainWebpack((memo) => {
+    const lessRule = memo.module.rule("less");
+    ["css", "css-modules"].forEach((rule) => {
+      Object.values(lessRule.oneOf(rule).uses.entries()).forEach((loader) => {
+        if (loader.get("loader").includes("less-loader")) {
+          loader.tap((opts) => {
+            var _a;
+            (_a = opts.lessOptions).modifyVars ?? (_a.modifyVars = {});
+            opts.lessOptions.modifyVars["dark-selector"] = `~'[${import_constants.PREFERS_COLOR_ATTR}="dark"]'`;
+            return opts;
+          });
+        }
+      });
+    });
     return memo;
   });
   api.onGenerateFiles(() => {

package/dist/loaders/markdown/transformer/index.d.ts

@@ -41,7 +41,7 @@ export interface IMdTransformerOptions {
     resolve: IDumiConfig['resolve'];
     extraRemarkPlugins?: IDumiConfig['extraRemarkPlugins'];
     extraRehypePlugins?: IDumiConfig['extraRehypePlugins'];
-    routers: Record<string, IRoute>;
+    routes: Record<string, IRoute>;
 }
 export interface IMdTransformerResult {
     content: string;

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

@@ -81,7 +81,7 @@ var transformer_default = async (raw, opts) => {
     resolver
   }).use(import_rehypeSlug.default).use(import_rehypeLink.default, {
     fileAbsPath: opts.fileAbsPath,
-    routers: opts.routers
+    routes: opts.routes
   }).use(rehypeAutolinkHeadings).use(import_rehypeIsolation.default).use(import_rehypeEnhancedTag.default).use(import_rehypeDesc.default).use(import_rehypeText.default);
   (_b = opts.extraRehypePlugins) == null ? void 0 : _b.forEach((plugin) => applyUnifiedPlugin({
     plugin,

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

@@ -100,13 +100,18 @@ function rehypeDemo(opts) {
             if (isFirstChild) {
               node.data ?? (node.data = {});
               node.data[DEMO_NODE_CONTAINER] = true;
-              while (nextChild && (isElement(nextChild, "code") && tryMarkDemoNode(nextChild, opts) || isElement(nextChild, "br"))) {
-                splitFrom += 1;
-                nextChildIndex = splitFrom + 1;
-                nextChild = node.children[nextChildIndex];
-              }
               if (!nextChild)
                 return SKIP;
+              while (nextChild) {
+                if (isElement(nextChild, "code") && tryMarkDemoNode(nextChild, opts) || isElement(nextChild, "br")) {
+                  splitFrom += 1;
+                  nextChildIndex = splitFrom + 1;
+                  nextChild = node.children[nextChildIndex];
+                } else {
+                  splitFrom += 1;
+                  break;
+                }
+              }
             }
             const splitChildren = node.children.splice(splitFrom);
             parent.children.splice(nodeIndex + 1, 0, {

package/dist/loaders/markdown/transformer/rehypeLink.d.ts

@@ -1,6 +1,6 @@
 import type { Root } from 'hast';
 import type { Transformer } from 'unified';
 import type { IMdTransformerOptions } from '.';
-declare type IRehypeLinkOptions = Pick<IMdTransformerOptions, 'fileAbsPath' | 'routers'>;
+declare type IRehypeLinkOptions = Pick<IMdTransformerOptions, 'fileAbsPath' | 'routes'>;
 export default function rehypeLink(opts: IRehypeLinkOptions): Transformer<Root>;
 export {};

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

@@ -25,6 +25,7 @@ __export(rehypeLink_exports, {
   default: () => rehypeLink
 });
 module.exports = __toCommonJS(rehypeLink_exports);
+var import_tabs = require("../../../features/tabs");
 var import_path = __toESM(require("path"));
 var import_plugin_utils = require("umi/plugin-utils");
 var import_url = __toESM(require("url"));
@@ -40,16 +41,28 @@ function rehypeLink(opts) {
       if (node.tagName === "a" && typeof ((_a = node.properties) == null ? void 0 : _a.href) === "string") {
         const href = node.properties.href;
         const parsedUrl = import_url.default.parse(href);
+        const hostAbsPath = (0, import_tabs.getHostForTabRouteFile)(opts.fileAbsPath);
         if (parsedUrl.hostname)
           return SKIP;
         if (/\.md$/i.test(parsedUrl.pathname)) {
-          const { routers } = opts;
-          const absPath = (0, import_plugin_utils.winPath)(import_path.default.resolve(opts.fileAbsPath, "..", parsedUrl.pathname));
-          Object.keys(routers).forEach((key) => {
-            if (routers[key].file === absPath) {
-              parsedUrl.pathname = routers[key].absPath;
+          const { routes } = opts;
+          const absPath = (0, import_plugin_utils.winPath)(import_path.default.resolve(hostAbsPath, "..", parsedUrl.pathname));
+          Object.keys(routes).forEach((key) => {
+            if (routes[key].file === absPath) {
+              parsedUrl.pathname = routes[key].absPath;
             }
           });
+        } else if (/^\.?\.\//.test(parsedUrl.pathname) || /^(\w+:)?\/\//.test(parsedUrl.pathname)) {
+          const routes = Object.values(opts.routes);
+          const basePath = routes.find((route) => route.file === hostAbsPath).absPath;
+          const htmlTargetPath = import_url.default.resolve(basePath, parsedUrl.pathname);
+          const rr6TargetPath = (0, import_plugin_utils.winPath)(import_path.default.resolve(basePath, parsedUrl.pathname));
+          parsedUrl.pathname = htmlTargetPath;
+          if (routes.every((route) => route.absPath !== htmlTargetPath) && routes.some((route) => route.absPath === rr6TargetPath)) {
+            parsedUrl.pathname = rr6TargetPath;
+            import_plugin_utils.logger.warn(`Detected ambiguous link \`${href}\` in \`${opts.fileAbsPath}\`, please use \`./xxx.md\` file path instead of normal relative path, dumi will deprecate this behavior in the future.
+        See more: https://github.com/umijs/dumi/pull/1491`);
+          }
         }
         parent.children.splice(i, 1, {
           type: "element",

package/package.json

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

package/theme-default/builtins/API/index.js

@@ -11,8 +11,115 @@ function _iterableToArrayLimit(arr, i) { var _i = arr == null ? null : typeof Sy
 function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
 
 import { useAtomAssets, useIntl, useRouteMeta } from 'dumi';
-import React from 'react';
+import React, { useEffect, useState } from 'react';
 import Table from "../Table";
+var HANDLERS = {
+  // entry method
+  toString: function toString(prop) {
+    if (typeof prop.type === 'string' && prop.type in this) {
+      // value from TypeMap
+      if ('enum' in prop) return this.enum(prop);
+      return this[prop.type](prop);
+    } else if (prop.type) {
+      // non-parsed type, such as ReactNode
+      return this.getValidClassName(prop) || prop.type;
+    } else if ('const' in prop) {
+      // const value
+      return prop.const;
+    } else if ('oneOf' in prop) {
+      // oneOf value
+      return this.oneOf(prop);
+    } // unknown type
+
+
+    return "unknown";
+  },
+  // type handlers
+  string: function string(prop) {
+    return prop.type;
+  },
+  number: function number(prop) {
+    return prop.type;
+  },
+  boolean: function boolean(prop) {
+    return prop.type;
+  },
+  any: function any(prop) {
+    return prop.type;
+  },
+  object: function object(prop) {
+    var _this = this;
+
+    var props = [];
+    Object.entries(prop.properties || {}).forEach(function (_ref) {
+      var _prop$required;
+
+      var _ref2 = _slicedToArray(_ref, 2),
+          key = _ref2[0],
+          value = _ref2[1];
+
+      // skip nested object type
+      props.push("".concat(key).concat((_prop$required = prop.required) !== null && _prop$required !== void 0 && _prop$required.includes(key) ? '' : '?', ": ").concat(value.type === 'object' ? 'object' : _this.toString(value)));
+    });
+    return props.length ? "{ ".concat(props.join('; '), " }") : '{}';
+  },
+  array: function array(prop) {
+    if (prop.items) {
+      var className = this.getValidClassName(prop.items);
+      return className ? "".concat(className, "[]") : "".concat(this.toString(prop.items), "[]");
+    }
+
+    return 'any[]';
+  },
+  // FIXME: extract real type
+  element: function element(prop) {
+    return "<".concat(prop.componentName, " />");
+  },
+  // FIXME: extract real type
+  function: function _function(_ref3) {
+    var _this2 = this;
+
+    var signature = _ref3.signature;
+    return "".concat(signature.isAsync ? 'async ' : '', "(").concat(signature.arguments.map(function (arg) {
+      return "".concat(arg.key, ": ").concat(_this2.toString(arg));
+    }).join(', '), ") => ").concat(this.toString(signature.returnType));
+  },
+  // FIXME: extract real type
+  dom: function dom(prop) {
+    return "<".concat(prop.$$__body.id, " />");
+  },
+  // special handlers
+  enum: function _enum(prop) {
+    return prop.enum.map(function (v) {
+      return JSON.stringify(v);
+    }).join(' | ');
+  },
+  oneOf: function oneOf(prop) {
+    var _this3 = this;
+
+    return prop.oneOf.map(function (v) {
+      return _this3.getValidClassName(v) || _this3.toString(v);
+    }).join(' | ');
+  },
+  // utils
+  getValidClassName: function getValidClassName(prop) {
+    return 'className' in prop && typeof prop.className === 'string' && prop.className !== '__type' ? prop.className : null;
+  }
+};
+
+var APIType = function APIType(prop) {
+  var _useState = useState(function () {
+    return HANDLERS.toString(prop);
+  }),
+      _useState2 = _slicedToArray(_useState, 2),
+      type = _useState2[0],
+      setType = _useState2[1];
+
+  useEffect(function () {
+    setType(HANDLERS.toString(prop));
+  }, [prop]);
+  return /*#__PURE__*/React.createElement("code", null, type);
+};
 
 var API = function API(props) {
   var _definition$propsConf;
@@ -37,18 +144,18 @@ var API = function API(props) {
     id: 'api.component.type'
   })), /*#__PURE__*/React.createElement("th", null, intl.formatMessage({
     id: 'api.component.default'
-  })))), /*#__PURE__*/React.createElement("tbody", null, definition && (_definition$propsConf = definition.propsConfig) !== null && _definition$propsConf !== void 0 && _definition$propsConf.properties ? Object.entries(definition.propsConfig.properties).map(function (_ref) {
+  })))), /*#__PURE__*/React.createElement("tbody", null, definition && (_definition$propsConf = definition.propsConfig) !== null && _definition$propsConf !== void 0 && _definition$propsConf.properties ? Object.entries(definition.propsConfig.properties).map(function (_ref4) {
     var _definition$propsConf2;
 
-    var _ref2 = _slicedToArray(_ref, 2),
-        name = _ref2[0],
-        prop = _ref2[1];
+    var _ref5 = _slicedToArray(_ref4, 2),
+        name = _ref5[0],
+        prop = _ref5[1];
 
     return /*#__PURE__*/React.createElement("tr", {
       key: name
-    }, /*#__PURE__*/React.createElement("td", null, name), /*#__PURE__*/React.createElement("td", null, prop.description || '--'), /*#__PURE__*/React.createElement("td", null, /*#__PURE__*/React.createElement("code", null, prop.type)), /*#__PURE__*/React.createElement("td", null, /*#__PURE__*/React.createElement("code", null, (_definition$propsConf2 = definition.propsConfig.required) !== null && _definition$propsConf2 !== void 0 && _definition$propsConf2.includes(name) ? intl.formatMessage({
+    }, /*#__PURE__*/React.createElement("td", null, name), /*#__PURE__*/React.createElement("td", null, prop.description || '--'), /*#__PURE__*/React.createElement("td", null, /*#__PURE__*/React.createElement(APIType, prop)), /*#__PURE__*/React.createElement("td", null, /*#__PURE__*/React.createElement("code", null, (_definition$propsConf2 = definition.propsConfig.required) !== null && _definition$propsConf2 !== void 0 && _definition$propsConf2.includes(name) ? intl.formatMessage({
       id: 'api.component.required'
-    }) : prop.default || '--')));
+    }) : JSON.stringify(prop.default) || '--')));
   }) : /*#__PURE__*/React.createElement("tr", null, /*#__PURE__*/React.createElement("td", {
     colSpan: 4
   }, intl.formatMessage({