@modern-js/plugin-ssg 1.0.0 → 1.1.2-rc.0

package/.eslintrc.js

@@ -0,0 +1,6 @@
+module.exports = {
+  extends: ['@modern-js'],
+  parserOptions: {
+    project: require.resolve('./tsconfig.json'),
+  },
+};

package/CHANGELOG.md

@@ -1,5 +1,47 @@
 # @modern-js/plugin-ssg
 
+## 1.1.2-rc.0
+
+### Patch Changes
+
+- d73ff455: support multi process product
+- d73ff455: support multi process product
+- d73ff455: support multi process product
+- d73ff455: support multi process product
+- d73ff455: support multi process product
+- Updated dependencies [d927bc83]
+- Updated dependencies [d73ff455]
+- Updated dependencies [9c1ab865]
+- Updated dependencies [d73ff455]
+- Updated dependencies [d73ff455]
+- Updated dependencies [d73ff455]
+- Updated dependencies [d73ff455]
+  - @modern-js/utils@1.1.4-rc.0
+  - @modern-js/core@1.1.4-rc.0
+
+## 1.1.1
+
+### Patch Changes
+
+- 0fa83663: support more .env files
+- Updated dependencies [6f7fe574]
+- Updated dependencies [0fa83663]
+- Updated dependencies [f594fbc8]
+  - @modern-js/core@1.1.2
+  - @modern-js/utils@1.1.2
+
+## 1.1.0
+
+### Minor Changes
+
+- 96119db2: Relese v1.1.0
+
+### Patch Changes
+
+- Updated dependencies [96119db2]
+  - @modern-js/core@1.1.0
+  - @modern-js/utils@1.1.0
+
 ## 1.0.0
 
 ### Patch Changes

package/README.md

@@ -17,10 +17,7 @@
 
 > The doc site ([modernjs.dev](https://modernjs.dev)) and articles are only available in Chinese for now, we are planning to add English versions soon.
 
-- 介绍 Modern.js (即将上线)
-- [迈入现代 Web 开发](https://zhuanlan.zhihu.com/p/386607009)
-- [现代 Web 开发者问卷调查报告](https://zhuanlan.zhihu.com/p/403206195)
-- [字节跳动是如何落地微前端的](https://mp.weixin.qq.com/s/L9wbfNG5fTXF5bx7dcgj4Q)
+- [Modern.js: Hello, World!](https://zhuanlan.zhihu.com/p/426707646)
 
 ## Getting Started
 

package/dist/js/modern/index.js

@@ -1,37 +1,21 @@
-import { path, INTERNAL_SRC_ALIAS, logger, upath, PLUGIN_SCHEMAS } from '@modern-js/utils';
+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 { logger, PLUGIN_SCHEMAS } from '@modern-js/utils';
 import { createPlugin, useAppContext, useResolvedConfigContext } from '@modern-js/core';
-import { LoaderManifest } from "./manifest-op";
-import { formatOutput, getOutput, getSSGRenderLevel, getUrlPrefix, parsedSSGConfig, readJSONSpec, replaceWithAlias, writeJSONSpec } from "./libs/util";
-import { invoker } from "./libs/invoker";
+import { generatePath } from 'react-router-dom';
+import { formatOutput, isDynamicUrl, readJSONSpec, standardOptions, writeJSONSpec } from "./libs/util";
 import { createServer } from "./server";
 import { writeHtmlFile } from "./libs/output";
 import { replaceRoute } from "./libs/replace";
-
-const listStaticFiles = (pwd, entriesDir, useSSG) => {
-  const absEntriesDir = path.join(pwd, entriesDir);
-  const staticRenderLevel = getSSGRenderLevel(useSSG);
-  const staticFiles = new LoaderManifest().get(absEntriesDir, staticRenderLevel); // 将绝对路径转换成 alias，因为获取到的约定路由也是使用别名的
-
-  const staticAlias = staticFiles.map(filepath => replaceWithAlias(path.join(pwd, 'src'), filepath, INTERNAL_SRC_ALIAS));
-  return staticAlias;
-};
-
+import { makeRoute } from "./libs/make";
 export default createPlugin(() => {
   const agreedRouteMap = {};
   return {
-    config() {
-      return {
-        tools: {
-          babel(config, {
-            chain
-          }) {
-            chain.plugin('./loader').use(upath.normalizeSafe(require.resolve("./loader")));
-          }
-
-        }
-      };
-    },
-
     validateSchema() {
       return PLUGIN_SCHEMAS['@modern-js/plugin-ssg'];
     },
@@ -57,16 +41,11 @@ export default createPlugin(() => {
 
       const appContext = useAppContext();
       const {
-        appDirectory
+        appDirectory,
+        entrypoints
       } = appContext;
       const {
-        output,
-        server: {
-          baseUrl
-        },
-        source: {
-          entriesDir
-        }
+        output
       } = resolvedConfig;
       const {
         ssg,
@@ -78,13 +57,8 @@ export default createPlugin(() => {
         return;
       }
 
-      const {
-        useSSG,
-        userHook
-      } = parsedSSGConfig(ssgOptions);
       const buildDir = path.join(appDirectory, outputPath);
-      const routes = readJSONSpec(buildDir);
-      const staticAlias = listStaticFiles(appDirectory, entriesDir, useSSG); // filter all routes not web
+      const routes = readJSONSpec(buildDir); // filter all routes not web
 
       const pageRoutes = routes.filter(route => !route.isApi);
       const apiRoutes = routes.filter(route => route.isApi); // if no web page route, skip ssg render
@@ -93,27 +67,91 @@ export default createPlugin(() => {
         return;
       }
 
-      const ssgRoutes = []; // callback of context.createPage, to format output, collect page route
-
-      const listener = (route, agreed) => {
-        const urlPrefix = getUrlPrefix(route, baseUrl);
-        const ssgOutput = getOutput(route, urlPrefix, agreed);
-        route.output = formatOutput(route.entryPath, ssgOutput);
-        ssgRoutes.push(route);
-      }; // check if every allowed agreed route was collected
-
+      const intermediateOptions = standardOptions(ssgOptions, entrypoints);
 
-      const autoAddAgreed = context => {
-        // if not exist in allowed list, return false
-        if (!staticAlias.includes(context.component)) {
-          return false;
-        } // if allowed, return collection state
+      if (!intermediateOptions) {
+        return;
+      }
 
+      const ssgRoutes = []; // each route will try to match the configuration
+
+      pageRoutes.forEach(pageRoute => {
+        const {
+          entryName,
+          entryPath
+        } = pageRoute;
+        const agreedRoutes = agreedRouteMap[entryName];
+        let entryOptions = intermediateOptions[entryName];
+
+        if (!agreedRoutes) {
+          var _entryOptions$routes;
+
+          // default behavior for non-agreed route
+          if (!entryOptions) {
+            return;
+          } // only add entry route if entryOptions is true
+
+
+          if (entryOptions === true) {
+            ssgRoutes.push(_objectSpread(_objectSpread({}, pageRoute), {}, {
+              output: entryPath
+            }));
+          } else if (((_entryOptions$routes = entryOptions.routes) === null || _entryOptions$routes === void 0 ? void 0 : _entryOptions$routes.length) > 0) {
+            // if entryOptions is object and has routes options
+            // add every route in options
+            const {
+              routes: enrtyRoutes,
+              headers
+            } = entryOptions;
+            enrtyRoutes.forEach(route => {
+              ssgRoutes.push(makeRoute(pageRoute, route, headers));
+            });
+          }
+        } else {
+          // Unless entryOptions is set to false
+          // the default behavior is to add all file-based routes
+          if (entryOptions === false) {
+            return;
+          }
 
-        return !ssgRoutes.some(ssgRoute => ssgRoute.urlPath === context.route.path);
-      };
+          if (!entryOptions || entryOptions === true) {
+            entryOptions = {
+              preventDefault: [],
+              routes: [],
+              headers: {}
+            };
+          }
 
-      await invoker(pageRoutes, agreedRouteMap, userHook, autoAddAgreed, listener);
+          const {
+            preventDefault = [],
+            routes: userRoutes = [],
+            headers
+          } = entryOptions; // if the user sets the routes, then only add them
+
+          if (userRoutes.length > 0) {
+            userRoutes.forEach(route => {
+              if (typeof route === 'string') {
+                ssgRoutes.push(makeRoute(pageRoute, route, headers));
+              } else if (Array.isArray(route.params)) {
+                route.params.forEach(param => {
+                  ssgRoutes.push(makeRoute(pageRoute, _objectSpread(_objectSpread({}, route), {}, {
+                    url: generatePath(route.url, param)
+                  }), headers));
+                });
+              } else {
+                ssgRoutes.push(makeRoute(pageRoute, route, headers));
+              }
+            });
+          } else {
+            // otherwith add all except dynamic routes
+            agreedRoutes.filter(route => !preventDefault.includes(route.path)).forEach(route => {
+              if (!isDynamicUrl(route.path)) {
+                ssgRoutes.push(makeRoute(pageRoute, route.path, headers));
+              }
+            });
+          }
+        }
+      });
 
       if (ssgRoutes.length === 0) {
         return;
@@ -132,6 +170,7 @@ export default createPlugin(() => {
         }
 
         ssgRoute.isSSR = false;
+        ssgRoute.output = formatOutput(ssgRoute.output);
       });
       const htmlAry = await createServer(ssgRoutes, apiRoutes, resolvedConfig, appDirectory); // write to dist file
 

package/dist/js/modern/libs/make.js

@@ -0,0 +1,37 @@
+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 normalize from 'normalize-path';
+export function makeRender(ssgRoutes, render, port) {
+  return ssgRoutes.map(ssgRoute => render({
+    url: ssgRoute.urlPath,
+    headers: _objectSpread({
+      host: `localhost:${port}`
+    }, ssgRoute.headers),
+    connection: {}
+  }));
+}
+export function makeRoute(baseRoute, route, headers = {}) {
+  const {
+    urlPath,
+    entryPath
+  } = baseRoute;
+
+  if (typeof route === 'string') {
+    return _objectSpread(_objectSpread({}, baseRoute), {}, {
+      urlPath: normalize(`${urlPath}${route}`) || '/',
+      headers,
+      output: path.join(entryPath, `..${route}`)
+    });
+  } else {
+    return _objectSpread(_objectSpread({}, baseRoute), {}, {
+      urlPath: normalize(`${urlPath}${route.url}`) || '/',
+      headers: _objectSpread(_objectSpread({}, headers), route.headers),
+      output: route.output ? path.normalize(route.output) : path.join(entryPath, `..${route.url}`)
+    });
+  }
+}

package/dist/js/modern/libs/output.js

@@ -1,4 +1,5 @@
-import { path, fs } from '@modern-js/utils';
+import path from 'path';
+import { fs } from '@modern-js/utils';
 export function writeHtmlFile(htmlAry, ssgRoutes, baseDir) {
   htmlAry.forEach((html, index) => {
     const ssgRoute = ssgRoutes[index];

package/dist/js/modern/libs/replace.js

@@ -1,8 +1,8 @@
-const _excluded = ["output"];
+const _excluded = ["output", "headers"];
 
-function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) { symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); } keys.push.apply(keys, symbols); } return keys; }
+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 = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { _defineProperty(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
+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; }
 
@@ -27,7 +27,8 @@ export function replaceRoute(ssgRoutes, pageRoutes) {
   // remove redundant fields and replace rendered entryPath
   const cleanSsgRoutes = ssgRoutes.map(ssgRoute => {
     const {
-      output
+      output,
+      headers
     } = ssgRoute,
           cleanSsgRoute = _objectWithoutProperties(ssgRoute, _excluded);
 

package/dist/js/modern/libs/util.js

@@ -1,9 +1,8 @@
-import { path, ROUTE_SPEC_FILE, fs } from '@modern-js/utils';
-import { MODE } from "../manifest-op";
-export function formatOutput(base, filename) {
-  const file = path.extname(filename) ? filename : `${filename}/index.html`;
-  const dirname = path.dirname(base);
-  return path.join(dirname, file);
+import path from 'path';
+import { ROUTE_SPEC_FILE, fs, isSingleEntry } from '@modern-js/utils';
+export function formatOutput(filename) {
+  const outputPath = path.extname(filename) ? filename : `${filename}/index.html`;
+  return outputPath;
 }
 export function formatPath(str) {
   let addr = str;
@@ -89,22 +88,40 @@ export const writeJSONSpec = (dir, routes) => {
     spaces: 2
   });
 };
-export const getSSGRenderLevel = key => {
-  const level = typeof key === 'boolean' ? MODE.LOOSE : MODE[key.toUpperCase()]; // currently only MODE.STRICT and MODE.LOOSE are supported
+export const replaceWithAlias = (base, filePath, alias) => path.posix.join(alias, path.posix.relative(base, filePath));
+export const standardOptions = (ssgOptions, entrypoints) => {
+  if (ssgOptions === false) {
+    return false;
+  }
+
+  if (ssgOptions === true) {
+    return entrypoints.reduce((opt, entry) => {
+      opt[entry.entryName] = ssgOptions;
+      return opt;
+    }, {});
+  } else if (typeof ssgOptions === 'object') {
+    const isSingle = isSingleEntry(entrypoints);
+
+    if (isSingle && typeof ssgOptions.main === 'undefined') {
+      return {
+        main: ssgOptions
+      };
+    } else {
+      return ssgOptions;
+    }
+  } else if (typeof ssgOptions === 'function') {
+    const intermediateOptions = {};
+
+    for (const entrypoint of entrypoints) {
+      const {
+        entryName
+      } = entrypoint; // Todo may be async function
 
-  if (!level || level > 2 || level < 1) {
-    throw new Error(`[SSG Render Fail] SSG 不支持当前 Mode，useSSG: ${key.toString()}, Level: ${level}`);
+      intermediateOptions[entryName] = ssgOptions(entryName);
+    }
+
+    return intermediateOptions;
   }
 
-  return level;
-};
-export const parsedSSGConfig = ssg => {
-  const useSSG = Boolean(ssg); // eslint-disable-next-line @typescript-eslint/no-empty-function
-
-  const userHook = typeof ssg === 'function' ? ssg : () => {};
-  return {
-    useSSG,
-    userHook
-  };
-};
-export const replaceWithAlias = (base, filePath, alias) => path.join(alias, path.relative(base, filePath));
+  return false;
+};

package/dist/js/modern/server/index.js

@@ -1,11 +1,12 @@
-function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) { symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); } keys.push.apply(keys, symbols); } return keys; }
+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 = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { _defineProperty(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
+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 childProcess from 'child_process';
-import { path, logger, SERVER_BUNDLE_DIRECTORY } from '@modern-js/utils';
+import path from 'path';
+import { logger, SERVER_BUNDLE_DIRECTORY } from '@modern-js/utils';
 import { useAppContext } from '@modern-js/core';
 import { CLOSE_SIGN } from "./consts";
 export const createServer = (ssgRoutes, apiRoutes, options, appDirectory) => new Promise((resolve, reject) => {

package/dist/js/modern/server/prerender.js

@@ -1,6 +1,6 @@
-function ownKeys(object, enumerableOnly) { var keys = Object.keys(object); if (Object.getOwnPropertySymbols) { var symbols = Object.getOwnPropertySymbols(object); if (enumerableOnly) { symbols = symbols.filter(function (sym) { return Object.getOwnPropertyDescriptor(object, sym).enumerable; }); } keys.push.apply(keys, symbols); } return keys; }
+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 = arguments[i] != null ? arguments[i] : {}; if (i % 2) { ownKeys(Object(source), true).forEach(function (key) { _defineProperty(target, key, source[key]); }); } else if (Object.getOwnPropertyDescriptors) { Object.defineProperties(target, Object.getOwnPropertyDescriptors(source)); } else { ownKeys(Object(source)).forEach(function (key) { Object.defineProperty(target, key, Object.getOwnPropertyDescriptor(source, key)); }); } } return target; }
+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; }
 

package/dist/js/modern/server/process.js

@@ -1,19 +1,19 @@
 import Server from '@modern-js/server';
 import portfinder from 'portfinder';
-import { compatRequire, upath } from '@modern-js/utils';
-import { makeRender } from "../libs/render";
+import { compatRequire } from '@modern-js/utils';
+import { makeRender } from "../libs/make";
 import { compile as createRender } from "./prerender";
 import { CLOSE_SIGN } from "./consts";
 
 const safetyRequire = (filename, base) => {
   try {
-    return compatRequire(upath.normalizeSafe(require.resolve(`${filename}/server`, {
+    return compatRequire(require.resolve(`${filename}/server`, {
       paths: [base]
-    })));
+    }));
   } catch (e) {
-    return compatRequire(upath.normalizeSafe(require.resolve(filename, {
+    return compatRequire(require.resolve(filename, {
       paths: [base]
-    })));
+    }));
   }
 };
 
@@ -56,7 +56,8 @@ process.on('message', async chunk => {
 
 
       const render = createRender(modernServer.getRequestHandler());
-      const renderPromiseAry = makeRender(routes.filter(route => !route.isApi), render, port);
+      const renderPromiseAry = makeRender(routes.filter(route => !route.isApi), render, port); // eslint-disable-next-line promise/no-promise-in-callback
+
       const htmlAry = await Promise.all(renderPromiseAry);
       htmlAry.forEach(html => {
         process.send(html);