dumi 2.0.16 → 2.0.18

package/dist/assetParsers/atom.js

@@ -113,13 +113,15 @@ var AtomAssetsParser = class {
           "**/_*",
           "**/_*/**",
           "**/*.{md,less,scss,sass,styl,css}"
-        ]
+        ],
+        ignoreInitial: true
       }).on("all", (ev, file) => {
         if (["add", "change"].includes(ev) && /\.(j|t)sx?$/.test(file)) {
-          this.unresolvedFiles.push(file);
+          this.unresolvedFiles.push(import_path.default.join(this.resolveDir, file));
           lazyParse();
         }
       });
+      lazyParse();
     }
   }
   unwatch(cb) {

package/dist/features/compile/index.js

@@ -75,7 +75,7 @@ var compile_default = (api) => {
     });
     memo.module.rule("dumi-page").type("javascript/auto").test(/\.(j|t)sx?$/).resourceQuery(/meta$/).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 });
-    memo.module.rule("dumi-raw").post().resourceQuery(/dumi-raw/).use("raw-loader").loader(require.resolve("raw-loader")).end().use("pre-raw-loader").loader(require.resolve("../../loaders/pre-raw"));
+    memo.module.rule("dumi-raw").type("javascript/auto").post().resourceQuery(/dumi-raw/).use("raw-loader").loader(require.resolve("raw-loader")).end().use("pre-raw-loader").loader(require.resolve("../../loaders/pre-raw"));
     if (api.env === "development" && memo.plugins.has("fastRefresh")) {
       memo.plugin("fastRefresh").tap(([params]) => [
         {

package/dist/features/derivative.js

@@ -47,14 +47,27 @@ function safeExcludeInMFSU(api, excludes) {
 var derivative_default = (api) => {
   api.describe({ key: "dumi:derivative" });
   api.onCheck(() => {
-    var _a, _b;
+    var _a, _b, _c, _d;
     (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!");
     (0, import_assert.default)(((_a = api.config.mfsu) == null ? void 0 : _a.strategy) !== "eager", "MFSU eager mode is not supported yet!");
+    (0, import_assert.default)(((_b = api.config.mfsu) == null ? void 0 : _b.esbuild) !== true, "MFSU esbuild bundler is not supported yet!");
     (0, import_assert.default)(!api.config.ssr || api.config.ssr.builder === "webpack", "Only `webpack` builder is supported in SSR mode!");
-    if (((_b = api.userConfig.history) == null ? void 0 : _b.type) === "hash") {
+    (0, import_assert.default)(((_c = api.config.cssLoader) == null ? void 0 : _c.modules) === void 0, "CSS Modules is not supported! Because it is not suitable for UI library development, please use normal CSS, Less, etc. instead.");
+    if (((_d = api.userConfig.history) == null ? void 0 : _d.type) === "hash") {
       import_plugin_utils.logger.warn("Hash history is temporarily incompatible, it is recommended to use browser history for now.");
     }
+    try {
+      const tsconfig = require(import_path.default.join(api.cwd, "tsconfig.json"));
+      const expected = [".dumi/**/*", ".dumirc.ts"];
+      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.");
+      }
+    } catch {
+    }
   });
   safeExcludeInMFSU(api, [
     new RegExp("dumi/dist/client"),
@@ -98,6 +111,10 @@ var derivative_default = (api) => {
     }
     return memo;
   });
+  api.modifyBabelPresetOpts((memo) => {
+    delete memo.pluginAutoCSSModules;
+    return memo;
+  });
   api.register({
     key: "onGenerateFiles",
     stage: Infinity,
@@ -105,6 +122,8 @@ var derivative_default = (api) => {
       import_constants.USELESS_TMP_FILES.forEach((file) => {
         import_plugin_utils.fsExtra.rmSync(import_path.default.join(api.paths.absTmpPath, file), { force: true });
       });
+      const umiPath = import_path.default.join(api.paths.absTmpPath, "umi.ts");
+      import_plugin_utils.fsExtra.writeFileSync(umiPath, import_plugin_utils.fsExtra.readFileSync(umiPath, "utf-8").replace("'@/loading'", "'../loading'"));
     }
   });
   api.registerPlugins([require.resolve("../../compiled/@umijs/plugins")]);

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

@@ -71,7 +71,9 @@ var transformer_default = async (raw, opts) => {
     processor,
     cwd: opts.cwd
   }));
-  processor.use(remarkRehype, { allowDangerousHtml: true }).use(import_rehypeRaw.default).use(rehypeRemoveComments, { removeConditional: true }).use(import_rehypeStrip.default).use(import_rehypeImg.default).use(import_rehypeDemo.default, {
+  processor.use(remarkRehype, { allowDangerousHtml: true }).use(import_rehypeRaw.default, {
+    fileAbsPath: opts.fileAbsPath
+  }).use(rehypeRemoveComments, { removeConditional: true }).use(import_rehypeStrip.default).use(import_rehypeImg.default).use(import_rehypeDemo.default, {
     techStacks: opts.techStacks,
     cwd: opts.cwd,
     fileAbsPath: opts.fileAbsPath,

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

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

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

@@ -25,6 +25,7 @@ __export(rehypeRaw_exports, {
   default: () => rehypeRaw
 });
 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;
@@ -34,7 +35,7 @@ var CODE_META_STUB_ATTR = "$code-meta";
   ({ visit } = await import("unist-util-visit"));
   ({ raw } = await import("hast-util-raw"));
 })();
-function rehypeRaw() {
+function rehypeRaw(opts) {
   return (tree, vFile) => {
     visit(tree, (node) => {
       var _a;
@@ -47,6 +48,10 @@ function rehypeRaw() {
         node.properties ?? (node.properties = {});
         node.properties[CODE_META_STUB_ATTR] = node.data.meta;
       }
+      if (node.type === "raw" && /<code[^>]*src=[^>]*\/>/.test(node.value)) {
+        import_plugin_utils.logger.warn(`<code /> is not supported, please use <code></code> instead.
+File: ${opts.fileAbsPath}`);
+      }
     });
     const newTree = raw(tree, vFile);
     visit(newTree, "element", (node) => {

package/dist/types.d.ts

@@ -7,8 +7,9 @@ import type { IModify } from '@umijs/core';
 import type { AssetsPackage, ExampleBlockAsset } from 'dumi-assets-types';
 import type { Element } from 'hast';
 import type { IApi as IUmiApi } from 'umi';
-declare type IUmiConfig = IUmiApi['config'];
-export interface IDumiConfig extends IUmiConfig {
+import { defineConfig as defineUmiConfig } from 'umi';
+declare type IUmiConfig = Parameters<typeof defineUmiConfig>[0];
+interface IDumiExtendsConfig {
     resolve: {
         docDirs: (string | {
             type?: string;
@@ -37,7 +38,8 @@ export interface IDumiConfig extends IUmiConfig {
     extraRemarkPlugins?: (string | Function | [string | Function, object])[];
     extraRehypePlugins?: (string | Function | [string | Function, object])[];
 }
-export interface IDumiUserConfig extends Partial<Omit<IDumiConfig, 'resolve' | 'locales'>> {
+export declare type IDumiConfig = IUmiConfig & IDumiExtendsConfig;
+export interface IDumiUserConfig extends Partial<Omit<IDumiConfig, 'resolve' | 'locales'>>, IUmiConfig {
     resolve?: Partial<IDumiConfig['resolve']>;
     locales?: (IDumiConfig['locales'][0] | Omit<IDumiConfig['locales'][0], 'base'>)[];
 }

package/package.json

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

package/theme-default/builtins/API/index.d.ts

@@ -1,5 +1,5 @@
 import { type FC } from 'react';
 declare const API: FC<{
-    id: string;
+    id?: string;
 }>;
 export default API;

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

@@ -10,20 +10,23 @@ function _iterableToArrayLimit(arr, i) { var _i = arr == null ? null : typeof Sy
 
 function _arrayWithHoles(arr) { if (Array.isArray(arr)) return arr; }
 
-import { useAtomAssets, useIntl } from 'dumi';
+import { useAtomAssets, useIntl, useRouteMeta } from 'dumi';
 import React from 'react';
 import Table from "../Table";
 
-var API = function API(_ref) {
+var API = function API(props) {
   var _definition$propsConf;
 
-  var id = _ref.id;
+  var _useRouteMeta = useRouteMeta(),
+      frontmatter = _useRouteMeta.frontmatter;
 
   var _useAtomAssets = useAtomAssets(),
       components = _useAtomAssets.components;
 
-  var definition = components === null || components === void 0 ? void 0 : components[id];
+  var id = props.id || frontmatter.atomId;
   var intl = useIntl();
+  if (!id) throw new Error('`id` properties if required for API component!');
+  var definition = components === null || components === void 0 ? void 0 : components[id];
   return /*#__PURE__*/React.createElement("div", {
     className: "markdown"
   }, /*#__PURE__*/React.createElement(Table, null, /*#__PURE__*/React.createElement("thead", null, /*#__PURE__*/React.createElement("tr", null, /*#__PURE__*/React.createElement("th", null, intl.formatMessage({
@@ -34,12 +37,12 @@ var API = function API(_ref) {
     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 (_ref2) {
+  })))), /*#__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) {
     var _definition$propsConf2;
 
-    var _ref3 = _slicedToArray(_ref2, 2),
-        name = _ref3[0],
-        prop = _ref3[1];
+    var _ref2 = _slicedToArray(_ref, 2),
+        name = _ref2[0],
+        prop = _ref2[1];
 
     return /*#__PURE__*/React.createElement("tr", {
       key: name