@umijs/plugin-docs 4.0.0-canary.20220429.2 → 4.0.0-canary.20220506.1

package/dist/compiler.d.ts

@@ -0,0 +1,6 @@
+export declare function compile(opts: {
+    content: string;
+    fileName: string;
+}): Promise<{
+    result: string;
+}>;

package/dist/compiler.js

@@ -0,0 +1,76 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.compile = void 0;
+const plugin_utils_1 = require("umi/plugin-utils");
+const rehype_pretty_code_1 = __importDefault(require("rehype-pretty-code"));
+// @ts-ignore
+const mdx_1 = require("../compiled/@mdx-js/mdx");
+// @ts-ignore
+const rehype_slug_1 = __importDefault(require("../compiled/rehype-slug"));
+// @ts-ignore
+const remark_gfm_1 = __importDefault(require("../compiled/remark-gfm"));
+// https://rehype-pretty-code.netlify.app
+const rehypePrettyCodeOptions = {
+    theme: 'dark-plus',
+    onVisitLine(node) {
+        // Prevent lines from collapsing in `display: grid` mode, and
+        // allow empty lines to be copy/pasted
+        if (node.children.length === 0) {
+            node.children = [{ type: 'text', value: ' ' }];
+        }
+    },
+    // 允许高亮代码行
+    // 对于高亮的代码行，设置为 highlighted 样式表类
+    onVisitHighlightedLine(node) {
+        node.properties.className.push('highlighted');
+    },
+    // 允许高亮代码文字
+    // 对于高亮的代码文字，设置为 word 样式表类
+    onVisitHighlightedWord(node) {
+        node.properties.className = ['word'];
+    },
+};
+async function compile(opts) {
+    const compiler = (0, mdx_1.createProcessor)({
+        jsx: true,
+        remarkPlugins: [remark_gfm_1.default],
+        rehypePlugins: [rehype_slug_1.default, [rehype_pretty_code_1.default, rehypePrettyCodeOptions]],
+    });
+    try {
+        let result = String(await compiler.process(opts.content));
+        result = result.replace('function MDXContent(props = {}) {', `
+import { useEffect } from 'react';
+
+function MDXContent(props = {}) {
+
+  useEffect(() => {
+    if (window.location.hash.length !== 0) {
+      const hash = window.location.hash;
+      document.getElementById(hash.slice(1))?.scrollIntoView();
+    } else {
+      window.scrollTo(0, 0);
+    }
+    document.getElementById('active-nav-item')?.scrollIntoView({
+      behavior: 'smooth',
+      block: 'center'
+    });
+  }, []);
+
+`);
+        return { result };
+    }
+    catch (e) {
+        plugin_utils_1.logger.error(e.reason);
+        plugin_utils_1.logger.error(`Above error occurred in ${opts.fileName} at line ${e.line}`);
+        plugin_utils_1.logger.error(opts.content
+            .split('\n')
+            .filter((_, i) => i == e.line - 1)
+            .join('\n'));
+        plugin_utils_1.logger.error(' '.repeat(e.column - 1) + '^');
+        return { result: '' };
+    }
+}
+exports.compile = compile;

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+import { IApi } from 'umi';
+declare const _default: (api: IApi) => void;
+export default _default;

package/dist/index.js

@@ -0,0 +1,154 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = 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];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, 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 = {
+            ...memo.conventionRoutes,
+            base: (0, path_1.join)(api.cwd, 'docs'),
+        };
+        memo.mdx = {
+            loader: require.resolve('./loader'),
+            loaderOptions: {},
+        };
+        return memo;
+    });
+    api.addLayouts(() => {
+        return [
+            {
+                id: 'docs-layout',
+                file: withTmpPath({ api, path: 'Layout.tsx' }),
+            },
+        ];
+    });
+    api.onPatchRoute(({ route }) => {
+        if (route.__content) {
+            route.titles = (0, markdown_1.parseTitle)({
+                content: route.__content,
+            });
+        }
+        // 放在 docs/xxx.zh-CN.md 的文档，会被映射到 /zh-CN/docs/xxx 目录
+        if (route.file.match(/.[a-z]{2}-[A-Z]{2}.md$/)) {
+            route.path = route.path.replace(/(.*).([a-z]{2}-[A-Z]{2})$/, '$2/$1');
+            // 放在 docs/xxx/README.zh-CN.md 格式结尾的文档，会被映射到 /zh-CN/docs 目录
+            if (route.path.endsWith('README')) {
+                route.path = route.path.replace(/README$/, '');
+            }
+        }
+    });
+    // 检查路由是否存在其他语言，没有的话做 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] = {
+                        ...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, utils_1.winPath)((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 = ${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 { ${exports
+                .filter((item) => !item.startsWith('$'))
+                .join(', ')} } from '${(0, utils_1.winPath)(require.resolve('../client/theme-doc/index.ts'))}';
+    `,
+        });
+        api.writeTmpFile({
+            path: 'Layout.tsx',
+            content: `
+import React from 'react';
+import { useOutlet, useAppData, useLocation, Link } from 'umi';
+import { $Layout as Layout } from '${(0, utils_1.winPath)(require.resolve('../client/theme-doc/index.ts'))}';
+${themeExists
+                ? `import themeConfig from '${themeConfigPath}'`
+                : `const themeConfig = {}`}
+
+${injectLocale}
+
+export default () => {
+  const outlet = useOutlet();
+  const appData = useAppData();
+  const location = useLocation();
+  return (
+    <Layout appData={appData} components={{Link}} themeConfig={themeConfig} location={location}>
+      <div>{ outlet }</div>
+    </Layout>
+  );
+};
+    `,
+        });
+    });
+};
+function withTmpPath(opts) {
+    return (0, path_1.join)(opts.api.paths.absTmpPath, opts.api.plugin.key && !opts.noPluginDir
+        ? `plugin-${opts.api.plugin.key}`
+        : '', opts.path);
+}

package/dist/loader.d.ts

@@ -0,0 +1 @@
+export default function (content: string): Promise<any>;

package/dist/loader.js

@@ -0,0 +1,22 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const compiler_1 = require("./compiler");
+async function default_1(content) {
+    // @ts-ignore
+    const filename = this.resourcePath;
+    // @ts-ignore
+    const callback = this.async();
+    try {
+        const { result } = await (0, compiler_1.compile)({
+            content,
+            fileName: filename,
+        });
+        return callback(null, result);
+    }
+    catch (e) {
+        const err = e;
+        e.message = `${filename}: ${e.message}`;
+        throw err;
+    }
+}
+exports.default = default_1;

package/dist/markdown.d.ts

@@ -0,0 +1,6 @@
+export declare function parseTitle(opts: {
+    content: string;
+}): {
+    level: number;
+    title: string;
+}[];

package/dist/markdown.js

@@ -0,0 +1,21 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.parseTitle = void 0;
+function parseTitle(opts) {
+    const lines = opts.content.split('\n');
+    let i = 0;
+    const ret = [];
+    while (i < lines.length) {
+        const line = lines[i].trim();
+        const match = line.match(/^(#+)\s+(.*)/);
+        if (match) {
+            ret.push({
+                level: match[1].length,
+                title: match[2],
+            });
+        }
+        i += 1;
+    }
+    return ret;
+}
+exports.parseTitle = parseTitle;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@umijs/plugin-docs",
-  "version": "4.0.0-canary.20220429.2",
+  "version": "4.0.0-canary.20220506.1",
   "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",
@@ -39,7 +39,7 @@
     "rehype-slug": "5.0.1",
     "remark-gfm": "^3.0.1",
     "tailwindcss": "^3.0.23",
-    "umi": "4.0.0-canary.20220429.2"
+    "umi": "4.0.0-canary.20220506.1"
   },
   "publishConfig": {
     "access": "public"