dumi 2.2.6 → 2.2.8

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

@@ -16,6 +16,7 @@ function _toPropertyKey(arg) { var key = _toPrimitive(arg, "string"); return _ty
 function _toPrimitive(input, hint) { if (_typeof(input) !== "object" || input === null) return input; var prim = input[Symbol.toPrimitive]; if (prim !== undefined) { var res = prim.call(input, hint || "default"); if (_typeof(res) !== "object") return res; throw new TypeError("@@toPrimitive must return a primitive value."); } return (hint === "string" ? String : Number)(input); }
 import { useFullSidebarData, useLocale, useSiteData } from 'dumi';
 import { useState } from 'react';
+import { getLocaleClearPath } from "./useSidebarData";
 import { getLocaleNav, pickRouteSortMeta, useLocaleDocRoutes, useRouteDataComparer } from "./utils";
 function genNavItem(meta, groups, activePath, link) {
   return _objectSpread({
@@ -69,7 +70,7 @@ export var useNavData = function useNavData() {
         var _ref6 = _slicedToArray(_ref5, 2),
           link = _ref6[0],
           groups = _ref6[1];
-        var _ref7 = link.match(/^(\/[^/]+)([^]+)?$/),
+        var _ref7 = "/".concat(getLocaleClearPath(link.replace(/^\//, ''), locale)).match(/^(\/[^/]+)([^]+)?$/),
           _ref8 = _slicedToArray(_ref7, 3),
           parentPath = _ref8[1],
           restPath = _ref8[2];

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

@@ -1,4 +1,5 @@
-import type { ISidebarGroup } from './types';
+import type { ILocalesConfig, ISidebarGroup } from './types';
+export declare const getLocaleClearPath: (routePath: string, locale: ILocalesConfig[0]) => string;
 /**
  * hook for get sidebar data for all nav
  */

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

@@ -19,7 +19,7 @@ import { useLocale, useLocation, useRouteMeta, useSiteData } from 'dumi';
 import { useState } from 'react';
 import { pickRouteSortMeta, useLocaleDocRoutes, useRouteDataComparer } from "./utils";
 var DEFAULT_GROUP_STUB_TITLE = '$default-group-title';
-var getLocaleClearPath = function getLocaleClearPath(routePath, locale) {
+export var getLocaleClearPath = function getLocaleClearPath(routePath, locale) {
   return 'base' in locale ? routePath.replace(locale.base.slice(1), '').replace(/^\//, '') : routePath;
 };
 

package/dist/features/derivative.js

@@ -65,7 +65,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, _e;
     [
       "clientLoader",
       "deadCode",
@@ -113,23 +113,47 @@ var derivative_default = (api) => {
       }
     }
     try {
-      const tsconfig = require(import_path.default.join(api.cwd, "tsconfig.json"));
-      const expected = [".dumi/**/*"];
-      if ((_c = (_b = api.service.configManager) == null ? void 0 : _b.mainConfigFile) == null ? void 0 : _c.endsWith(".ts")) {
-        expected.push(
-          (0, import_plugin_utils.winPath)(
-            import_path.default.relative(api.cwd, api.service.configManager.mainConfigFile)
-          )
-        );
+      const tsconfigPath = import_path.default.join(api.cwd, "tsconfig.json");
+      const tsconfig = require(tsconfigPath);
+      const configFileName = (_b = api.service.configManager) == null ? void 0 : _b.mainConfigFile;
+      const expected = [];
+      if (configFileName && /[\\/]\.[^\\/]+\.ts$/.test(configFileName)) {
+        expected.push((0, import_plugin_utils.winPath)(import_path.default.relative(api.cwd, configFileName)));
+      }
+      [
+        (_c = api.appData.globalJS) == null ? void 0 : _c[0],
+        api.appData.globalLoading,
+        (_d = api.appData.appJS) == null ? void 0 : _d.path
+      ].forEach((file) => {
+        if (file && /([\\/])\.dumi\1.*\.tsx?$/.test(file)) {
+          expected.push((0, import_plugin_utils.winPath)(import_path.default.relative(api.cwd, file)));
+        }
+      });
+      if (import_fs.default.existsSync(import_path.default.join(api.cwd, import_constants.LOCAL_THEME_DIR))) {
+        expected.push(`${import_constants.LOCAL_THEME_DIR}/**/*`);
       }
-      if (!expected.every((f) => {
+      if ((_e = tsconfig.include) == null ? void 0 : _e.includes(".dumi/**/*")) {
+        tsconfig.include.splice(
+          tsconfig.include.indexOf(".dumi/**/*"),
+          1,
+          ...expected.filter((f) => !tsconfig.include.includes(f))
+        );
+        import_fs.default.writeFileSync(
+          tsconfigPath,
+          JSON.stringify(tsconfig, null, 2),
+          "utf-8"
+        );
+        import_plugin_utils.logger.warn(
+          "tsconfig.json `include` option has been patched automatically, please check and commit it."
+        );
+      } else 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 the types exported by framework works.`
+            ", "
+          )} into \`include\` option of tsconfig.json, to make sure the type prompt works for ${expected.length > 1 ? "them" : "it"}.`
         );
       }
     } catch {

package/dist/features/locales.js

@@ -32,6 +32,7 @@ __export(locales_exports, {
   default: () => locales_default
 });
 module.exports = __toCommonJS(locales_exports);
+var import_constants = require("../constants");
 var import_path = __toESM(require("path"));
 var import_plugin_utils = require("umi/plugin-utils");
 var locales_default = (api) => {
@@ -125,15 +126,24 @@ const cache = createIntlCache();
 
 const LocalesContainer: FC<{ children: ReactNode }> = (props) => {
   const getIntl = useCallback(() => {
+    const base = "${api.config.base.replace(/\/$/, "")}"
     const matched = locales.slice().reverse().find((locale) => (
       'suffix' in locale
         // suffix mode
         ? history.location.pathname.replace(/([^/])\\/$/, '$1').endsWith(locale.suffix)
         // base mode
         : history.location.pathname.replace(/([^/])\\/$/, '$1')
-          .startsWith("${api.config.base.replace(/\/$/, "")}" + locale.base)
+          .startsWith(base + locale.base)
     ));
-    const locale = matched ? matched.id : locales[0].id;
+    let locale = matched ? matched.id : locales[0].id;
+    // using query on demos
+    if(history.location.pathname.startsWith(base + '/${import_constants.SP_ROUTE_PREFIX}demos')){
+        const params = new URLSearchParams(history.location.search);
+        // match the locale of the query
+        if (params.get('locale')){
+          locale = params.get('locale');
+        }
+    }
     const localeMessages = messages[locale] || {};
 
     // append internal message, for use intl as string template util

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

@@ -35,7 +35,7 @@ module.exports = __toCommonJS(rehypeRaw_exports);
 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_NAME_REGEX = /(<)([A-Z][a-zA-Z\d]*)([\s|>])/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";
@@ -53,10 +53,13 @@ function rehypeRaw(opts) {
     visit(tree, (node) => {
       var _a;
       if (node.type === "raw" && COMPONENT_NAME_REGEX.test(node.value)) {
-        node.value = node.value.replace(COMPONENT_NAME_REGEX, (str) => {
-          const tagName = str.slice(1);
-          return `${str} ${COMPONENT_STUB_ATTR}="${tagName}"`;
-        });
+        node.value = node.value.replace(
+          COMPONENT_NAME_REGEX,
+          (str, bracket, tagName, next, i, full) => {
+            const isWithinQuotes = /="[^"]*$/.test(full.slice(0, i)) && /^[^"]*"/.test(full.slice(i)) || /='[^']*$/.test(full.slice(0, i)) && /^[^']*'/.test(full.slice(i));
+            return isWithinQuotes ? str : `${bracket}${tagName} ${COMPONENT_STUB_ATTR}="${tagName}"${next}`;
+          }
+        );
         node.value = node.value.replace(COMPONENT_PROP_REGEX, (str) => {
           return str.replace(
             /[A-Z]/g,
@@ -72,7 +75,7 @@ function rehypeRaw(opts) {
 File: ${opts.fileAbsPath}`);
       }
     });
-    const newTree = raw(tree, vFile);
+    const newTree = raw(tree, { file: vFile });
     visit(newTree, "element", (node) => {
       var _a, _b;
       if ((_a = node.properties) == null ? void 0 : _a[COMPONENT_STUB_ATTR]) {

package/package.json

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

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

@@ -69,6 +69,8 @@ var HANDLERS = {
   function: function _function(_ref3) {
     var _this2 = this;
     var signature = _ref3.signature;
+    // handle Function type without signature
+    if (!signature) return 'Function';
     var signatures = 'oneOf' in signature ? signature.oneOf : [signature];
     return signatures.map(function (signature) {
       return "".concat(signature.isAsync ? 'async ' : '', "(").concat(signature.arguments.map(function (arg) {

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

@@ -4,11 +4,11 @@ function _unsupportedIterableToArray(o, minLen) { if (!o) return; if (typeof o =
 function _arrayLikeToArray(arr, len) { if (len == null || len > arr.length) len = arr.length; for (var i = 0, arr2 = new Array(len); i < len; i++) arr2[i] = arr[i]; return arr2; }
 function _iterableToArrayLimit(arr, i) { var _i = null == arr ? null : "undefined" != typeof Symbol && arr[Symbol.iterator] || arr["@@iterator"]; if (null != _i) { var _s, _e, _x, _r, _arr = [], _n = !0, _d = !1; try { if (_x = (_i = _i.call(arr)).next, 0 === i) { if (Object(_i) !== _i) return; _n = !1; } else for (; !(_n = (_s = _x.call(_i)).done) && (_arr.push(_s.value), _arr.length !== i); _n = !0); } catch (err) { _d = !0, _e = err; } finally { try { if (!_n && null != _i.return && (_r = _i.return(), Object(_r) !== _r)) return; } finally { if (_d) throw _e; } } return _arr; } }
 function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
-import ContentFooter from "../../slots/ContentFooter";
 import { ReactComponent as IconSidebar } from '@ant-design/icons-svg/inline-svg/outlined/align-left.svg';
 import animateScrollTo from 'animated-scroll-to';
 import { Helmet, useIntl, useLocation, useOutlet, useRouteMeta, useSidebarData, useSiteData } from 'dumi';
 import Content from 'dumi/theme/slots/Content';
+import ContentFooter from 'dumi/theme/slots/ContentFooter';
 import Features from 'dumi/theme/slots/Features';
 import Footer from 'dumi/theme/slots/Footer';
 import Header from 'dumi/theme/slots/Header';

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

@@ -50,11 +50,12 @@
 
   select {
     position: absolute;
-    top: 0;
-    left: 0;
+    inset: 0 15%;
     opacity: 0;
-    max-width: 100%;
-    max-height: 16px;
+    width: 100%;
+    min-width: 16px;
+    max-width: 70%;
+    height: 16px;
     cursor: pointer;
   }
 }

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

@@ -46,7 +46,7 @@ var Toc = function Toc() {
       });
       setSectionRefs(refs);
     }
-  }, [pathname, search, loading]);
+  }, [pathname, search, loading, memoToc]);
   return sectionRefs.length ? /*#__PURE__*/React.createElement(ScrollSpy, {
     sectionRefs: sectionRefs
   }, function (_ref3) {