@modern-js/app-tools 2.54.2 → 2.54.3-alpha.4

package/dist/js/modern/analyze/getClientRoutes.js

@@ -0,0 +1,219 @@
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+
+function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+
+import path from 'path';
+import { fs, createDebugger, findExists, normalizeToPosixPath } from '@modern-js/utils';
+import { makeLegalIdentifier } from "./makeLegalIdentifier";
+import { FILE_SYSTEM_ROUTES_COMPONENTS_DIR, FILE_SYSTEM_ROUTES_DYNAMIC_REGEXP, FILE_SYSTEM_ROUTES_GLOBAL_LAYOUT, FILE_SYSTEM_ROUTES_IGNORED_REGEX, FILE_SYSTEM_ROUTES_INDEX, FILE_SYSTEM_ROUTES_LAYOUT, JS_EXTENSIONS } 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 shouldSkip = file => {
+  // should not skip directory.
+  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;
+};
+
+const replaceWithAlias = (base, filePath, alias) => normalizeToPosixPath(path.join(alias, path.relative(base, filePath)));
+
+const compName = (srcDirectory, filePath) => {
+  const legalCompName = makeLegalIdentifier(path.relative(srcDirectory, filePath));
+  return `Comp_${legalCompName}`;
+};
+
+const layoutNameAbbr = filePath => {
+  const prefix = 'L_';
+  const dirName = path.dirname(filePath).split('/').pop() || '';
+  return `${prefix}${makeLegalIdentifier(dirName)}`;
+};
+
+const parents = [];
+/* eslint-disable no-param-reassign */
+
+const recursiveReadDir = ({
+  dir,
+  routes,
+  basePath: _basePath = '/',
+  srcDirectory,
+  srcAlias
+}) => {
+  let hasDynamicRoute = false;
+  let resetParent = false;
+  let parent = parents[parents.length - 1];
+  const layout = findLayout(dir);
+
+  if (layout) {
+    if (_basePath === '/') {
+      throw new Error(`should use _app instead of _layout in ${dir}`);
+    } else {
+      const alias = replaceWithAlias(srcDirectory, layout, srcAlias);
+      const componentName = compName(srcDirectory, layout);
+      const route = {
+        path: `${_basePath.substring(0, _basePath.length - 1)}`,
+        exact: false,
+        routes: [],
+        _component: alias,
+        component: componentName,
+        parent
+      };
+      parent = route;
+      resetParent = true;
+      routes.push(route);
+      parents.push(route);
+      routes = route.routes;
+    }
+  }
+
+  for (const relative of fs.readdirSync(dir)) {
+    const filePath = path.join(dir, relative);
+
+    if (!shouldSkip(filePath)) {
+      const filename = path.basename(filePath, path.extname(filePath));
+      const alias = replaceWithAlias(srcDirectory, filePath, srcAlias);
+      const componentName = compName(srcDirectory, filePath);
+      const dynamicRouteMatched = FILE_SYSTEM_ROUTES_DYNAMIC_REGEXP.exec(filename);
+
+      if (dynamicRouteMatched) {
+        if (hasDynamicRoute) {
+          throw new Error(`Can't set two dynamic route in one directory: ${dir}`);
+        } else {
+          hasDynamicRoute = true;
+        }
+      }
+
+      const route = {
+        path: `${_basePath}${dynamicRouteMatched ? `:${dynamicRouteMatched[1]}${dynamicRouteMatched[2]}` : filename}`,
+        _component: alias,
+        component: componentName,
+        exact: true,
+        parent
+      };
+
+      if (fs.statSync(filePath).isDirectory()) {
+        recursiveReadDir({
+          dir: filePath,
+          routes,
+          basePath: `${route.path}/`,
+          srcDirectory,
+          srcAlias
+        });
+        continue;
+      }
+
+      if (filename === FILE_SYSTEM_ROUTES_LAYOUT) {
+        continue;
+      }
+
+      if (filename === FILE_SYSTEM_ROUTES_INDEX) {
+        route.path = _basePath === '/' ? _basePath : `${_basePath.substring(0, _basePath.length - 1)}`;
+      }
+
+      if (filename === '404' && _basePath === '/') {
+        route.path = '*';
+        route.exact = false;
+      }
+
+      routes.push(route);
+    }
+  }
+
+  if (resetParent) {
+    parents.pop();
+  }
+};
+/* eslint-enable  no-param-reassign */
+
+
+const normalizeNestedRoutes = (nested, internalComponentsDir, internalDirectory, internalDirAlias) => {
+  const flat = routes => routes.reduce((memo, route) => memo.concat(Array.isArray(route.routes) ? flat(route.routes) : [route]), []);
+
+  const generate = route => {
+    const codes = [];
+    let lastComponent = route.component;
+    const imports = [`import React from 'react';`, `import ${lastComponent} from '${route._component}'`]; // eslint-disable-next-line no-param-reassign, no-cond-assign
+
+    while (route = route.parent) {
+      const layoutComponent = route.component;
+      const layoutComponentAbbr = layoutNameAbbr(route._component);
+      imports.push(`import ${layoutComponent} from '${route._component}';`);
+      const currentComponent = `${layoutComponentAbbr}_${lastComponent}`;
+      codes.push(`const ${currentComponent} = props => <${layoutComponent} Component={${lastComponent}} {...props} />;`);
+      lastComponent = currentComponent;
+    }
+
+    const file = path.resolve(internalComponentsDir, `${lastComponent}.jsx`);
+    fs.outputFileSync(file, `${imports.join('\n')}\n${codes.join('\n')}\nexport default ${lastComponent}`);
+    return {
+      component: lastComponent,
+      _component: replaceWithAlias(internalDirectory, file, internalDirAlias)
+    };
+  };
+
+  const normalized = flat(nested).map(route => route.parent ? _objectSpread(_objectSpread(_objectSpread({}, route), generate(route)), {}, {
+    parent: undefined
+  }) : _objectSpread(_objectSpread({}, route), {}, {
+    parent: undefined
+  }));
+  return normalized;
+};
+
+const getRouteWeight = route => route === '*' ? 999 : route.split(':').length - 1;
+
+export const getClientRoutes = ({
+  entrypoint,
+  srcDirectory,
+  srcAlias,
+  internalDirectory,
+  internalDirAlias
+}) => {
+  const {
+    entry,
+    entryName
+  } = entrypoint;
+
+  if (!fs.existsSync(entry)) {
+    throw new Error(`generate file system routes error, ${entry} directory not found.`);
+  }
+
+  if (!(fs.existsSync(entry) && fs.statSync(entry).isDirectory())) {
+    throw new Error(`generate file system routes error, ${entry} should be directory.`);
+  }
+
+  let routes = [];
+  recursiveReadDir({
+    dir: entry,
+    routes,
+    basePath: '/',
+    srcDirectory,
+    srcAlias
+  });
+  const internalComponentsDir = path.resolve(internalDirectory, `${entryName}/${FILE_SYSTEM_ROUTES_COMPONENTS_DIR}`);
+  fs.emptyDirSync(internalComponentsDir);
+  routes = normalizeNestedRoutes(routes, internalComponentsDir, internalDirectory, internalDirAlias);
+  parents.length = 0; // FIXME: support more situations
+
+  routes.sort((a, b) => {
+    const delta = getRouteWeight(a.path) - getRouteWeight(b.path);
+
+    if (delta === 0) {
+      return a.path.length - b.path.length;
+    }
+
+    return delta;
+  });
+  debug(`fileSystem routes: %o`, routes);
+  return routes;
+};

package/dist/js/modern/analyze/getFileSystemEntry.js

@@ -0,0 +1,74 @@
+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 } 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 isBundleEntry = dir => hasApp(dir) || hasPages(dir) || hasIndex(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,
+      isAutoMount: false
+    };
+  }
+
+  if (hasApp(dir)) {
+    return {
+      entryName,
+      entry: path.join(dir, APP_FILE_NAME),
+      isAutoMount: true,
+      customBootstrap
+    };
+  } else if (hasPages(dir)) {
+    return {
+      entryName,
+      entry: path.join(dir, PAGES_DIR_NAME),
+      fileSystemRoutes: {
+        globalApp: findExists(JS_EXTENSIONS.map(ext => path.resolve(dir, `./${PAGES_DIR_NAME}/${FILE_SYSTEM_ROUTES_GLOBAL_LAYOUT}${ext}`)))
+      },
+      isAutoMount: true,
+      customBootstrap
+    };
+  } else {
+    return {
+      entryName,
+      entry: indexFile,
+      isAutoMount: false
+    };
+  }
+});
+
+export const getFileSystemEntry = (appContext, config) => {
+  const {
+    appDirectory
+  } = appContext;
+  const {
+    source: {
+      entriesDir
+    }
+  } = config;
+  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)));
+    } else {
+      throw Error(`source.entriesDir accept a directory.`);
+    }
+  } else {
+    throw Error(`src dir ${entriesDir} not found.`);
+  }
+};

package/dist/js/modern/analyze/getHtmlTemplate.js

@@ -0,0 +1,82 @@
+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;
+
+(function (PartialPosition) {
+  PartialPosition["TOP"] = "top";
+  PartialPosition["HEAD"] = "head";
+  PartialPosition["BODY"] = "body";
+  PartialPosition["BOTTOM"] = "bottom";
+  PartialPosition["INDEX"] = "index";
+})(PartialPosition || (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;
+}; // generate html template for
+
+
+export 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, PartialPosition.INDEX);
+
+    if (customIndexTemplate) {
+      htmlTemplates[entryName] = customIndexTemplate.file;
+    } else {
+      const hookRunners = api.useHookRunners();
+      const {
+        partials
+      } = await hookRunners.htmlPartials({
+        entrypoint,
+        partials: [PartialPosition.TOP, PartialPosition.HEAD, PartialPosition.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, PartialPosition.BOTTOM);
+
+      if (bottomTemplate) {
+        htmlTemplates[`__${entryName}-bottom__`] = bottomTemplate.content;
+      }
+    }
+  }
+
+  return htmlTemplates;
+};

package/dist/js/modern/analyze/getServerRoutes.js

@@ -0,0 +1,192 @@
+const _excluded = ["path"],
+      _excluded2 = ["path"];
+
+function _objectWithoutProperties(source, excluded) { if (source == null) return {}; var target = _objectWithoutPropertiesLoose(source, excluded); var key, i; if (Object.getOwnPropertySymbols) { var sourceSymbolKeys = Object.getOwnPropertySymbols(source); for (i = 0; i < sourceSymbolKeys.length; i++) { key = sourceSymbolKeys[i]; if (excluded.indexOf(key) >= 0) continue; if (!Object.prototype.propertyIsEnumerable.call(source, key)) continue; target[key] = source[key]; } } return target; }
+
+function _objectWithoutPropertiesLoose(source, excluded) { if (source == null) return {}; var target = {}; var sourceKeys = Object.keys(source); var key, i; for (i = 0; i < sourceKeys.length; i++) { key = sourceKeys[i]; if (excluded.indexOf(key) >= 0) continue; target[key] = source[key]; } return target; }
+
+function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); enumerableOnly && (symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; })), keys.push.apply(keys, symbols); } return keys; }
+
+function _objectSpread(target) { for (var i = 1; i < arguments.length; i++) { var source = null != arguments[i] ? arguments[i] : {}; i % 2 ? ownKeys(Object(source), !0).forEach(function (key) { _defineProperty(target, key, source[key]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)) : ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } return target; }
+
+function _defineProperty(obj, key, value) { if (key in obj) { Object.defineProperty(obj, key, { value: value, enumerable: true, configurable: true, writable: true }); } else { obj[key] = value; } return obj; }
+
+import path from 'path';
+import fs from 'fs';
+import { urlJoin, isPlainObject, removeLeadingSlash, getEntryOptions, SERVER_BUNDLE_DIRECTORY, MAIN_ENTRY_NAME, removeTailSlash } from '@modern-js/utils';
+import { walkDirectory } from "./utils";
+/**
+ * Add base url for each server route.
+ * @param baseUrl - Base url from server.baseUrl
+ * @param routes - Server routes.
+ * @returns Server routes with baseUrl prefixed.
+ */
+
+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 _objectSpread(_objectSpread({}, route), {}, {
+          urlPath: urlPath === '/' ? urlPath : removeTailSlash(urlPath)
+        });
+      });
+    }
+  }
+
+  return routes;
+};
+/**
+ *
+ * @param original - Original entrypoint route info.
+ * @param routeOptions - Custom entrypoint route config from server.routes.
+ * @returns
+ */
+
+
+const applyRouteOptions = (original, routeOptions) => {
+  const {
+    route,
+    disableSpa
+  } = routeOptions;
+  original.isSPA = !disableSpa; // set entryPath as dir
+
+  !original.isSPA && (original.entryPath = path.dirname(original.entryPath));
+  let routes;
+
+  if (route) {
+    if (Array.isArray(route)) {
+      routes = route.map(url => {
+        if (isPlainObject(url)) {
+          const _ref = url,
+                {
+            path: urlPath
+          } = _ref,
+                other = _objectWithoutProperties(_ref, _excluded);
+
+          return _objectSpread(_objectSpread(_objectSpread({}, original), other), {}, {
+            urlPath
+          });
+        } else {
+          return _objectSpread(_objectSpread({}, original), {}, {
+            urlPath: url
+          });
+        }
+      });
+    } else if (isPlainObject(route)) {
+      const _ref2 = route,
+            {
+        path: urlPath
+      } = _ref2,
+            other = _objectWithoutProperties(_ref2, _excluded2);
+
+      routes = [_objectSpread(_objectSpread(_objectSpread({}, original), other), {}, {
+        urlPath
+      })];
+    } else {
+      routes = [_objectSpread(_objectSpread({}, original), {}, {
+        urlPath: route
+      })];
+    }
+  } else {
+    routes = [original];
+  }
+
+  return routes;
+};
+/**
+ * Collect routes from entrypoints.
+ * @param entrypoints - Bundle entrypoints.
+ * @param config - Normalized user config.
+ * @returns entrypoint Routes
+ */
+
+
+const collectHtmlRoutes = (entrypoints, appContext, config) => {
+  const {
+    output: {
+      htmlPath,
+      disableHtmlFolder,
+      enableModernMode
+    },
+    server: {
+      baseUrl,
+      routes,
+      ssr,
+      ssrByEntries
+    }
+  } = config;
+  const {
+    packageName
+  } = appContext;
+  let htmlRoutes = entrypoints.reduce((previous, {
+    entryName
+  }) => {
+    const entryOptions = getEntryOptions(entryName, ssr, ssrByEntries, packageName);
+    const isSSR = Boolean(entryOptions);
+    const {
+      resHeaders
+    } = (routes === null || routes === void 0 ? 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,
+      enableModernMode: Boolean(enableModernMode),
+      bundle: isSSR ? `${SERVER_BUNDLE_DIRECTORY}/${entryName}.js` : undefined
+    };
+
+    if (routes !== null && routes !== 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;
+};
+/**
+ * Collect static public file routes from config/public folder.
+ * @param appContext - App context info.
+ * @param config - normalized user config.
+ * @returns Static public file routes.
+ */
+
+
+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))
+    };
+  }) : [];
+};
+
+export const getServerRoutes = (entrypoints, {
+  appContext,
+  config
+}) => [...collectHtmlRoutes(entrypoints, appContext, config), ...collectStaticRoutes(appContext, config)];
+
+const toPosix = pathStr => pathStr.split(path.sep).join(path.posix.sep);