@modern-js/app-tools 2.54.0 → 2.54.1-alpha.0

package/dist/js/node/analyze/generateCode.js

@@ -0,0 +1,208 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.generateCode = exports.createImportStatements = void 0;
+
+var _path = _interopRequireDefault(require("path"));
+
+var _utils = require("@modern-js/utils");
+
+var templates = _interopRequireWildcard(require("./templates"));
+
+var _getClientRoutes = require("./getClientRoutes");
+
+var _constants = require("./constants");
+
+var _utils2 = require("./utils");
+
+function _getRequireWildcardCache(nodeInterop) { if (typeof WeakMap !== "function") return null; var cacheBabelInterop = new WeakMap(); var cacheNodeInterop = new WeakMap(); return (_getRequireWildcardCache = function (nodeInterop) { return nodeInterop ? cacheNodeInterop : cacheBabelInterop; })(nodeInterop); }
+
+function _interopRequireWildcard(obj, nodeInterop) { if (!nodeInterop && obj && obj.__esModule) { return obj; } if (obj === null || typeof obj !== "object" && typeof obj !== "function") { return { default: obj }; } var cache = _getRequireWildcardCache(nodeInterop); if (cache && cache.has(obj)) { return cache.get(obj); } var newObj = {}; var hasPropertyDescriptor = Object.defineProperty && Object.getOwnPropertyDescriptor; for (var key in obj) { if (key !== "default" && Object.prototype.hasOwnProperty.call(obj, key)) { var desc = hasPropertyDescriptor ? Object.getOwnPropertyDescriptor(obj, key) : null; if (desc && (desc.get || desc.set)) { Object.defineProperty(newObj, key, desc); } else { newObj[key] = obj[key]; } } } newObj.default = obj; if (cache) { cache.set(obj, newObj); } return newObj; }
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+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(', ')} }`;
+  }
+};
+
+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');
+};
+
+exports.createImportStatements = createImportStatements;
+
+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 = (0, _getClientRoutes.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
+          })
+        });
+
+        _utils.fs.outputFileSync(_path.default.resolve(internalDirectory, `./${entryName}/${_constants.FILE_SYSTEM_ROUTES_FILE_NAME}`), code, 'utf8');
+      } // call modifyEntryImports hook
+
+
+      const {
+        imports: importStatements
+      } = await hookRunners.modifyEntryImports({
+        entrypoint,
+        imports: (0, _utils2.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.default.resolve(internalDirectory, `./${entryName}/${_constants.ENTRY_POINT_FILE_NAME}`);
+
+      entrypoint.entry = entryFile; // generate entry file.
+
+      if (config.source.enableAsyncEntry) {
+        const {
+          code: asyncEntryCode
+        } = await hookRunners.modifyAsyncEntry({
+          entrypoint,
+          code: `import('./${_constants.ENTRY_BOOTSTRAP_FILE_NAME}');`
+        });
+
+        _utils.fs.outputFileSync(entryFile, asyncEntryCode, 'utf8');
+
+        const bootstrapFile = _path.default.resolve(internalDirectory, `./${entryName}/${_constants.ENTRY_BOOTSTRAP_FILE_NAME}`);
+
+        _utils.fs.outputFileSync(bootstrapFile, code, 'utf8');
+      } else {
+        _utils.fs.outputFileSync(entryFile, code, 'utf8');
+      }
+    }
+  }
+};
+
+exports.generateCode = generateCode;

package/dist/js/node/analyze/getBundleEntry.js

@@ -0,0 +1,89 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getBundleEntry = void 0;
+
+var _path = _interopRequireDefault(require("path"));
+
+var _utils = require("@modern-js/utils");
+
+var _getFileSystemEntry = require("./getFileSystemEntry");
+
+var _constants = require("./constants");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+const ensureExtensions = file => {
+  if (!_path.default.extname(file)) {
+    return (0, _utils.findExists)(_constants.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;
+});
+
+const getBundleEntry = (appContext, config) => {
+  const {
+    appDirectory,
+    packageName
+  } = appContext;
+  const {
+    source: {
+      disableDefaultEntries,
+      entries,
+      entriesDir
+    }
+  } = config;
+  const defaults = disableDefaultEntries ? [] : (0, _getFileSystemEntry.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: (0, _utils.ensureAbsolutePath)(appDirectory, value),
+        isAutoMount: true,
+        fileSystemRoutes: _utils.fs.statSync((0, _utils.ensureAbsolutePath)(appDirectory, value)).isDirectory() ? {} : undefined
+      } : {
+        entryName: name,
+        entry: (0, _utils.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 = (0, _utils.ensureAbsolutePath)(appDirectory, entriesDir);
+    const found = defaults.find(({
+      entryName,
+      entry
+    }) => entryName === packageName || _path.default.dirname(entry) === entriesDirAbs);
+    found && (found.entryName = _utils.MAIN_ENTRY_NAME);
+  }
+
+  return defaults;
+};
+
+exports.getBundleEntry = getBundleEntry;

package/dist/js/node/analyze/getClientRoutes.js

@@ -0,0 +1,241 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getClientRoutes = void 0;
+
+var _path = _interopRequireDefault(require("path"));
+
+var _utils = require("@modern-js/utils");
+
+var _makeLegalIdentifier = require("./makeLegalIdentifier");
+
+var _constants = require("./constants");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+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; }
+
+const debug = (0, _utils.createDebugger)('get-client-routes');
+
+const findLayout = dir => (0, _utils.findExists)(_constants.JS_EXTENSIONS.map(ext => _path.default.resolve(dir, `${_constants.FILE_SYSTEM_ROUTES_LAYOUT}${ext}`)));
+
+const shouldSkip = file => {
+  // should not skip directory.
+  if (_utils.fs.statSync(file).isDirectory()) {
+    return false;
+  }
+
+  const ext = _path.default.extname(file);
+
+  if (_constants.FILE_SYSTEM_ROUTES_IGNORED_REGEX.test(file) || !_constants.JS_EXTENSIONS.includes(ext) || _constants.FILE_SYSTEM_ROUTES_GLOBAL_LAYOUT === _path.default.basename(file, ext)) {
+    return true;
+  }
+
+  return false;
+};
+
+const replaceWithAlias = (base, filePath, alias) => (0, _utils.normalizeToPosixPath)(_path.default.join(alias, _path.default.relative(base, filePath)));
+
+const compName = (srcDirectory, filePath) => {
+  const legalCompName = (0, _makeLegalIdentifier.makeLegalIdentifier)(_path.default.relative(srcDirectory, filePath));
+  return `Comp_${legalCompName}`;
+};
+
+const layoutNameAbbr = filePath => {
+  const prefix = 'L_';
+  const dirName = _path.default.dirname(filePath).split('/').pop() || '';
+  return `${prefix}${(0, _makeLegalIdentifier.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 _utils.fs.readdirSync(dir)) {
+    const filePath = _path.default.join(dir, relative);
+
+    if (!shouldSkip(filePath)) {
+      const filename = _path.default.basename(filePath, _path.default.extname(filePath));
+
+      const alias = replaceWithAlias(srcDirectory, filePath, srcAlias);
+      const componentName = compName(srcDirectory, filePath);
+
+      const dynamicRouteMatched = _constants.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 (_utils.fs.statSync(filePath).isDirectory()) {
+        recursiveReadDir({
+          dir: filePath,
+          routes,
+          basePath: `${route.path}/`,
+          srcDirectory,
+          srcAlias
+        });
+        continue;
+      }
+
+      if (filename === _constants.FILE_SYSTEM_ROUTES_LAYOUT) {
+        continue;
+      }
+
+      if (filename === _constants.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.default.resolve(internalComponentsDir, `${lastComponent}.jsx`);
+
+    _utils.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;
+
+const getClientRoutes = ({
+  entrypoint,
+  srcDirectory,
+  srcAlias,
+  internalDirectory,
+  internalDirAlias
+}) => {
+  const {
+    entry,
+    entryName
+  } = entrypoint;
+
+  if (!_utils.fs.existsSync(entry)) {
+    throw new Error(`generate file system routes error, ${entry} directory not found.`);
+  }
+
+  if (!(_utils.fs.existsSync(entry) && _utils.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.default.resolve(internalDirectory, `${entryName}/${_constants.FILE_SYSTEM_ROUTES_COMPONENTS_DIR}`);
+
+  _utils.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;
+};
+
+exports.getClientRoutes = getClientRoutes;

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

@@ -0,0 +1,90 @@
+"use strict";
+
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.getFileSystemEntry = void 0;
+
+var _fs = _interopRequireDefault(require("fs"));
+
+var _path = _interopRequireDefault(require("path"));
+
+var _utils = require("@modern-js/utils");
+
+var _isDefaultExportFunction = require("./isDefaultExportFunction");
+
+var _constants = require("./constants");
+
+function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; }
+
+const hasIndex = dir => (0, _utils.findExists)(_constants.JS_EXTENSIONS.map(ext => _path.default.resolve(dir, `${_constants.INDEX_FILE_NAME}${ext}`)));
+
+const hasApp = dir => (0, _utils.findExists)(_constants.JS_EXTENSIONS.map(ext => _path.default.resolve(dir, `${_constants.APP_FILE_NAME}${ext}`)));
+
+const hasPages = dir => _fs.default.existsSync(_path.default.join(dir, _constants.PAGES_DIR_NAME));
+
+const isBundleEntry = dir => hasApp(dir) || hasPages(dir) || hasIndex(dir);
+
+const scanDir = dirs => dirs.map(dir => {
+  const indexFile = hasIndex(dir);
+  const customBootstrap = (0, _isDefaultExportFunction.isDefaultExportFunction)(indexFile) ? indexFile : false;
+
+  const entryName = _path.default.basename(dir);
+
+  if (indexFile && !customBootstrap) {
+    return {
+      entryName,
+      entry: indexFile,
+      isAutoMount: false
+    };
+  }
+
+  if (hasApp(dir)) {
+    return {
+      entryName,
+      entry: _path.default.join(dir, _constants.APP_FILE_NAME),
+      isAutoMount: true,
+      customBootstrap
+    };
+  } else if (hasPages(dir)) {
+    return {
+      entryName,
+      entry: _path.default.join(dir, _constants.PAGES_DIR_NAME),
+      fileSystemRoutes: {
+        globalApp: (0, _utils.findExists)(_constants.JS_EXTENSIONS.map(ext => _path.default.resolve(dir, `./${_constants.PAGES_DIR_NAME}/${_constants.FILE_SYSTEM_ROUTES_GLOBAL_LAYOUT}${ext}`)))
+      },
+      isAutoMount: true,
+      customBootstrap
+    };
+  } else {
+    return {
+      entryName,
+      entry: indexFile,
+      isAutoMount: false
+    };
+  }
+});
+
+const getFileSystemEntry = (appContext, config) => {
+  const {
+    appDirectory
+  } = appContext;
+  const {
+    source: {
+      entriesDir
+    }
+  } = config;
+  const src = (0, _utils.ensureAbsolutePath)(appDirectory, entriesDir);
+
+  if (_fs.default.existsSync(src)) {
+    if (_fs.default.statSync(src).isDirectory()) {
+      return scanDir(isBundleEntry(src) ? [src] : _fs.default.readdirSync(src).map(file => _path.default.join(src, file)).filter(file => _fs.default.statSync(file).isDirectory() && isBundleEntry(file)));
+    } else {
+      throw Error(`source.entriesDir accept a directory.`);
+    }
+  } else {
+    throw Error(`src dir ${entriesDir} not found.`);
+  }
+};
+
+exports.getFileSystemEntry = getFileSystemEntry;