@umijs/plugin-docs 4.0.0-rc.1 → 4.0.0-rc.4

package/dist/index.js

@@ -1,7 +1,11 @@
 "use strict";
 var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
-    Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
 }) : (function(o, m, k, k2) {
     if (k2 === undefined) k2 = k;
     o[k2] = m[k];
@@ -19,10 +23,26 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+const bundler_utils_1 = require("@umijs/bundler-utils");
+const utils_1 = require("@umijs/utils");
 const fs_1 = __importStar(require("fs"));
 const path_1 = require("path");
 const markdown_1 = require("./markdown");
 exports.default = (api) => {
+    // 把用户当前有设置在 docs/locales 下的语系放到变量 locales 中，方便后续使用
+    const locales = {};
+    const localesPath = (0, path_1.join)(api.cwd, 'docs/locales');
+    if ((0, fs_1.existsSync)(localesPath)) {
+        fs_1.default.readdirSync(localesPath).forEach((file) => {
+            if (file.endsWith('.json')) {
+                const filePath = (0, path_1.join)(localesPath, file);
+                const content = fs_1.default.readFileSync(filePath).toString();
+                const json = JSON.parse(content);
+                const localeName = file.replace('.json', '');
+                locales[localeName] = json;
+            }
+        });
+    }
     api.modifyDefaultConfig((memo) => {
         memo.conventionRoutes = Object.assign(Object.assign({}, memo.conventionRoutes), { base: (0, path_1.join)(api.cwd, 'docs') });
         memo.mdx = {
@@ -54,29 +74,45 @@ exports.default = (api) => {
             }
         }
     });
+    // 检查路由是否存在其他语言，没有的话做 fallback 处理
+    api.modifyRoutes((r) => {
+        if (!locales)
+            return r;
+        for (const route in r) {
+            if (r[route].path.match(/^[a-z]{2}-[A-Z]{2}\/.*/))
+                continue;
+            const defaultLangFile = r[route].file.replace(/(.[a-z]{2}-[A-Z]{2})?.md$/, '');
+            Object.keys(locales).map((l) => {
+                if (r[defaultLangFile] && !r[defaultLangFile + '.' + l]) {
+                    r[defaultLangFile + '.' + l] = Object.assign(Object.assign({}, r[defaultLangFile]), { path: `/${l}/${r[defaultLangFile].path}` });
+                }
+            });
+        }
+        return r;
+    });
     api.onGenerateFiles(() => {
+        var _a;
+        // theme path
+        let theme = ((_a = api.config.docs) === null || _a === void 0 ? void 0 : _a.theme) || require.resolve('../client/theme-doc/index.ts');
+        if (theme === 'blog') {
+            theme = require.resolve('../client/theme-blog/index.ts');
+        }
+        theme = (0, utils_1.winPath)(theme);
         const themeConfigPath = (0, path_1.join)(api.cwd, 'theme.config.ts');
         const themeExists = (0, fs_1.existsSync)(themeConfigPath);
         // 将 docs/locales 目录下的 json 文件注入到 themeConfig.locales 中
-        let injectLocale = 'themeConfig.locales = {};';
-        const localesPath = (0, path_1.join)(api.cwd, 'docs/locales');
-        if ((0, fs_1.existsSync)(localesPath)) {
-            fs_1.default.readdirSync(localesPath).forEach((file) => {
-                if (file.endsWith('.json')) {
-                    const filePath = (0, path_1.join)(localesPath, file);
-                    const content = fs_1.default.readFileSync(filePath).toString();
-                    const json = JSON.parse(content);
-                    const localeName = file.replace('.json', '');
-                    injectLocale += `themeConfig.locales['${localeName}'] = ${JSON.stringify(json)};
-`;
-                }
-            });
-        }
-        // @TODO: 需要能够动态解析 theme 中导出的组件，现在是硬编码
+        let injectLocale = `themeConfig.locales = ${JSON.stringify(locales)};`;
+        // exports don't start with $ will be MDX Component
+        const [_, exports] = (0, bundler_utils_1.parseModuleSync)({
+            content: (0, fs_1.readFileSync)(theme, 'utf-8'),
+            path: theme,
+        });
         api.writeTmpFile({
             path: 'index.ts',
             content: `
-export { Message, Hero } from '${require.resolve('../client/theme-doc')}';
+export { ${exports
+                .filter((item) => !item.startsWith('$'))
+                .join(', ')} } from '${require.resolve('../client/theme-doc/index.ts')}';
     `,
         });
         api.writeTmpFile({
@@ -84,7 +120,7 @@ export { Message, Hero } from '${require.resolve('../client/theme-doc')}';
             content: `
 import React from 'react';
 import { useOutlet, useAppData, useLocation, Link } from 'umi';
-import { Layout } from '${require.resolve('../client/theme-doc')}';
+import { $Layout as Layout } from '${require.resolve('../client/theme-doc/index.ts')}';
 ${themeExists
                 ? `import themeConfig from '${themeConfigPath}'`
                 : `const themeConfig = {}`}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@umijs/plugin-docs",
-  "version": "4.0.0-rc.1",
+  "version": "4.0.0-rc.4",
   "description": "@umijs/plugin-docs",
   "homepage": "https://github.com/umijs/umi-next/tree/master/packages/plugin-docs#readme",
   "bugs": "https://github.com/umijs/umi-next/issues",
@@ -23,20 +23,33 @@
     "dev": "pnpm build -- --watch"
   },
   "dependencies": {
-    "@mdx-js/mdx": "1.6.22",
-    "keymaster": "^1.6.2",
-    "remark-slug": "6.1.0"
+    "keymaster": "1.6.2",
+    "react-helmet": "^6.1.0"
   },
   "devDependencies": {
+    "@mdx-js/mdx": "2.0.0",
     "@types/keymaster": "^1.6.30",
+    "@types/react-helmet": "^6.1.5",
     "classnames": "^2.3.1",
-    "tailwindcss": "^3.0.15",
-    "umi": "4.0.0-rc.1"
+    "rehype-slug": "5.0.1",
+    "tailwindcss": "^3.0.23",
+    "umi": "4.0.0-rc.4"
   },
   "publishConfig": {
     "access": "public"
   },
   "authors": [
     "chencheng <sorrycc@gmail.com> (https://github.com/sorrycc)"
-  ]
+  ],
+  "compiledConfig": {
+    "deps": [
+      "@mdx-js/mdx",
+      "rehype-slug"
+    ],
+    "externals": {},
+    "excludeDtsDeps": [
+      "@mdx-js/mdx",
+      "rehype-slug"
+    ]
+  }
 }