dumi 2.3.0-alpha.4 → 2.3.0-alpha.6

package/dist/features/compile/index.js

@@ -33,6 +33,7 @@ __export(compile_exports, {
 });
 module.exports = __toCommonJS(compile_exports);
 var import_react = __toESM(require("../../techStacks/react"));
+var import_assets = require("../assets");
 var compile_default = (api) => {
   api.describe({ key: "dumi:compile" });
   api.register({
@@ -81,7 +82,19 @@ var compile_default = (api) => {
       mode: "text"
     }).end().end().oneOf("md").use("babel-loader").loader(babelInUmi.loader).options(babelInUmi.options).end().use("md-loader").loader(loaderPath).options({
       ...loaderBaseOpts,
-      builtins: api.service.themeData.builtins
+      builtins: api.service.themeData.builtins,
+      onResolveDemos(demos) {
+        const assets = demos.reduce(
+          (ret, demo) => {
+            if ("asset" in demo)
+              ret.push(demo.asset);
+            return ret;
+          },
+          []
+        );
+        (0, import_assets.addExampleAssets)(assets);
+      },
+      onResolveAtomMeta: import_assets.addAtomMeta
     });
     memo.module.rule("dumi-page").type("javascript/auto").test(/\.(j|t)sx?$/).resourceQuery(/(meta|frontmatter)$/).use("page-meta-loader").loader(require.resolve("../../loaders/page"));
     memo.module.rule("dumi-demo").type("javascript/auto").test(/\..+$/).enforce("pre").resourceQuery(/techStack/).use("demo-loader").loader(require.resolve("../../loaders/demo")).options({ techStacks, cwd: api.cwd });

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, _f;
     [
       "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 dotDumiWildcard = `${import_constants.LOCAL_DUMI_DIR}/**/*`;
+      if ((_b = tsconfig.include) == null ? void 0 : _b.includes(dotDumiWildcard)) {
+        tsconfig.include = tsconfig.include.filter(
+          (i) => i !== dotDumiWildcard
+        );
+        import_fs.default.writeFileSync(
+          tsconfigPath,
+          JSON.stringify(tsconfig, null, 2),
+          "utf-8"
+        );
+        import_plugin_utils.logger.info(
+          `tsconfig.json \`include\` option has been patched automatically, please check and commit it.
+          ${import_plugin_utils.chalk.grey("see also: https://github.com/umijs/dumi/pull/1902")}`
+        );
+      }
+      const dotDumiPath = import_path.default.join(api.cwd, import_constants.LOCAL_DUMI_DIR);
+      const dotDumiTsconfigPath = import_path.default.join(dotDumiPath, "tsconfig.json");
+      const hasDotDumiTsFiles = import_fs.default.existsSync(dotDumiPath) && import_fs.default.readdirSync(dotDumiPath).some(
+        (f) => import_constants.LOCAL_PAGES_DIR.endsWith(`/${f}`) || import_constants.LOCAL_THEME_DIR.endsWith(`/${f}`) || /\.tsx?$/.test(f)
+      );
+      if (hasDotDumiTsFiles && !import_fs.default.existsSync(dotDumiTsconfigPath) && !((_c = tsconfig.include) == null ? void 0 : _c.some((i) => /(\.\/)?.dumi\//.test(i)))) {
+        import_fs.default.writeFileSync(
+          dotDumiTsconfigPath,
+          JSON.stringify(
+            { extends: "../tsconfig.json", include: ["**/*"] },
+            null,
+            2
+          ),
+          "utf-8"
+        );
+        import_plugin_utils.logger.info(
+          "In order to make type prompt works for theme files, .dumi/tsconfig.json has been created automatically, please check and commit it."
         );
       }
-      if (!expected.every((f) => {
-        var _a2;
-        return (_a2 = tsconfig.include) == null ? void 0 : _a2.includes(f);
-      })) {
+      const configFileName = ((_d = api.service.configManager) == null ? void 0 : _d.mainConfigFile) && import_path.default.basename((_e = api.service.configManager) == null ? void 0 : _e.mainConfigFile);
+      if (configFileName && // only .dumirc.ts need to be included in the root tsconfig.json, because the dot files will be excluded by default
+      /^\..+\.ts$/.test(configFileName) && !((_f = tsconfig.include) == null ? void 0 : _f.includes(configFileName))) {
         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.`
+          `Please append \`${configFileName}\` into \`include\` option of tsconfig.json, to make sure the type prompt works for 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/index.js

@@ -152,7 +152,9 @@ function emit(opts, ret) {
 }
 function getDepsCacheKey(deps = []) {
   return JSON.stringify(
-    deps.map((file) => `${file}:${import_fs.default.statSync(file).mtimeMs}`)
+    deps.map(
+      (file) => `${file}:${(0, import_utils.getContentHash)(import_fs.default.readFileSync(file, "utf-8"))}`
+    )
   );
 }
 var deferrer = {};
@@ -163,7 +165,7 @@ function mdLoader(content) {
   const cache = (0, import_utils.getCache)("md-loader");
   const baseCacheKey = [
     this.resourcePath,
-    import_fs.default.statSync(this.resourcePath).mtimeMs,
+    (0, import_utils.getContentHash)(content),
     JSON.stringify(import_plugin_utils.lodash.omit(opts, ["mode", "builtins", "onResolveDemos"]))
   ].join(":");
   const cacheKey = [

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

@@ -58,14 +58,14 @@ function keepSoftBreak(pkg) {
   const ver = ((_b = pkg == null ? void 0 : pkg.devDependencies) == null ? void 0 : _b.dumi) ?? ((_c = pkg == null ? void 0 : pkg.dependencies) == null ? void 0 : _c.dumi) ?? "^2.0.0";
   return !import_plugin_utils.semver.subset(ver, import_constants.VERSION_2_DEPRECATE_SOFT_BREAKS);
 }
-function applyUnifiedPlugin(opts) {
+async function applyUnifiedPlugin(opts) {
   const [plugin, options] = Array.isArray(opts.plugin) ? opts.plugin : [opts.plugin];
-  const mod = typeof plugin === "function" ? plugin : require(require.resolve(plugin, { paths: [opts.cwd] }));
+  let mod = typeof plugin === "function" ? plugin : await import(plugin);
   const fn = mod.default || mod;
   opts.processor.use(fn, options);
 }
 var transformer_default = async (raw, opts) => {
-  var _a, _b, _c;
+  var _a;
   let fileLocaleLessPath = opts.fileAbsPath;
   const { unified } = await import("unified");
   const { default: remarkParse } = await import("remark-parse");
@@ -94,13 +94,13 @@ var transformer_default = async (raw, opts) => {
   if (keepSoftBreak(opts.pkg)) {
     processor.use(import_remarkBreaks.default, { fileAbsPath: opts.fileAbsPath });
   }
-  (_b = opts.extraRemarkPlugins) == null ? void 0 : _b.forEach(
-    (plugin) => applyUnifiedPlugin({
+  for (const plugin of opts.extraRemarkPlugins ?? []) {
+    await applyUnifiedPlugin({
       plugin,
       processor,
       cwd: opts.cwd
-    })
-  );
+    });
+  }
   processor.use(remarkRehype, { allowDangerousHtml: true }).use(import_rehypeRaw.default, {
     fileAbsPath: opts.fileAbsPath
   }).use(import_rehypeHighlightLine.default).use(rehypeRemoveComments, { removeConditional: true }).use(import_rehypeStrip.default).use(import_rehypeImg.default).use(import_rehypeDemo.default, {
@@ -115,13 +115,14 @@ var transformer_default = async (raw, opts) => {
     fileAbsPath: opts.fileAbsPath,
     routes: opts.routes
   }).use(rehypeAutolinkHeadings).use(import_rehypeIsolation.default).use(import_rehypeEnhancedTag.default).use(import_rehypeDesc.default).use(import_rehypeText.default);
-  (_c = opts.extraRehypePlugins) == null ? void 0 : _c.forEach(
-    (plugin) => applyUnifiedPlugin({
+  for (const plugin of opts.extraRehypePlugins ?? []) {
+    await applyUnifiedPlugin({
       plugin,
       processor,
       cwd: opts.cwd
-    })
-  );
+    });
+  }
+  processor.data("fileAbsPath", opts.fileAbsPath);
   const result = await processor.use(import_rehypeJsxify.default).process(raw);
   return {
     content: String(result.value),

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/dist/service/cli.js

@@ -22,7 +22,7 @@ __export(cli_exports, {
   run: () => run
 });
 module.exports = __toCommonJS(cli_exports);
-var import_node = require("umi/dist/cli/node");
+var import_node = require("@umijs/utils/dist/node");
 var import_plugin_utils = require("umi/plugin-utils");
 var import_constants = require("./constants");
 var import_dev = require("./dev");
@@ -30,7 +30,7 @@ var import_printHelp = require("./printHelp");
 var import_service = require("./service");
 (0, import_node.catchUnhandledRejection)();
 async function run(opts) {
-  (0, import_node.checkVersion)();
+  (0, import_node.checkVersion)(import_constants.MIN_NODE_VERSION);
   (0, import_node.setNodeTitle)(import_constants.FRAMEWORK_NAME);
   (0, import_plugin_utils.setNoDeprecation)();
   const args = (0, import_plugin_utils.yParser)(process.argv.slice(2), {

package/dist/service/forkedDev.js

@@ -1,5 +1,5 @@
 // src/service/forkedDev.ts
-var import_node = require("umi/dist/cli/node");
+var import_node = require("@umijs/utils/dist/node");
 var import_plugin_utils = require("umi/plugin-utils");
 var import_constants = require("./constants");
 var import_service = require("./service");

package/dist/utils.d.ts

@@ -44,4 +44,8 @@ export declare function getProjectRoot(cwd: string): string;
  */
 export declare function componentToChunkName(component: string, cwdPath?: string): string;
 export declare function generateMetaChunkName(path: string, cwd: string, locales?: string[]): string;
+/**
+ * generate hash for string
+ */
+export declare function getContentHash(content: string, length?: number): string;
 export {};

package/dist/utils.js

@@ -32,6 +32,7 @@ __export(utils_exports, {
   componentToChunkName: () => componentToChunkName,
   generateMetaChunkName: () => generateMetaChunkName,
   getCache: () => getCache,
+  getContentHash: () => getContentHash,
   getFileContentByRegExp: () => getFileContentByRegExp,
   getFileIdFromFsPath: () => getFileIdFromFsPath,
   getFileRangeLines: () => getFileRangeLines,
@@ -40,6 +41,7 @@ __export(utils_exports, {
   tryFatherBuildConfigs: () => tryFatherBuildConfigs
 });
 module.exports = __toCommonJS(utils_exports);
+var import_crypto = require("crypto");
 var import_file_system_cache = __toESM(require("file-system-cache"));
 var import_fs = __toESM(require("fs"));
 var import_js_yaml = __toESM(require("js-yaml"));
@@ -149,11 +151,15 @@ function generateMetaChunkName(path2, cwd, locales = []) {
   const locale = ifLocale ? `__${chunkName.replace(localeRegExp, "$1")}` : "";
   return `meta__${dir}${locale}`;
 }
+function getContentHash(content2, length = 8) {
+  return (0, import_crypto.createHash)("md5").update(content2).digest("hex").slice(0, length);
+}
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
   componentToChunkName,
   generateMetaChunkName,
   getCache,
+  getContentHash,
   getFileContentByRegExp,
   getFileIdFromFsPath,
   getFileRangeLines,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "dumi",
-  "version": "2.3.0-alpha.4",
+  "version": "2.3.0-alpha.6",
   "description": "📖 Documentation Generator of React Component",
   "keywords": [
     "generator",
@@ -82,8 +82,9 @@
     "@swc/core": "1.3.72",
     "@types/hast": "^2.3.5",
     "@types/mdast": "^3.0.12",
-    "@umijs/bundler-utils": "^4.0.73",
-    "@umijs/core": "^4.0.73",
+    "@umijs/bundler-utils": "^4.0.83",
+    "@umijs/core": "^4.0.83",
+    "@umijs/utils": "^4.0.83",
     "animated-scroll-to": "^2.3.0",
     "classnames": "2.3.2",
     "codesandbox": "^2.2.3",
@@ -131,7 +132,7 @@
     "remark-rehype": "^10.1.0",
     "sass": "^1.64.1",
     "sitemap": "^7.1.1",
-    "umi": "^4.0.73",
+    "umi": "^4.0.83",
     "unified": "^10.1.2",
     "unist-util-visit": "^4.1.2",
     "unist-util-visit-parents": "^5.1.3",
@@ -151,7 +152,7 @@
     "@types/pluralize": "^0.0.30",
     "@types/react": "^18.2.17",
     "@types/react-copy-to-clipboard": "^5.0.4",
-    "@umijs/lint": "^4.0.73",
+    "@umijs/lint": "^4.0.83",
     "@umijs/plugins": "4.0.32",
     "dumi-theme-mobile": "workspace:*",
     "eslint": "^8.46.0",

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

@@ -113,6 +113,7 @@
       box-shadow: 0 4px 16px rgba(0, 0, 0, 10%);
       border-radius: 6px;
       transition: all 0.2s ease-in-out;
+      z-index: 1;
 
       @{dark-selector} & {
         background-color: lighten(@c-site-bg-dark, 6%);
@@ -126,6 +127,7 @@
           font-size: 15px;
           line-height: 1.6;
           text-align: left;
+          white-space: nowrap;
 
           @media @mobile {
             display: inline;