npm - @umijs/plugin-docs - Versions diffs - 4.0.0-rc.2 → 4.0.0-rc.20 - Mend

@umijs/plugin-docs 4.0.0-rc.2 → 4.0.0-rc.20

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (34) hide show

package/client/theme-doc/Head.tsx +28 -16
package/client/theme-doc/LangSwitch.tsx +13 -4
package/client/theme-doc/Layout.tsx +36 -25
package/client/theme-doc/Logo.tsx +13 -5
package/client/theme-doc/NavBar.tsx +58 -15
package/client/theme-doc/Search.tsx +54 -24
package/client/theme-doc/Sidebar.tsx +6 -3
package/client/theme-doc/ThemeSwitch.tsx +10 -2
package/client/theme-doc/Toc.tsx +12 -14
package/client/theme-doc/components/Announcement.tsx +1 -0
package/client/theme-doc/components/Features.tsx +1 -1
package/client/theme-doc/components/Message.tsx +39 -21
package/client/theme-doc/context.ts +10 -1
package/client/theme-doc/firefox-polyfill.css +6 -5
package/client/theme-doc/tailwind.css +168 -20
package/client/theme-doc/tailwind.out.css +556 -166
package/client/theme-doc/useLanguage.ts +15 -5
package/client/theme-doc/utils/getLinkFromTitle.ts +15 -0
package/client/theme-doc/utils/getTocTitle.ts +9 -0
package/compiled/@mdx-js/mdx/LICENSE +21 -0
package/compiled/@mdx-js/mdx/index.js +8 -0
package/compiled/@mdx-js/mdx/package.json +1 -0
package/compiled/rehype-slug/LICENSE +22 -0
package/compiled/rehype-slug/index.js +1 -0
package/compiled/rehype-slug/package.json +1 -0
package/compiled/remark-gfm/LICENSE +22 -0
package/compiled/remark-gfm/index.js +1 -0
package/compiled/remark-gfm/package.json +1 -0
package/dist/compiler.d.ts +1 -0
package/dist/compiler.js +55 -21
package/dist/index.js +49 -22
package/dist/loader.js +14 -15
package/dist/markdown.js +3 -1
package/package.json +18 -10

package/compiled/@mdx-js/mdx/package.json ADDED Viewed

	@@ -0,0 +1 @@
1	+ {"name":"@mdx-js/mdx","author":"John Otander <johnotander@gmail.com> (https://johno.com)","license":"MIT","types":"index.d.ts"}

package/compiled/rehype-slug/LICENSE ADDED Viewed

@@ -0,0 +1,22 @@
+(The MIT License)
+Copyright (c) 2016 Titus Wormer <tituswormer@gmail.com>
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/compiled/rehype-slug/index.js ADDED Viewed

@@ -0,0 +1 @@

package/compiled/rehype-slug/package.json ADDED Viewed

	@@ -0,0 +1 @@
1	+ {"name":"rehype-slug","author":"Titus Wormer <tituswormer@gmail.com> (https://wooorm.com)","license":"MIT","types":"index.d.ts"}

package/compiled/remark-gfm/LICENSE ADDED Viewed

@@ -0,0 +1,22 @@
+(The MIT License)
+Copyright (c) 2020 Titus Wormer <tituswormer@gmail.com>
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/compiled/remark-gfm/index.js ADDED Viewed

@@ -0,0 +1 @@

package/compiled/remark-gfm/package.json ADDED Viewed

	@@ -0,0 +1 @@
1	+ {"name":"remark-gfm","author":"Titus Wormer <tituswormer@gmail.com> (https://wooorm.com)","license":"MIT","types":"index.d.ts"}

package/dist/compiler.d.ts CHANGED Viewed

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

package/dist/compiler.js CHANGED Viewed

@@ -1,30 +1,46 @@
 "use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 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 rehype_pretty_code_1 = __importDefault(require("rehype-pretty-code"));
+const plugin_utils_1 = require("umi/plugin-utils");
 // @ts-ignore
 const mdx_1 = require("../compiled/@mdx-js/mdx");
 // @ts-ignore
 const rehype_slug_1 = __importDefault(require("../compiled/rehype-slug"));
-function compile(opts) {
-    return __awaiter(this, void 0, void 0, function* () {
-        const compiler = (0, mdx_1.createProcessor)({
-            jsx: true,
-            remarkPlugins: [],
-            rehypePlugins: [rehype_slug_1.default],
-        });
-        let result = String(yield compiler.process(opts.content));
+// @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';
@@ -32,14 +48,32 @@ function MDXContent(props = {}) {
   useEffect(() => {
     if (window.location.hash.length !== 0) {
-      const hash = window.location.hash;
-      window.location.hash = '';
-      window.location.hash = hash;
+      // 为了右侧内容区能正常跳转
+      const hash = decodeURIComponent(window.location.hash);
+      setTimeout(() => {
+        document.getElementById(hash.slice(1))?.scrollIntoView();
+      }, 100);
+    } 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.js CHANGED Viewed

@@ -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];
@@ -25,8 +29,25 @@ 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.conventionRoutes = {
+            ...memo.conventionRoutes,
+            base: (0, path_1.join)(api.cwd, 'docs'),
+        };
         memo.mdx = {
             loader: require.resolve('./loader'),
             loaderOptions: {},
@@ -56,6 +77,25 @@ 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] = {
+                        ...r[defaultLangFile],
+                        path: `/${l}/${r[defaultLangFile].path}`,
+                    };
+                }
+            });
+        }
+        return r;
+    });
     api.onGenerateFiles(() => {
         var _a;
         // theme path
@@ -64,23 +104,10 @@ exports.default = (api) => {
             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 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 = {};';
-        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)};
-`;
-                }
-            });
-        }
+        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'),
@@ -91,15 +118,15 @@ exports.default = (api) => {
             content: `
 export { ${exports
                 .filter((item) => !item.startsWith('$'))
-                .join(', ')} } from '${require.resolve('../client/theme-doc/index.ts')}';
+                .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 '${require.resolve('../client/theme-doc/index.ts')}';
+import { useOutlet, useAppData, useLocation, Link, history } 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 = {}`}
@@ -111,12 +138,12 @@ export default () => {
   const appData = useAppData();
   const location = useLocation();
   return (
-    <Layout appData={appData} components={{Link}} themeConfig={themeConfig} location={location}>
+    <Layout appData={appData} components={{Link}} themeConfig={themeConfig} location={location} history={history}>
       <div>{ outlet }</div>
     </Layout>
   );
 };
-    `,
+`,
         });
     });
 };

package/dist/loader.js CHANGED Viewed

@@ -1,23 +1,22 @@
 "use strict";
-var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
-    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
-    return new (P || (P = Promise))(function (resolve, reject) {
-        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
-        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
-        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
-        step((generator = generator.apply(thisArg, _arguments || [])).next());
-    });
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 const compiler_1 = require("./compiler");
-function default_1(content) {
-    return __awaiter(this, void 0, void 0, function* () {
-        // @ts-ignore
-        const callback = this.async();
-        const { result } = yield (0, compiler_1.compile)({
+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.js CHANGED Viewed

@@ -2,7 +2,9 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.parseTitle = void 0;
 function parseTitle(opts) {
-    const lines = opts.content.split('\n');
+    const lines = opts.content
+        .replace(/{[\n\s\t]*\/\*[\s\S]*?\*\/[\n\s\t]*}/g, '')
+        .split('\n');
     let i = 0;
     const ret = [];
     while (i < lines.length) {