@umijs/plugin-docs 4.2.6-alpha.6 → 4.2.6

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,113 @@
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/compiler.ts
+var compiler_exports = {};
+__export(compiler_exports, {
+  compile: () => compile
+});
+module.exports = __toCommonJS(compiler_exports);
+var import_rehype_pretty_code = __toESM(require("rehype-pretty-code"));
+var import_plugin_utils = require("umi/plugin-utils");
+var import_mdx = require("../compiled/@mdx-js/mdx");
+var import_rehype_slug = __toESM(require("../compiled/rehype-slug"));
+var import_remark_gfm = __toESM(require("../compiled/remark-gfm"));
+var import_rehype_autolink_headings = __toESM(require("../compiled/rehype-autolink-headings"));
+var rehypePrettyCodeOptions = {
+  theme: "dark-plus",
+  onVisitLine(node) {
+    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, import_mdx.createProcessor)({
+    jsx: true,
+    remarkPlugins: [import_remark_gfm.default],
+    rehypePlugins: [
+      import_rehype_slug.default,
+      [import_rehype_pretty_code.default, rehypePrettyCodeOptions],
+      import_rehype_autolink_headings.default
+    ]
+  });
+  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 = 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) {
+    import_plugin_utils.logger.error(e.reason);
+    import_plugin_utils.logger.error(`Above error occurred in ${opts.fileName} at line ${e.line}`);
+    import_plugin_utils.logger.error(
+      opts.content.split("\n").filter((_, i) => i == e.line - 1).join("\n")
+    );
+    import_plugin_utils.logger.error(" ".repeat(e.column - 1) + "^");
+    if (process.env.NODE_ENV === "production") {
+      throw new Error("compile error", { cause: e });
+    }
+    return { result: "" };
+  }
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  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,172 @@
+var __create = Object.create;
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __getProtoOf = Object.getPrototypeOf;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toESM = (mod, isNodeMode, target) => (target = mod != null ? __create(__getProtoOf(mod)) : {}, __copyProps(
+  // If the importer is in node compatibility mode or this is not an ESM
+  // file that has been converted to a CommonJS file using a Babel-
+  // compatible transform (i.e. "__esModule" has not been set), then set
+  // "default" to the CommonJS "module.exports" for node compatibility.
+  isNodeMode || !mod || !mod.__esModule ? __defProp(target, "default", { value: mod, enumerable: true }) : target,
+  mod
+));
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var src_exports = {};
+__export(src_exports, {
+  default: () => src_default
+});
+module.exports = __toCommonJS(src_exports);
+var import_bundler_utils = require("@umijs/bundler-utils");
+var import_utils = require("@umijs/utils");
+var import_fs = __toESM(require("fs"));
+var import_path = require("path");
+var import_markdown = require("./markdown");
+var src_default = (api) => {
+  const locales = {};
+  const localesPath = (0, import_path.join)(api.cwd, "docs/locales");
+  if ((0, import_fs.existsSync)(localesPath)) {
+    import_fs.default.readdirSync(localesPath).forEach((file) => {
+      if (file.endsWith(".json")) {
+        const filePath = (0, import_path.join)(localesPath, file);
+        const content = import_fs.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, import_path.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, import_markdown.parseTitle)({
+        content: route.__content
+      });
+    }
+    if (route.file.match(/.[a-z]{2}-[A-Z]{2}.md$/)) {
+      route.path = route.path.replace(/(.*).([a-z]{2}-[A-Z]{2})$/, "$2/$1");
+      if (route.path.endsWith("README")) {
+        route.path = route.path.replace(/README$/, "");
+      }
+    }
+  });
+  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;
+    let theme = ((_a = api.config.docs) == null ? void 0 : _a.theme) || require.resolve("../client/theme-doc/index.ts");
+    if (theme === "blog") {
+      theme = require.resolve("../client/theme-blog/index.ts");
+    }
+    theme = (0, import_utils.winPath)(theme);
+    const themeConfigPath = (0, import_utils.winPath)((0, import_path.join)(api.cwd, "theme.config.ts"));
+    const themeExists = (0, import_fs.existsSync)(themeConfigPath);
+    let injectLocale = `themeConfig.locales = ${JSON.stringify(locales)};`;
+    const [_, exports] = (0, import_bundler_utils.parseModuleSync)({
+      content: (0, import_fs.readFileSync)(theme, "utf-8"),
+      path: theme
+    });
+    api.writeTmpFile({
+      path: "index.ts",
+      content: `
+export { ${exports.filter((item) => !item.startsWith("$")).join(", ")} } from '${(0, import_utils.winPath)(
+        require.resolve("../client/theme-doc/index.ts")
+      )}';
+    `
+    });
+    api.writeTmpFile({
+      path: "Layout.tsx",
+      content: `
+import React from 'react';
+import { useOutlet, useAppData, useLocation, Link, history } from 'umi';
+import { $Layout as Layout } from '${(0, import_utils.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} history={history}>
+      <div>{ outlet }</div>
+    </Layout>
+  );
+};
+`
+    });
+  });
+  api.chainWebpack((memo) => {
+    if (api.env === "development") {
+      memo.plugin("fastRefresh").tap(([params]) => [
+        {
+          ...params,
+          include: /\.([cm]js|[jt]sx?|flow|md)$/i
+        }
+      ]);
+    }
+    return memo;
+  });
+};
+function withTmpPath(opts) {
+  return (0, import_path.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,40 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/loader.ts
+var loader_exports = {};
+__export(loader_exports, {
+  default: () => loader_default
+});
+module.exports = __toCommonJS(loader_exports);
+var import_compiler = require("./compiler");
+async function loader_default(content) {
+  const filename = this.resourcePath;
+  const callback = this.async();
+  try {
+    const { result } = await (0, import_compiler.compile)({
+      content,
+      fileName: filename
+    });
+    return callback(null, result);
+  } catch (e) {
+    const err = e;
+    e.message = `${filename}: ${e.message}`;
+    throw err;
+  }
+}

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,45 @@
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/markdown.ts
+var markdown_exports = {};
+__export(markdown_exports, {
+  parseTitle: () => parseTitle
+});
+module.exports = __toCommonJS(markdown_exports);
+function parseTitle(opts) {
+  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) {
+    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;
+}
+// Annotate the CommonJS export names for ESM import in node:
+0 && (module.exports = {
+  parseTitle
+});

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@umijs/plugin-docs",
-  "version": "4.2.6-alpha.6",
+  "version": "4.2.6",
   "description": "@umijs/plugin-docs",
   "homepage": "https://github.com/umijs/umi/tree/master/packages/plugin-docs#readme",
   "bugs": "https://github.com/umijs/umi/issues",
@@ -33,7 +33,7 @@
     "rehype-slug": "5.0.1",
     "remark-gfm": "^3.0.1",
     "tailwindcss": "^3.2.4",
-    "umi": "4.2.6-alpha.6"
+    "umi": "4.2.6"
   },
   "publishConfig": {
     "access": "public"