@modern-js/app-tools 2.54.1 → 2.54.2-alpha.3

package/dist/js/modern/analyze/generateCode.js

@@ -0,0 +1,179 @@
+import path from 'path';
+import { fs } from '@modern-js/utils';
+import * as templates from "./templates";
+import { getClientRoutes } from "./getClientRoutes";
+import { FILE_SYSTEM_ROUTES_FILE_NAME, ENTRY_POINT_FILE_NAME, ENTRY_BOOTSTRAP_FILE_NAME } from "./constants";
+import { getDefaultImports } from "./utils";
+
+const createImportSpecifier = specifiers => {
+  let defaults = '';
+  const named = [];
+
+  for (const {
+    local,
+    imported
+  } of specifiers) {
+    if (local && imported) {
+      named.push(`${imported} as ${local}`);
+    } else if (local) {
+      defaults = local;
+    } else {
+      named.push(imported);
+    }
+  }
+
+  if (defaults && named.length) {
+    return `${defaults}, { ${named.join(', ')} }`;
+  } else if (defaults) {
+    return defaults;
+  } else {
+    return `{ ${named.join(', ')} }`;
+  }
+};
+
+export const createImportStatements = statements => {
+  // merge import statements with the same value.
+  const deDuplicated = [];
+  const seen = new Map();
+
+  for (const {
+    value,
+    specifiers,
+    initialize
+  } of statements) {
+    if (!seen.has(value)) {
+      deDuplicated.push({
+        value,
+        specifiers,
+        initialize
+      });
+      seen.set(value, specifiers);
+    } else {
+      var _deDuplicated$modifyI, _deDuplicated$modifyI2;
+
+      seen.get(value).push(...specifiers); // make "initialize" param can be connected when multiple plugins were imported from same package
+
+      const modifyIndex = deDuplicated.findIndex(v => v.value === value);
+      const originInitialize = (_deDuplicated$modifyI = (_deDuplicated$modifyI2 = deDuplicated[modifyIndex]) === null || _deDuplicated$modifyI2 === void 0 ? void 0 : _deDuplicated$modifyI2.initialize) !== null && _deDuplicated$modifyI !== void 0 ? _deDuplicated$modifyI : '';
+      deDuplicated[modifyIndex].initialize = originInitialize.concat(`\n${initialize || ''}`);
+    }
+  }
+
+  return deDuplicated.map(({
+    value,
+    specifiers,
+    initialize
+  }) => `import ${createImportSpecifier(specifiers)} from '${value}';\n${initialize || ''}`).join('\n');
+};
+export const generateCode = async (appContext, config, entrypoints, api) => {
+  const {
+    internalDirectory,
+    srcDirectory,
+    internalDirAlias,
+    internalSrcAlias
+  } = appContext;
+  const hookRunners = api.useHookRunners();
+  const {
+    output: {
+      mountId
+    }
+  } = config;
+
+  for (const entrypoint of entrypoints) {
+    const {
+      entryName,
+      isAutoMount,
+      customBootstrap,
+      fileSystemRoutes
+    } = entrypoint;
+
+    if (isAutoMount) {
+      // generate routes file for file system routes entrypoint.
+      if (fileSystemRoutes) {
+        const initialRoutes = getClientRoutes({
+          entrypoint,
+          srcDirectory,
+          srcAlias: internalSrcAlias,
+          internalDirectory,
+          internalDirAlias
+        });
+        const {
+          routes
+        } = await hookRunners.modifyFileSystemRoutes({
+          entrypoint,
+          routes: initialRoutes
+        });
+        const {
+          code
+        } = await hookRunners.beforeGenerateRoutes({
+          entrypoint,
+          code: templates.fileSystemRoutes({
+            routes
+          })
+        });
+        fs.outputFileSync(path.resolve(internalDirectory, `./${entryName}/${FILE_SYSTEM_ROUTES_FILE_NAME}`), code, 'utf8');
+      } // call modifyEntryImports hook
+
+
+      const {
+        imports: importStatements
+      } = await hookRunners.modifyEntryImports({
+        entrypoint,
+        imports: getDefaultImports({
+          entrypoint,
+          srcDirectory,
+          internalSrcAlias,
+          internalDirAlias,
+          internalDirectory
+        })
+      }); // call modifyEntryRuntimePlugins hook
+
+      const {
+        plugins
+      } = await hookRunners.modifyEntryRuntimePlugins({
+        entrypoint,
+        plugins: []
+      }); // call modifyEntryRenderFunction hook
+
+      const {
+        code: renderFunction
+      } = await hookRunners.modifyEntryRenderFunction({
+        entrypoint,
+        code: templates.renderFunction({
+          plugins,
+          customBootstrap,
+          fileSystemRoutes
+        })
+      }); // call modifyEntryExport hook
+
+      const {
+        exportStatement
+      } = await hookRunners.modifyEntryExport({
+        entrypoint,
+        exportStatement: 'export default AppWrapper;'
+      });
+      const code = templates.index({
+        mountId: mountId,
+        imports: createImportStatements(importStatements),
+        renderFunction,
+        exportStatement
+      });
+      const entryFile = path.resolve(internalDirectory, `./${entryName}/${ENTRY_POINT_FILE_NAME}`);
+      entrypoint.entry = entryFile; // generate entry file.
+
+      if (config.source.enableAsyncEntry) {
+        const {
+          code: asyncEntryCode
+        } = await hookRunners.modifyAsyncEntry({
+          entrypoint,
+          code: `import('./${ENTRY_BOOTSTRAP_FILE_NAME}');`
+        });
+        fs.outputFileSync(entryFile, asyncEntryCode, 'utf8');
+        const bootstrapFile = path.resolve(internalDirectory, `./${entryName}/${ENTRY_BOOTSTRAP_FILE_NAME}`);
+        fs.outputFileSync(bootstrapFile, code, 'utf8');
+      } else {
+        fs.outputFileSync(entryFile, code, 'utf8');
+      }
+    }
+  }
+};

package/dist/js/modern/analyze/getBundleEntry.js

@@ -0,0 +1,75 @@
+import path from 'path';
+import { ensureAbsolutePath, fs, findExists, MAIN_ENTRY_NAME } from '@modern-js/utils';
+import { getFileSystemEntry } from "./getFileSystemEntry";
+import { JS_EXTENSIONS } from "./constants";
+
+const ensureExtensions = file => {
+  if (!path.extname(file)) {
+    return findExists(JS_EXTENSIONS.map(ext => `${file}${ext}`)) || file;
+  }
+
+  return file;
+};
+
+const ifAlreadyExists = (entrypoints, checked) => entrypoints.some(entrypoint => {
+  if (ensureExtensions(entrypoint.entry) === ensureExtensions(checked.entry)) {
+    // reset entryName
+    checked.entryName = entrypoint.entryName;
+    return true;
+  } // filesystem routes entrypoint conflict with normal entrypoint.
+
+
+  if (entrypoint.entry.startsWith(checked.entry) || checked.entry.startsWith(entrypoint.entry)) {
+    throw new Error(`Entry configuration conflicts\n Your configuration: ${checked.entry}.\n Default entrypoint: ${entrypoint.entry}\n Please reset source.entries or set source.disableDefaultEntries to disable the default entry rules.`);
+  }
+
+  return false;
+});
+
+export const getBundleEntry = (appContext, config) => {
+  const {
+    appDirectory,
+    packageName
+  } = appContext;
+  const {
+    source: {
+      disableDefaultEntries,
+      entries,
+      entriesDir
+    }
+  } = config;
+  const defaults = disableDefaultEntries ? [] : getFileSystemEntry(appContext, config); // merge entrypoints from user config with directory convention.
+
+  if (entries) {
+    Object.keys(entries).forEach(name => {
+      const value = entries[name];
+      const entrypoint = typeof value === 'string' ? {
+        entryName: name,
+        entry: ensureAbsolutePath(appDirectory, value),
+        isAutoMount: true,
+        fileSystemRoutes: fs.statSync(ensureAbsolutePath(appDirectory, value)).isDirectory() ? {} : undefined
+      } : {
+        entryName: name,
+        entry: ensureAbsolutePath(appDirectory, value.entry),
+        isAutoMount: !value.disableMount,
+        fileSystemRoutes: value.enableFileSystemRoutes ? {} : undefined
+      };
+
+      if (!ifAlreadyExists(defaults, entrypoint)) {
+        defaults.push(entrypoint);
+      }
+    });
+  }
+
+  if (!disableDefaultEntries) {
+    // find main entry point which server route is '/'.
+    const entriesDirAbs = ensureAbsolutePath(appDirectory, entriesDir);
+    const found = defaults.find(({
+      entryName,
+      entry
+    }) => entryName === packageName || path.dirname(entry) === entriesDirAbs);
+    found && (found.entryName = MAIN_ENTRY_NAME);
+  }
+
+  return defaults;
+};

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;
+};