dumi 2.0.9 → 2.0.11

package/dist/assetParsers/atom.d.ts

@@ -4,12 +4,14 @@ declare class AtomAssetsParser {
     private resolveDir;
     private unresolvedFiles;
     private parser;
-    private resolverDeferrer;
+    private parseDeferrer;
     private watcher;
     private cbs;
+    private resolveFilter;
     constructor(opts: {
         entryFile: string;
         resolveDir: string;
+        resolveFilter?: AtomAssetsParser['resolveFilter'];
         unpkgHost?: string;
         watch?: boolean;
     });

package/dist/assetParsers/atom.js

@@ -35,6 +35,7 @@ var AtomAssetsParser = class {
     this.watcher = null;
     this.cbs = [];
     this.resolveDir = opts.resolveDir;
+    this.resolveFilter = opts.resolveFilter || (() => true);
     this.entryDir = import_path.default.relative(opts.resolveDir, import_path.default.dirname(opts.entryFile));
     this.parser = new import_parser.SchemaParser({
       entryPath: opts.entryFile,
@@ -43,45 +44,58 @@ var AtomAssetsParser = class {
     });
   }
   async parse() {
-    if (!this.resolverDeferrer || this.unresolvedFiles.length) {
-      this.resolverDeferrer = (async () => {
+    if (!this.parseDeferrer || this.unresolvedFiles.length) {
+      this.parseDeferrer = (async () => {
         await this.parser.patch(this.unresolvedFiles.splice(0));
-        return new import_parser.SchemaResolver(await this.parser.parse());
+        const resolver = new import_parser.SchemaResolver(await this.parser.parse());
+        const result = {
+          components: {},
+          functions: {}
+        };
+        const fallbackProps = { type: "object", properties: {} };
+        const fallbackSignature = { arguments: [] };
+        resolver.componentList.forEach((id) => {
+          const needResolve = this.resolveFilter({
+            id,
+            type: "COMPONENT",
+            ids: resolver.componentList
+          });
+          let propsConfig = needResolve ? resolver.getComponent(id).props : fallbackProps;
+          const size = Buffer.byteLength(JSON.stringify(propsConfig));
+          if (size > MAX_PARSE_SIZE) {
+            propsConfig = fallbackProps;
+            import_plugin_utils.logger.warn(`Parsed component ${id} props size ${size} exceeds 512KB, skip it.`);
+          }
+          result.components[id] = {
+            type: "COMPONENT",
+            id,
+            title: id,
+            propsConfig
+          };
+        });
+        resolver.functionList.forEach((id) => {
+          const needResolve = this.resolveFilter({
+            id,
+            type: "FUNCTION",
+            ids: resolver.functionList
+          });
+          let signature = needResolve ? resolver.getFunction(id).signature : fallbackSignature;
+          const size = Buffer.byteLength(JSON.stringify(signature));
+          if (size > MAX_PARSE_SIZE) {
+            signature = fallbackSignature;
+            import_plugin_utils.logger.warn(`Parsed function ${id} signature size ${size} exceeds 512KB, skip it.`);
+          }
+          result.functions[id] = {
+            type: "FUNCTION",
+            id,
+            title: id,
+            signature
+          };
+        });
+        return result;
       })();
     }
-    return this.resolverDeferrer.then((resolver) => {
-      const components = {};
-      const functions = {};
-      resolver.componentList.forEach((id) => {
-        let propsConfig = resolver.getComponent(id).props;
-        const size = Buffer.byteLength(JSON.stringify(propsConfig));
-        if (size > MAX_PARSE_SIZE) {
-          propsConfig = { type: "object", properties: {} };
-          import_plugin_utils.logger.warn(`Parsed component ${id} props size ${size} exceeds 512KB, skip it.`);
-        }
-        components[id] = {
-          type: "COMPONENT",
-          id,
-          title: id,
-          propsConfig
-        };
-      });
-      resolver.functionList.forEach((id) => {
-        let signature = resolver.getFunction(id).signature;
-        const size = Buffer.byteLength(JSON.stringify(signature));
-        if (size > MAX_PARSE_SIZE) {
-          signature = { arguments: [] };
-          import_plugin_utils.logger.warn(`Parsed function ${id} signature size ${size} exceeds 512KB, skip it.`);
-        }
-        functions[id] = {
-          type: "FUNCTION",
-          id,
-          title: id,
-          signature
-        };
-      });
-      return { components, functions };
-    });
+    return this.parseDeferrer;
   }
   watch(cb) {
     this.cbs.push(cb);

package/dist/assetParsers/block.js

@@ -63,9 +63,10 @@ async function parseBlockAsset(opts) {
                 cwd: resolved
               });
               if (pkgJsonPath) {
-                asset.dependencies[args.path] = {
+                const pkg = require(pkgJsonPath);
+                asset.dependencies[pkg.name] = {
                   type: "NPM",
-                  value: require(pkgJsonPath).version
+                  value: pkg.version
                 };
               }
               return { path: args.path, external: true };
@@ -87,7 +88,7 @@ async function parseBlockAsset(opts) {
               ".json"
             ].includes(ext);
             const isEntryPoint = args.pluginData.kind === "entry-point";
-            const filename = isEntryPoint ? `index${ext}` : (0, import_plugin_utils.winPath)(import_path.default.relative(import_path.default.dirname(opts.fileAbsPath), args.path));
+            const filename = isEntryPoint ? `index${ext}` : (0, import_plugin_utils.winPath)(import_path.default.relative(import_path.default.dirname(opts.fileAbsPath), args.path)).replace(/^(\.?\.\/)+/g, "");
             if (isModule || isPlainText) {
               asset.dependencies[filename] = {
                 type: "FILE",

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

@@ -74,6 +74,7 @@ export interface IRouteMeta {
         features?: {
             emoji?: string;
             title?: string;
+            link?: string;
             description?: string;
             [key: string]: any;
         }[];
@@ -156,7 +157,9 @@ export interface IThemeConfig {
     logo?: string;
     nav?: (INavItem & {
         children?: INavItem[];
-    })[];
+    })[] | Record<string, (INavItem & {
+        children?: INavItem[];
+    })[]>;
     sidebar?: Record<string, ISidebarGroup[]>;
     footer?: string;
     [key: string]: any;

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

@@ -3,4 +3,6 @@
  */
 export declare const useNavData: () => (import("./types").INavItem & {
     children?: import("./types").INavItem[] | undefined;
-})[];
+})[] | Record<string, (import("./types").INavItem & {
+    children?: import("./types").INavItem[] | undefined;
+})[]>;

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

@@ -1,3 +1,5 @@
+function _typeof(obj) { "@babel/helpers - typeof"; return _typeof = "function" == typeof Symbol && "symbol" == typeof Symbol.iterator ? function (obj) { return typeof obj; } : function (obj) { return obj && "function" == typeof Symbol && obj.constructor === Symbol && obj !== Symbol.prototype ? "symbol" : typeof obj; }, _typeof(obj); }
+
 function _slicedToArray(arr, i) { return _arrayWithHoles(arr) || _iterableToArrayLimit(arr, i) || _unsupportedIterableToArray(arr, i) || _nonIterableRest(); }
 
 function _nonIterableRest() { throw new TypeError("Invalid attempt to destructure non-iterable instance.\nIn order to be iterable, non-array objects must have a [Symbol.iterator]() method."); }
@@ -10,7 +12,7 @@ function _iterableToArrayLimit(arr, i) { var _i = arr == null ? null : typeof Sy
 
 function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
 
-import { useFullSidebarData, useSiteData } from 'dumi';
+import { useFullSidebarData, useLocale, useSiteData } from 'dumi';
 import { useState } from 'react';
 import { pickRouteSortMeta, useLocaleDocRoutes, useRouteDataComparer } from "./utils";
 /**
@@ -18,6 +20,7 @@ import { pickRouteSortMeta, useLocaleDocRoutes, useRouteDataComparer } from "./u
  */
 
 export var useNavData = function useNavData() {
+  var locale = useLocale();
   var routes = useLocaleDocRoutes();
 
   var _useSiteData = useSiteData(),
@@ -28,7 +31,7 @@ export var useNavData = function useNavData() {
 
   var _useState = useState(function () {
     // use user config first
-    if (themeConfig.nav) return themeConfig.nav; // fallback to generate nav data from sidebar data
+    if (themeConfig.nav) return _typeof(themeConfig.nav) === 'object' ? themeConfig.nav[locale.id] : themeConfig.nav; // fallback to generate nav data from sidebar data
 
     var data = Object.entries(sidebar).map(function (_ref) {
       var _ref2 = _slicedToArray(_ref, 2),

package/dist/features/assets.js

@@ -69,7 +69,7 @@ var assets_default = (api) => {
       return await api.applyPlugins({
         key: "modifyAssetsMetadata",
         initialValue: {
-          name: api.config.themeConfig.title || api.pkg.name,
+          name: api.config.themeConfig.name || api.pkg.name,
           npmPackageName: api.pkg.name,
           version: api.pkg.version,
           description: api.pkg.description,

package/dist/features/autoAlias.js

@@ -36,27 +36,27 @@ var autoAlias_default = (api) => {
     },
     enableBy: ({ userConfig }) => userConfig.autoAlias !== false
   });
-  api.modifyDefaultConfig(async (memo) => {
-    var _a;
+  api.modifyConfig(async (memo) => {
+    var _a, _b, _c;
     let entryDir = "";
-    if ((_a = api.userConfig.resolve) == null ? void 0 : _a.entryFile) {
-      entryDir = import_path.default.resolve(api.cwd, api.userConfig.resolve.entryFile);
+    if ((_a = memo.resolve) == null ? void 0 : _a.entryFile) {
+      entryDir = import_path.default.resolve(api.cwd, memo.resolve.entryFile);
     } else if (import_fs.default.existsSync(import_path.default.join(api.cwd, "src"))) {
       entryDir = import_path.default.join(api.cwd, "src");
     }
     if (entryDir && api.pkg.name) {
       const fatherConfigs = await (0, import_utils.tryFatherBuildConfigs)(api.cwd);
       fatherConfigs.sort((a, b) => {
-        var _a2, _b;
+        var _a2, _b2;
         const aLevel = (((_a2 = a.output) == null ? void 0 : _a2.path) || a.output).split("/").length;
-        const bLevel = (((_b = b.output) == null ? void 0 : _b.path) || b.output).split("/").length;
+        const bLevel = (((_b2 = b.output) == null ? void 0 : _b2.path) || b.output).split("/").length;
         return bLevel - aLevel;
       });
       fatherConfigs.forEach((item) => {
-        var _a2;
-        memo.alias[`${api.pkg.name}/${((_a2 = item.output) == null ? void 0 : _a2.path) || item.output}`] = import_path.default.join(api.cwd, item.entry || item.input);
+        var _a2, _b2, _c2;
+        (_b2 = memo.alias)[_c2 = `${api.pkg.name}/${((_a2 = item.output) == null ? void 0 : _a2.path) || item.output}`] ?? (_b2[_c2] = import_path.default.join(api.cwd, item.entry || item.input));
       });
-      memo.alias[api.pkg.name] = entryDir;
+      (_b = memo.alias)[_c = api.pkg.name] ?? (_b[_c] = entryDir);
     }
     return memo;
   });

package/dist/features/parser.js

@@ -45,9 +45,8 @@ var parser_default = (api) => {
     }
   });
   api.modifyDefaultConfig((memo) => {
-    var _a, _b;
+    var _a;
     (0, import_assert.default)((_a = api.userConfig.resolve) == null ? void 0 : _a.entryFile, "`resolve.entryFile` must be configured when `apiParser` enable");
-    (0, import_assert.default)((_b = api.pkg.devDependencies) == null ? void 0 : _b["typescript"], "typescript must be installed when `apiParser` enable");
     return memo;
   });
   api.onStart(async () => {
@@ -57,7 +56,8 @@ var parser_default = (api) => {
     api.service.atomParser = new AtomAssetsParser({
       entryFile: api.config.resolve.entryFile,
       resolveDir: api.cwd,
-      unpkgHost: api.config.apiParser.unpkgHost
+      unpkgHost: api.config.apiParser.unpkgHost,
+      resolveFilter: api.config.apiParser.resolveFilter
     });
     if (api.env === "development") {
       api.service.atomParser.watch(writeAtomsMetaFile);

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

@@ -29,6 +29,7 @@ var import_utils = require("../../../utils");
 var import_enhanced_resolve = __toESM(require("enhanced-resolve"));
 var import_fs = __toESM(require("fs"));
 var import_path = __toESM(require("path"));
+var import_plugin_utils = require("umi/plugin-utils");
 var import_url = __toESM(require("url"));
 var EMBED_OPEN_TAG = "<embed ";
 var EMBED_CLOSE_TAG = "</embed>";
@@ -46,6 +47,31 @@ var visit;
   ({ default: remarkDirective } = await import("remark-directive"));
   ({ default: remarkGfm } = await import("remark-gfm"));
 })();
+function remarkReplaceSrc(opts) {
+  function getEmbedRltPath(value) {
+    const { fileAbsPath, parentAbsPath } = opts;
+    const absPath = import_path.default.resolve(fileAbsPath, "..", value);
+    return (0, import_plugin_utils.winPath)(import_path.default.relative(import_path.default.dirname(parentAbsPath), absPath)).replace(/^([^.])/, "./$1");
+  }
+  return (ast) => {
+    visit(ast, ["html", "image", "link"], (node) => {
+      switch (node.type) {
+        case "html":
+          if (/^<(code|img|a)[^>]+(src|href)=('|")\.\.?\//.test(node.value)) {
+            node.value = node.value.replace(/(src|href)=("|')([^]+?)\2/, (_, tag, quote, value) => `${tag}=${quote}${getEmbedRltPath(value)}${quote}`);
+          }
+          break;
+        case "image":
+        case "link":
+          if (/^\.\.?\//.test(node.url)) {
+            node.url = getEmbedRltPath(node.url);
+          }
+          break;
+        default:
+      }
+    });
+  };
+}
 function remarkRawAST() {
   this.Compiler = function Compiler(ast) {
     visit(ast, "yaml", (node, ancestors) => {
@@ -83,7 +109,10 @@ function remarkEmbed(opts) {
           const {
             result: mdast,
             data: { embeds }
-          } = unified().use(remarkParse).use(remarkEmbed, { ...opts, fileAbsPath: absPath }).use(remarkFrontmatter).use(remarkDirective).use(remarkGfm).use(remarkRawAST).processSync(content);
+          } = unified().use(remarkParse).use(remarkEmbed, { ...opts, fileAbsPath: absPath }).use(remarkFrontmatter).use(remarkDirective).use(remarkGfm).use(remarkReplaceSrc, {
+            fileAbsPath: absPath,
+            parentAbsPath: opts.fileAbsPath
+          }).use(remarkRawAST).processSync(content);
           if (!node.value.endsWith(EMBED_CLOSE_TAG)) {
             for (let j = i; j < parent.children.length; j++) {
               const sibling = parent.children[j];

package/dist/service/service.js

@@ -41,10 +41,10 @@ var DumiService = class extends import_umi.Service {
     var _a;
     const cwd = this.cwd;
     const absSrcPath = ((_a = this.userConfig.alias) == null ? void 0 : _a["@"]) ?? cwd;
-    const absPagesPath = winJoin(absSrcPath, "pages");
+    const absPagesPath = winJoin(cwd, `.${import_constants.FRAMEWORK_NAME}`, "pages");
     const absApiRoutesPath = winJoin(absSrcPath, "api");
     const tmp = this.env === import_core.Env.development ? `tmp` : `tmp-${this.env}`;
-    const absTmpPath = winJoin(absSrcPath, `.${import_constants.FRAMEWORK_NAME}`, tmp);
+    const absTmpPath = winJoin(cwd, `.${import_constants.FRAMEWORK_NAME}`, tmp);
     const absNodeModulesPath = winJoin(cwd, "node_modules");
     const absOutputPath = winJoin(cwd, "dist");
     return {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dumi",
-  "version": "2.0.9",
+  "version": "2.0.11",
   "description": "📖 Documentation Generator of React Component",
   "keywords": [
     "generator",
@@ -84,7 +84,7 @@
     "animated-scroll-to": "^2.3.0",
     "codesandbox": "^2.2.3",
     "deepmerge": "^4.2.2",
-    "dumi-afx-deps": "^1.0.0-alpha.2",
+    "dumi-afx-deps": "^1.0.0-alpha.6",
     "dumi-assets-types": "2.0.0-alpha.0",
     "enhanced-resolve": "^5.10.0",
     "estree-util-to-js": "^1.1.0",

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

@@ -1,4 +1,4 @@
-import { useRouteMeta } from 'dumi';
+import { Link, useRouteMeta } from 'dumi';
 import React from 'react';
 import "./index.less";
 
@@ -17,11 +17,24 @@ var Features = function Features() {
   }, frontmatter.features.map(function (_ref) {
     var title = _ref.title,
         description = _ref.description,
-        emoji = _ref.emoji;
+        emoji = _ref.emoji,
+        link = _ref.link;
+    var titleWithLink;
+
+    if (link) {
+      titleWithLink = /^(\w+:)\/\/|^(mailto|tel):/.test(link) ? /*#__PURE__*/React.createElement("a", {
+        href: link,
+        target: "_blank",
+        rel: "noreferrer"
+      }, title) : /*#__PURE__*/React.createElement(Link, {
+        to: link
+      }, title);
+    }
+
     return /*#__PURE__*/React.createElement("div", {
       key: title,
       className: "dumi-default-features-item"
-    }, emoji && /*#__PURE__*/React.createElement("i", null, emoji), title && /*#__PURE__*/React.createElement("h3", null, title), description && /*#__PURE__*/React.createElement("p", {
+    }, emoji && /*#__PURE__*/React.createElement("i", null, emoji), title && /*#__PURE__*/React.createElement("h3", null, titleWithLink || title), description && /*#__PURE__*/React.createElement("p", {
       dangerouslySetInnerHTML: {
         __html: description
       }

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

@@ -51,6 +51,12 @@
       color: @c-text;
       font-weight: normal;
       font-size: 20px;
+      a {
+        color: @c-primary;
+        &:not(:hover) {
+          text-decoration: none;
+        }
+      }
 
       @media @mobile {
         font-size: 18px;