@modern-js/app-tools 2.4.0 → 2.5.0-alpha.0

package/dist/esm-node/analyze/getClientRoutes/utils.js

@@ -0,0 +1,31 @@
+import path from "path";
+import { createDebugger, findExists, fs } from "@modern-js/utils";
+import {
+  JS_EXTENSIONS,
+  FILE_SYSTEM_ROUTES_LAYOUT,
+  FILE_SYSTEM_ROUTES_GLOBAL_LAYOUT,
+  FILE_SYSTEM_ROUTES_IGNORED_REGEX
+} from "../constants";
+const debug = createDebugger("get-client-routes");
+const findLayout = (dir) => findExists(
+  JS_EXTENSIONS.map(
+    (ext) => path.resolve(dir, `${FILE_SYSTEM_ROUTES_LAYOUT}${ext}`)
+  )
+);
+const getRouteWeight = (route) => route === "*" ? 999 : route.split(":").length - 1;
+const shouldSkip = (file) => {
+  if (fs.statSync(file).isDirectory()) {
+    return false;
+  }
+  const ext = path.extname(file);
+  if (FILE_SYSTEM_ROUTES_IGNORED_REGEX.test(file) || !JS_EXTENSIONS.includes(ext) || FILE_SYSTEM_ROUTES_GLOBAL_LAYOUT === path.basename(file, ext)) {
+    return true;
+  }
+  return false;
+};
+export {
+  debug,
+  findLayout,
+  getRouteWeight,
+  shouldSkip
+};

package/dist/esm-node/analyze/getFileSystemEntry.js

@@ -0,0 +1,109 @@
+import fs from "fs";
+import path from "path";
+import { findExists, ensureAbsolutePath } from "@modern-js/utils";
+import { isDefaultExportFunction } from "./isDefaultExportFunction";
+import {
+  JS_EXTENSIONS,
+  INDEX_FILE_NAME,
+  APP_FILE_NAME,
+  PAGES_DIR_NAME,
+  FILE_SYSTEM_ROUTES_GLOBAL_LAYOUT,
+  NESTED_ROUTES_DIR
+} from "./constants";
+const hasIndex = (dir) => findExists(
+  JS_EXTENSIONS.map((ext) => path.resolve(dir, `${INDEX_FILE_NAME}${ext}`))
+);
+const hasApp = (dir) => findExists(
+  JS_EXTENSIONS.map((ext) => path.resolve(dir, `${APP_FILE_NAME}${ext}`))
+);
+const hasPages = (dir) => fs.existsSync(path.join(dir, PAGES_DIR_NAME));
+const hasNestedRoutes = (dir) => fs.existsSync(path.join(dir, NESTED_ROUTES_DIR));
+const isBundleEntry = (dir) => hasApp(dir) || hasPages(dir) || hasIndex(dir) || hasNestedRoutes(dir);
+const scanDir = (dirs) => dirs.map((dir) => {
+  const indexFile = hasIndex(dir);
+  const customBootstrap = isDefaultExportFunction(indexFile) ? indexFile : false;
+  const entryName = path.basename(dir);
+  if (indexFile && !customBootstrap) {
+    return {
+      entryName,
+      entry: indexFile,
+      absoluteEntryDir: path.resolve(dir),
+      isAutoMount: false
+    };
+  }
+  const isHasApp = hasApp(dir);
+  if (isHasApp) {
+    return {
+      entryName,
+      entry: path.join(dir, APP_FILE_NAME),
+      isAutoMount: true,
+      absoluteEntryDir: path.resolve(dir),
+      customBootstrap
+    };
+  }
+  const isHasNestedRoutes = hasNestedRoutes(dir);
+  const isHasPages = hasPages(dir);
+  if (isHasNestedRoutes || isHasPages) {
+    const entrypoint = {
+      entryName,
+      entry: "",
+      fileSystemRoutes: {
+        globalApp: findExists(
+          JS_EXTENSIONS.map(
+            (ext) => path.resolve(
+              dir,
+              `./${PAGES_DIR_NAME}/${FILE_SYSTEM_ROUTES_GLOBAL_LAYOUT}${ext}`
+            )
+          )
+        )
+      },
+      isAutoMount: true,
+      absoluteEntryDir: path.resolve(dir),
+      customBootstrap
+    };
+    if (isHasPages) {
+      entrypoint.entry = path.join(dir, PAGES_DIR_NAME);
+      entrypoint.pageRoutesEntry = entrypoint.entry;
+    }
+    if (isHasNestedRoutes) {
+      entrypoint.entry = path.join(dir, NESTED_ROUTES_DIR);
+      entrypoint.nestedRoutesEntry = entrypoint.entry;
+    }
+    return entrypoint;
+  }
+  return {
+    entryName,
+    entry: indexFile,
+    absoluteEntryDir: path.resolve(dir),
+    isAutoMount: false
+  };
+});
+const getFileSystemEntry = (appContext, config) => {
+  const { appDirectory } = appContext;
+  const {
+    source: { entriesDir, disableEntryDirs }
+  } = config;
+  let disabledDirs = [];
+  if (disableEntryDirs && Array.isArray(disableEntryDirs)) {
+    disabledDirs = disableEntryDirs == null ? void 0 : disableEntryDirs.map(
+      (dir) => ensureAbsolutePath(appDirectory, dir)
+    );
+  }
+  const src = ensureAbsolutePath(appDirectory, entriesDir || "");
+  if (fs.existsSync(src)) {
+    if (fs.statSync(src).isDirectory()) {
+      return scanDir(
+        isBundleEntry(src) ? [src] : fs.readdirSync(src).map((file) => path.join(src, file)).filter(
+          (file) => fs.statSync(file).isDirectory() && isBundleEntry(file) && !disabledDirs.includes(file)
+        )
+      );
+    } else {
+      throw Error(`source.entriesDir accept a directory.`);
+    }
+  } else {
+    throw Error(`src dir ${entriesDir} not found.`);
+  }
+};
+export {
+  getFileSystemEntry
+};

package/dist/esm-node/analyze/getHtmlTemplate.js

@@ -0,0 +1,95 @@
+import path from "path";
+import { fs, findExists, MAIN_ENTRY_NAME } from "@modern-js/utils";
+import { HTML_PARTIALS_EXTENSIONS, HTML_PARTIALS_FOLDER } from "./constants";
+import * as templates from "./templates";
+var PartialPosition = /* @__PURE__ */ ((PartialPosition2) => {
+  PartialPosition2["TOP"] = "top";
+  PartialPosition2["HEAD"] = "head";
+  PartialPosition2["BODY"] = "body";
+  PartialPosition2["BOTTOM"] = "bottom";
+  PartialPosition2["INDEX"] = "index";
+  return PartialPosition2;
+})(PartialPosition || {});
+const findPartials = (dir, entryName, position) => {
+  if (fs.existsSync(dir)) {
+    const base = findExists(
+      HTML_PARTIALS_EXTENSIONS.map(
+        (ext) => path.resolve(dir, `${position}${ext}`)
+      )
+    );
+    const file = entryName ? findExists(
+      HTML_PARTIALS_EXTENSIONS.map(
+        (ext) => path.resolve(dir, entryName, `${position}${ext}`)
+      )
+    ) || base : base;
+    return file ? { file, content: fs.readFileSync(file, "utf8") } : null;
+  }
+  return null;
+};
+const getHtmlTemplate = async (entrypoints, api, {
+  appContext,
+  config
+}) => {
+  const { appDirectory, internalDirectory } = appContext;
+  const {
+    source: { configDir }
+  } = config;
+  const htmlDir = path.resolve(
+    appDirectory,
+    configDir || "",
+    HTML_PARTIALS_FOLDER
+  );
+  const htmlTemplates = {};
+  for (const entrypoint of entrypoints) {
+    const { entryName } = entrypoint;
+    const name = entrypoints.length === 1 && entryName === MAIN_ENTRY_NAME ? "" : entryName;
+    const customIndexTemplate = findPartials(
+      htmlDir,
+      name,
+      "index" /* INDEX */
+    );
+    if (customIndexTemplate) {
+      htmlTemplates[entryName] = customIndexTemplate.file;
+    } else {
+      const hookRunners = api.useHookRunners();
+      const { partials } = await hookRunners.htmlPartials({
+        entrypoint,
+        partials: [
+          "top" /* TOP */,
+          "head" /* HEAD */,
+          "body" /* BODY */
+        ].reduce(
+          (previous, position) => {
+            const found = findPartials(htmlDir, name, position);
+            previous[position] = found ? [found.content] : [];
+            return previous;
+          },
+          {
+            top: [],
+            head: [],
+            body: []
+          }
+        )
+      });
+      const templatePath = path.resolve(
+        internalDirectory,
+        entryName,
+        "index.html"
+      );
+      fs.outputFileSync(templatePath, templates.html(partials), "utf8");
+      htmlTemplates[entryName] = templatePath;
+      const bottomTemplate = findPartials(
+        htmlDir,
+        name,
+        "bottom" /* BOTTOM */
+      );
+      if (bottomTemplate) {
+        htmlTemplates[`__${entryName}-bottom__`] = bottomTemplate.content;
+      }
+    }
+  }
+  return htmlTemplates;
+};
+export {
+  getHtmlTemplate
+};

package/dist/esm-node/analyze/getServerRoutes.js

@@ -0,0 +1,154 @@
+import path from "path";
+import fs from "fs";
+import {
+  urlJoin,
+  isPlainObject,
+  removeLeadingSlash,
+  getEntryOptions,
+  SERVER_BUNDLE_DIRECTORY,
+  MAIN_ENTRY_NAME,
+  removeTailSlash,
+  SERVER_WORKER_BUNDLE_DIRECTORY
+} from "@modern-js/utils";
+import { walkDirectory } from "./utils";
+const applyBaseUrl = (baseUrl, routes) => {
+  if (baseUrl) {
+    if (Array.isArray(baseUrl)) {
+      return baseUrl.reduce(
+        (previous, current) => [...previous, ...applyBaseUrl(current, routes)],
+        []
+      );
+    } else {
+      return routes.map((route) => {
+        const urlPath = urlJoin(baseUrl, route.urlPath);
+        return {
+          ...route,
+          urlPath: urlPath === "/" ? urlPath : removeTailSlash(urlPath)
+        };
+      });
+    }
+  }
+  return routes;
+};
+const applyRouteOptions = (original, routeOptions) => {
+  const { route, disableSpa } = routeOptions;
+  original.isSPA = !disableSpa;
+  !original.isSPA && (original.entryPath = path.dirname(original.entryPath));
+  let routes;
+  if (route) {
+    if (Array.isArray(route)) {
+      routes = route.map((url) => {
+        if (isPlainObject(url)) {
+          const { path: urlPath, ...other } = url;
+          return {
+            ...original,
+            ...other,
+            urlPath
+          };
+        } else {
+          return {
+            ...original,
+            urlPath: url
+          };
+        }
+      });
+    } else if (isPlainObject(route)) {
+      const { path: urlPath, ...other } = route;
+      routes = [
+        {
+          ...original,
+          ...other,
+          urlPath
+        }
+      ];
+    } else {
+      routes = [
+        {
+          ...original,
+          urlPath: route
+        }
+      ];
+    }
+  } else {
+    routes = [original];
+  }
+  return routes;
+};
+const collectHtmlRoutes = (entrypoints, appContext, config) => {
+  const {
+    html: { disableHtmlFolder },
+    output: { distPath: { html: htmlPath } = {} },
+    server: { baseUrl, routes, ssr, ssrByEntries, worker }
+  } = config;
+  const { packageName } = appContext;
+  let htmlRoutes = entrypoints.reduce(
+    (previous, { entryName }) => {
+      const entryOptions = getEntryOptions(
+        entryName,
+        ssr,
+        ssrByEntries,
+        packageName
+      );
+      const isSSR = Boolean(entryOptions);
+      const isWorker = Boolean(worker);
+      const { resHeaders } = (routes == null ? void 0 : routes[entryName]) || {};
+      let route = {
+        urlPath: `/${entryName === MAIN_ENTRY_NAME ? "" : entryName}`,
+        entryName,
+        entryPath: removeLeadingSlash(
+          path.posix.normalize(
+            `${htmlPath}/${entryName}${disableHtmlFolder ? ".html" : "/index.html"}`
+          )
+        ),
+        isSPA: true,
+        isSSR,
+        responseHeaders: resHeaders,
+        worker: isWorker ? `${SERVER_WORKER_BUNDLE_DIRECTORY}/${entryName}.js` : void 0,
+        bundle: isSSR ? `${SERVER_BUNDLE_DIRECTORY}/${entryName}.js` : void 0
+      };
+      if (routes == null ? void 0 : routes.hasOwnProperty(entryName)) {
+        const routeOptions = isPlainObject(routes[entryName]) ? routes[entryName] : { route: routes[entryName] };
+        route = applyRouteOptions(route, routeOptions);
+      }
+      return Array.isArray(route) ? [...previous, ...route] : [...previous, route];
+    },
+    []
+  );
+  htmlRoutes = applyBaseUrl(baseUrl, htmlRoutes);
+  return htmlRoutes;
+};
+const collectStaticRoutes = (appContext, config) => {
+  const { appDirectory } = appContext;
+  const {
+    source: { configDir },
+    server: { publicRoutes = {} }
+  } = config;
+  const publicFolder = path.resolve(appDirectory, configDir || "", "public");
+  return fs.existsSync(publicFolder) ? walkDirectory(publicFolder).map((filePath) => {
+    const urlPath = `${urlJoin(
+      toPosix(filePath).slice(toPosix(publicFolder).length)
+    )}`;
+    return {
+      urlPath: publicRoutes[removeLeadingSlash(urlPath)] || urlPath,
+      isSPA: true,
+      isSSR: false,
+      entryPath: toPosix(
+        path.relative(
+          path.resolve(appDirectory, configDir || ""),
+          filePath
+        )
+      )
+    };
+  }) : [];
+};
+const getServerRoutes = (entrypoints, {
+  appContext,
+  config
+}) => [
+  ...collectHtmlRoutes(entrypoints, appContext, config),
+  ...collectStaticRoutes(appContext, config)
+];
+const toPosix = (pathStr) => pathStr.split(path.sep).join(path.posix.sep);
+export {
+  getServerRoutes
+};

package/dist/esm-node/analyze/index.js

@@ -0,0 +1,285 @@
+import * as path from "path";
+import {
+  createDebugger,
+  findExists,
+  fs,
+  getEntryOptions,
+  isApiOnly,
+  minimist,
+  getCommand,
+  isDevCommand
+} from "@modern-js/utils";
+import { cloneDeep } from "@modern-js/utils/lodash";
+import { printInstructions } from "../utils/printInstructions";
+import { generateRoutes } from "../utils/routes";
+import { emitResolvedConfig } from "../utils/config";
+import { getSelectedEntries } from "../utils/getSelectedEntries";
+import { initialNormalizedConfig } from "../config";
+import { createBuilderGenerator } from "../builder";
+import {
+  getServerLoadersFile,
+  isPageComponentFile,
+  parseModule,
+  replaceWithAlias
+} from "./utils";
+import {
+  APP_CONFIG_NAME,
+  APP_INIT_EXPORTED,
+  APP_INIT_IMPORTED
+} from "./constants";
+const debug = createDebugger("plugin-analyze");
+var analyze_default = ({
+  bundler
+}) => ({
+  name: "@modern-js/plugin-analyze",
+  setup: (api) => {
+    let pagesDir = [];
+    let nestedRouteEntries = [];
+    let originEntrypoints = [];
+    return {
+      async prepare() {
+        var _a;
+        let appContext = api.useAppContext();
+        const resolvedConfig = api.useResolvedConfigContext();
+        const hookRunners = api.useHookRunners();
+        try {
+          fs.emptydirSync(appContext.internalDirectory);
+        } catch {
+        }
+        const apiOnly = await isApiOnly(
+          appContext.appDirectory,
+          (_a = resolvedConfig.source) == null ? void 0 : _a.entriesDir
+        );
+        await hookRunners.addRuntimeExports();
+        if (apiOnly) {
+          const { routes: routes2 } = await hookRunners.modifyServerRoutes({
+            routes: []
+          });
+          debug(`server routes: %o`, routes2);
+          appContext = {
+            ...appContext,
+            apiOnly,
+            serverRoutes: routes2
+          };
+          api.setAppContext(appContext);
+          return;
+        }
+        const [
+          { getBundleEntry },
+          { getServerRoutes },
+          { generateCode },
+          { getHtmlTemplate }
+        ] = await Promise.all([
+          import("./getBundleEntry"),
+          import("./getServerRoutes"),
+          import("./generateCode"),
+          import("./getHtmlTemplate")
+        ]);
+        const entrypoints = getBundleEntry(appContext, resolvedConfig);
+        debug(`entrypoints: %o`, entrypoints);
+        const initialRoutes = getServerRoutes(entrypoints, {
+          appContext,
+          config: resolvedConfig
+        });
+        const { routes } = await hookRunners.modifyServerRoutes({
+          routes: initialRoutes
+        });
+        debug(`server routes: %o`, routes);
+        appContext = {
+          ...appContext,
+          entrypoints,
+          serverRoutes: routes
+        };
+        api.setAppContext(appContext);
+        nestedRouteEntries = entrypoints.map((point) => point.nestedRoutesEntry).filter(Boolean);
+        pagesDir = entrypoints.map((point) => point.entry).filter(Boolean).concat(nestedRouteEntries);
+        originEntrypoints = cloneDeep(entrypoints);
+        await generateCode(appContext, resolvedConfig, entrypoints, api);
+        const htmlTemplates = await getHtmlTemplate(entrypoints, api, {
+          appContext,
+          config: resolvedConfig
+        });
+        debug(`html templates: %o`, htmlTemplates);
+        await hookRunners.addDefineTypes();
+        debug(`add Define Types`);
+        let checkedEntries = entrypoints.map((point) => point.entryName);
+        if (isDevCommand()) {
+          const { entry } = minimist(process.argv.slice(2));
+          checkedEntries = await getSelectedEntries(
+            typeof entry === "string" ? entry.split(",") : entry,
+            entrypoints
+          );
+        }
+        appContext = {
+          ...appContext,
+          entrypoints,
+          checkedEntries,
+          apiOnly,
+          serverRoutes: routes,
+          htmlTemplates
+        };
+        api.setAppContext(appContext);
+        const command = getCommand();
+        const buildCommands = ["dev", "start", "build", "inspect", "deploy"];
+        if (buildCommands.includes(command)) {
+          const normalizedConfig = api.useResolvedConfigContext();
+          const createBuilderForModern = await createBuilderGenerator(bundler);
+          const builder = await createBuilderForModern({
+            normalizedConfig,
+            appContext,
+            async onBeforeBuild({ bundlerConfigs }) {
+              const hookRunners2 = api.useHookRunners();
+              await generateRoutes(appContext);
+              await hookRunners2.beforeBuild({
+                bundlerConfigs
+              });
+            },
+            async onAfterBuild({ stats }) {
+              const hookRunners2 = api.useHookRunners();
+              await hookRunners2.afterBuild({ stats });
+              await emitResolvedConfig(
+                appContext.appDirectory,
+                normalizedConfig
+              );
+            },
+            async onDevCompileDone({ isFirstCompile }) {
+              const hookRunners2 = api.useHookRunners();
+              if (process.stdout.isTTY || isFirstCompile) {
+                hookRunners2.afterDev();
+                if (isFirstCompile) {
+                  printInstructions(hookRunners2, appContext, normalizedConfig);
+                }
+              }
+            },
+            async onBeforeCreateCompiler({ bundlerConfigs }) {
+              const hookRunners2 = api.useHookRunners();
+              await hookRunners2.beforeCreateCompiler({
+                bundlerConfigs
+              });
+            },
+            async onAfterCreateCompiler({ compiler }) {
+              const hookRunners2 = api.useHookRunners();
+              await hookRunners2.afterCreateCompiler({
+                compiler
+              });
+            }
+          });
+          builder.addPlugins(resolvedConfig.builderPlugins);
+          appContext = {
+            ...appContext,
+            builder
+          };
+          api.setAppContext(appContext);
+        }
+      },
+      watchFiles() {
+        return pagesDir;
+      },
+      config() {
+        return {
+          tools: {
+            webpackChain: (chain, { name }) => {
+              const appContext = api.useAppContext();
+              const resolvedConfig = api.useResolvedConfigContext();
+              const { entrypoints, internalDirectory, packageName } = appContext;
+              entrypoints.forEach((entrypoint) => {
+                const { entryName } = entrypoint;
+                const ssr = getEntryOptions(
+                  entryName,
+                  resolvedConfig.server.ssr,
+                  resolvedConfig.server.ssrByEntries,
+                  packageName
+                );
+                if (entrypoint.nestedRoutesEntry && ssr && name === "server") {
+                  const serverLoadersFile = getServerLoadersFile(
+                    internalDirectory,
+                    entryName
+                  );
+                  chain.entry(`${entryName}-server-loaders`).add(serverLoadersFile);
+                  chain.resolve.alias.set(
+                    "@modern-js/plugin-data-loader/runtime",
+                    require.resolve("@modern-js/plugin-data-loader/runtime")
+                  );
+                }
+              });
+            }
+          }
+        };
+      },
+      resolvedConfig({ resolved }) {
+        const appContext = api.useAppContext();
+        const config = initialNormalizedConfig(resolved, appContext, bundler);
+        return {
+          resolved: config
+        };
+      },
+      async modifyEntryImports({ entrypoint, imports }) {
+        const appContext = api.useAppContext();
+        const { srcDirectory, internalSrcAlias } = appContext;
+        const { fileSystemRoutes, nestedRoutesEntry } = entrypoint;
+        if (fileSystemRoutes && nestedRoutesEntry) {
+          const rootLayoutPath = path.join(nestedRoutesEntry, "layout");
+          const rootLayoutFile = findExists(
+            [".js", ".ts", ".jsx", ".tsx"].map(
+              (ext) => `${rootLayoutPath}${ext}`
+            )
+          );
+          if (rootLayoutFile) {
+            const rootLayoutBuffer = await fs.readFile(rootLayoutFile);
+            const rootLayout = rootLayoutBuffer.toString();
+            const [, moduleExports] = await parseModule({
+              source: rootLayout.toString(),
+              filename: rootLayoutFile
+            });
+            const hasAppConfig = moduleExports.some(
+              (e) => e.n === APP_CONFIG_NAME
+            );
+            const generateLayoutPath = replaceWithAlias(
+              srcDirectory,
+              rootLayoutFile,
+              internalSrcAlias
+            );
+            if (hasAppConfig) {
+              imports.push({
+                value: generateLayoutPath,
+                specifiers: [{ imported: APP_CONFIG_NAME }]
+              });
+            }
+            const hasAppInit = moduleExports.some(
+              (e) => e.n === APP_INIT_EXPORTED
+            );
+            if (hasAppInit) {
+              imports.push({
+                value: generateLayoutPath,
+                specifiers: [
+                  { imported: APP_INIT_EXPORTED, local: APP_INIT_IMPORTED }
+                ]
+              });
+            }
+          }
+        }
+        return {
+          entrypoint,
+          imports
+        };
+      },
+      async fileChange(e) {
+        const appContext = api.useAppContext();
+        const { appDirectory } = appContext;
+        const { filename, eventType } = e;
+        const isPageFile = (name) => pagesDir.some((pageDir) => name.includes(pageDir));
+        const absoluteFilePath = path.resolve(appDirectory, filename);
+        const isRouteComponent = isPageFile(absoluteFilePath) && isPageComponentFile(absoluteFilePath);
+        if (isRouteComponent && (eventType === "add" || eventType === "unlink")) {
+          const resolvedConfig = api.useResolvedConfigContext();
+          const { generateCode } = await import("./generateCode");
+          const entrypoints = cloneDeep(originEntrypoints);
+          generateCode(appContext, resolvedConfig, entrypoints, api);
+        }
+      }
+    };
+  }
+});
+export {
+  analyze_default as default
+};