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

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

@@ -0,0 +1,91 @@
+import {
+  ensureAbsolutePath,
+  getPort,
+  isDev,
+  isDevCommand
+} from "@modern-js/utils";
+import { legacySchema, schema } from "../schema";
+import {
+  checkIsLegacyConfig,
+  createDefaultConfig,
+  createLegacyDefaultConfig,
+  transformNormalizedConfig
+} from "../config";
+var initialize_default = ({
+  bundler
+}) => ({
+  name: "@modern-js/plugin-initialize",
+  setup(api) {
+    const config = () => {
+      const appContext = api.useAppContext();
+      const userConfig = api.useConfigContext();
+      return checkIsLegacyConfig(userConfig) ? createLegacyDefaultConfig(appContext) : createDefaultConfig(appContext, bundler);
+    };
+    const validateSchema = () => {
+      const userConfig = api.useConfigContext();
+      const schemas = checkIsLegacyConfig(userConfig) ? legacySchema : schema;
+      return schemas.generate();
+    };
+    return {
+      config,
+      validateSchema,
+      async resolvedConfig({ resolved }) {
+        var _a;
+        let appContext = api.useAppContext();
+        const userConfig = api.useConfigContext();
+        const port = await getServerPort(resolved);
+        appContext = {
+          ...appContext,
+          port,
+          distDirectory: ensureAbsolutePath(
+            appContext.distDirectory,
+            ((_a = resolved.output.distPath) == null ? void 0 : _a.root) || "dist"
+          )
+        };
+        api.setAppContext(appContext);
+        const normalizedConfig = checkIsLegacyConfig(resolved) ? transformNormalizedConfig(resolved) : resolved;
+        resolved._raw = userConfig;
+        resolved.server = {
+          ...normalizedConfig.server || {},
+          port
+        };
+        resolved.autoLoadPlugins = normalizedConfig.autoLoadPlugins || false;
+        stabilizeConfig(resolved, normalizedConfig, [
+          "source",
+          "bff",
+          "dev",
+          "html",
+          "output",
+          "tools",
+          "testing",
+          "plugins",
+          "builderPlugins",
+          "runtime",
+          "runtimeByEntries",
+          "deploy",
+          "performance"
+        ]);
+        if (bundler === "webpack") {
+          resolved.security = normalizedConfig.security || {};
+          resolved.experiments = normalizedConfig.experiments;
+        }
+        return { resolved };
+      }
+    };
+  }
+});
+function stabilizeConfig(resolve, config, keys) {
+  keys.forEach((key) => {
+    resolve[key] = config[key] || {};
+  });
+}
+async function getServerPort(config) {
+  const prodPort = config.server.port || 8080;
+  if (isDev() && isDevCommand()) {
+    return getPort(config.dev.port || prodPort);
+  }
+  return prodPort;
+}
+export {
+  initialize_default as default
+};

package/dist/esm-node/locale/en.js

@@ -0,0 +1,36 @@
+const EN_LOCALE = {
+  command: {
+    shared: {
+      analyze: "analyze bundle size",
+      config: "specify config file"
+    },
+    dev: {
+      describe: "start dev server",
+      entry: "compiler by entry",
+      apiOnly: "start api server only",
+      selectEntry: "Please select the entry that needs to be built",
+      requireEntry: "You must choose at least one entry"
+    },
+    build: {
+      describe: "build application"
+    },
+    serve: { describe: "start server" },
+    deploy: { describe: "deploy application" },
+    new: {
+      describe: "generator runner for MWA project",
+      debug: "using debug mode to log something",
+      config: "set default generator config(json string)",
+      distTag: `use specified tag version for it's generator`,
+      registry: "set npm registry url to run npm command",
+      lang: "set new command language(en or zh)"
+    },
+    inspect: {
+      env: "specify env mode",
+      output: "specify inspect content output path",
+      verbose: "show full function definitions in output"
+    }
+  }
+};
+export {
+  EN_LOCALE
+};

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

@@ -0,0 +1,9 @@
+import { I18n } from "@modern-js/plugin-i18n";
+import { ZH_LOCALE } from "./zh";
+import { EN_LOCALE } from "./en";
+const i18n = new I18n();
+const localeKeys = i18n.init("zh", { zh: ZH_LOCALE, en: EN_LOCALE });
+export {
+  i18n,
+  localeKeys
+};

package/dist/esm-node/locale/zh.js

@@ -0,0 +1,36 @@
+const ZH_LOCALE = {
+  command: {
+    shared: {
+      analyze: "分析构建产物体积，查看各个模块打包后的大小",
+      config: "指定配置文件路径，可以为相对路径或绝对路径"
+    },
+    dev: {
+      describe: "本地开发命令",
+      entry: "指定入口，编译特定的页面",
+      apiOnly: "仅启动 API 接口服务",
+      selectEntry: "请选择需要构建的入口",
+      requireEntry: "请至少选择一个入口"
+    },
+    build: {
+      describe: "构建应用命令"
+    },
+    serve: { describe: "应用启动命令" },
+    deploy: { describe: "部署应用命令" },
+    new: {
+      describe: "Web App 项目中执行生成器",
+      debug: "开启 Debug 模式，打印调试日志信息",
+      config: "生成器运行默认配置(JSON 字符串)",
+      distTag: "生成器使用特殊的 npm Tag 版本",
+      registry: "生成器运行过程中定制 npm Registry",
+      lang: "设置 new 命令执行语言(zh 或者 en)"
+    },
+    inspect: {
+      env: "查看指定环境下的配置",
+      output: "指定在 dist 目录下输出的路径",
+      verbose: "在结果中展示函数的完整内容"
+    }
+  }
+};
+export {
+  ZH_LOCALE
+};

package/dist/esm-node/schema/Schema.js

@@ -0,0 +1,40 @@
+import { merge } from "@modern-js/utils/lodash";
+class Schema extends Map {
+  constructor(baseSchema = {}) {
+    super();
+    this.schema = baseSchema;
+  }
+  setSchema(key, object) {
+    Object.entries(object).forEach(([k, v]) => {
+      const target = `${key}.${k}`;
+      this.set(target, v);
+    });
+    return this;
+  }
+  set(key, value) {
+    if (this.has(key)) {
+      merge(this.schema[key], value);
+    } else {
+      this.schema[key] = value;
+    }
+    return this;
+  }
+  has(key) {
+    return key in this.schema;
+  }
+  get(key) {
+    return this.schema[key];
+  }
+  delete(key) {
+    return delete this.schema[key];
+  }
+  generate() {
+    return Object.entries(this.schema).map(([target, schema]) => ({
+      target,
+      schema
+    }));
+  }
+}
+export {
+  Schema
+};

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

@@ -0,0 +1,88 @@
+import { ENTRY_NAME_PATTERN } from "@modern-js/utils/constants";
+import { Schema } from "./Schema";
+const source = {
+  entries: {
+    type: "object",
+    patternProperties: {
+      [ENTRY_NAME_PATTERN]: {
+        if: { type: "object" },
+        then: {
+          required: ["entry"],
+          properties: {
+            entry: { type: ["string", "array"] },
+            disableMount: { type: "boolean" },
+            customBootstrap: { type: "string" }
+          },
+          additionalProperties: false
+        },
+        else: { type: ["string", "array"] }
+      }
+    }
+  },
+  enableAsyncEntry: { type: "boolean" },
+  disableDefaultEntries: { type: "boolean" },
+  entriesDir: { type: "string" },
+  disableEntryDirs: { type: "array" },
+  configDir: { type: "string" },
+  designSystem: { type: "object" }
+};
+const bff = {
+  prefix: {
+    type: "string"
+  },
+  proxy: {
+    type: "object",
+    additionalProperties: {
+      type: "string"
+    }
+  }
+};
+const output = {
+  ssg: { typeof: ["boolean", "object", "function"] },
+  disableNodePolyfill: { type: "boolean" }
+};
+const dev = {};
+const server = {
+  routes: { type: "object" },
+  publicRoutes: { type: "object" },
+  ssr: {
+    type: ["boolean", "object"]
+  },
+  ssrByEntries: { type: "object" },
+  baseUrl: {
+    anyOf: [
+      {
+        type: "string"
+      },
+      {
+        type: "array",
+        items: {
+          type: "string"
+        }
+      }
+    ]
+  },
+  port: { type: "number" },
+  logger: { type: ["boolean", "object"] },
+  metrics: { type: ["boolean", "object"] },
+  enableMicroFrontendDebug: { type: "boolean" },
+  watchOptions: { type: "object" },
+  compiler: { type: "string" },
+  enableFrameworkExt: { type: "boolean" }
+};
+const tools = {
+  tailwindcss: { type: "object" },
+  jest: { typeof: ["object", "function"] },
+  esbuild: { typeof: ["object"] }
+};
+const deploy = {
+  microFrontend: { type: ["boolean", "object"] }
+};
+const builderPlugins = { type: "array" };
+const schema = new Schema();
+schema.setSchema("bff", bff).setSchema("dev", dev).setSchema("server", server).setSchema("source", source).setSchema("output", output).setSchema("tools", tools).setSchema("deploy", deploy).set("builderPlugin", builderPlugins);
+import { default as default2 } from "./legacy";
+export {
+  default2 as legacySchema,
+  schema
+};

package/dist/esm-node/schema/legacy.js

@@ -0,0 +1,148 @@
+import { ENTRY_NAME_PATTERN } from "@modern-js/utils/constants";
+import { Schema } from "./Schema";
+const source = {
+  entries: {
+    type: "object",
+    patternProperties: {
+      [ENTRY_NAME_PATTERN]: {
+        if: { type: "object" },
+        then: {
+          required: ["entry"],
+          properties: {
+            entry: { type: ["string", "array"] },
+            disableMount: { type: "boolean" }
+          },
+          additionalProperties: false
+        },
+        else: { type: ["string", "array"] }
+      }
+    }
+  },
+  preEntry: { type: ["string", "array"] },
+  alias: { typeof: ["object", "function"] },
+  enableAsyncEntry: { type: "boolean" },
+  disableDefaultEntries: { type: "boolean" },
+  envVars: { type: "array" },
+  globalVars: { type: "object" },
+  moduleScopes: { instanceof: ["Array", "Function"] },
+  entriesDir: { type: "string" },
+  configDir: { type: "string" },
+  include: { type: ["array"] }
+};
+const output = {
+  assetPrefix: { type: "string" },
+  path: { type: "string" },
+  jsPath: { type: "string" },
+  cssPath: { type: "string" },
+  htmlPath: { type: "string" },
+  mediaPath: { type: "string" },
+  mountId: { type: "string" },
+  favicon: { type: "string" },
+  faviconByEntries: {
+    type: "object",
+    patternProperties: { [ENTRY_NAME_PATTERN]: { type: "string" } }
+  },
+  title: { type: "string" },
+  titleByEntries: {
+    type: "object",
+    patternProperties: { [ENTRY_NAME_PATTERN]: { type: "string" } }
+  },
+  meta: { type: "object" },
+  metaByEntries: {
+    type: "object",
+    patternProperties: { [ENTRY_NAME_PATTERN]: { type: "object" } }
+  },
+  inject: { enum: [true, "head", "body", false] },
+  injectByEntries: {
+    type: "object",
+    patternProperties: {
+      [ENTRY_NAME_PATTERN]: { enum: [true, "head", "body", false] }
+    }
+  },
+  copy: { type: "array" },
+  scriptExt: { type: "object" },
+  disableTsChecker: { type: "boolean" },
+  disableHtmlFolder: { type: "boolean" },
+  disableCssModuleExtension: { type: "boolean" },
+  disableCssExtract: { type: "boolean" },
+  enableCssModuleTSDeclaration: { type: "boolean" },
+  disableMinimize: { type: "boolean" },
+  enableInlineStyles: { type: "boolean" },
+  enableInlineScripts: { type: "boolean" },
+  disableSourceMap: { type: "boolean" },
+  disableInlineRuntimeChunk: { type: "boolean" },
+  disableAssetsCache: { type: "boolean" },
+  enableLatestDecorators: { type: "boolean" },
+  enableTsLoader: { type: "boolean" },
+  dataUriLimit: { type: "number" },
+  templateParameters: { type: "object" },
+  templateParametersByEntries: {
+    type: "object",
+    patternProperties: { [ENTRY_NAME_PATTERN]: { type: "object" } }
+  },
+  polyfill: {
+    type: "string",
+    enum: ["usage", "entry", "off", "ua"]
+  },
+  cssModuleLocalIdentName: { type: "string" },
+  federation: { type: "object" },
+  disableNodePolyfill: { type: "boolean" }
+};
+const server = {
+  routes: { type: "object" },
+  publicRoutes: { type: "object" },
+  ssr: {
+    type: ["boolean", "object"]
+  },
+  ssrByEntries: { type: "object" },
+  baseUrl: {
+    anyOf: [
+      {
+        type: "string"
+      },
+      {
+        type: "array",
+        items: {
+          type: "string"
+        }
+      }
+    ]
+  },
+  port: { type: "number" },
+  logger: { type: ["boolean", "object"] },
+  metrics: { type: ["boolean", "object"] },
+  enableMicroFrontendDebug: { type: "boolean" },
+  watchOptions: { type: "object" },
+  compiler: { type: "string" },
+  enableFrameworkExt: { type: "boolean" }
+};
+const dev = {
+  proxy: {
+    type: ["boolean", "object"]
+  }
+};
+const deploy = {
+  microFrontend: { type: ["boolean", "object"] }
+};
+const tools = {
+  tailwindcss: { type: "object" },
+  jest: { typeof: ["object", "function"] },
+  esbuild: { typeof: ["object"] }
+};
+const bff = {
+  prefix: {
+    type: "string"
+  },
+  proxy: {
+    type: "object",
+    additionalProperties: {
+      type: "string"
+    }
+  }
+};
+const schema = new Schema();
+schema.setSchema("bff", bff).setSchema("dev", dev).setSchema("server", server).setSchema("source", source).setSchema("output", output).setSchema("tools", tools).setSchema("deploy", deploy);
+var legacy_default = schema;
+export {
+  legacy_default as default
+};

package/dist/esm-node/types/config/index.js

@@ -0,0 +1 @@
+export * from "./output";

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

@@ -0,0 +1,3 @@
+export * from "./hooks";
+export * from "./config";
+export * from "./legacyConfig";

package/dist/esm-node/utils/config.js

@@ -0,0 +1,88 @@
+import * as path from "path";
+import { bundle } from "@modern-js/node-bundle-require";
+import {
+  CONFIG_FILE_EXTENSIONS,
+  fs,
+  getServerConfig,
+  OUTPUT_CONFIG_FILE
+} from "@modern-js/utils";
+const defineServerConfig = (config) => config;
+const buildServerConfig = async ({
+  appDirectory,
+  distDirectory,
+  configFile,
+  options
+}) => {
+  const configFilePath = await getServerConfig(appDirectory, configFile);
+  const getOutputFile = async (filepath) => path.resolve(
+    distDirectory,
+    `${filepath.replace(
+      new RegExp(CONFIG_FILE_EXTENSIONS.join("|")),
+      ""
+    )}.js`
+  );
+  if (configFilePath) {
+    const configHelperFilePath = path.normalize(
+      path.join(distDirectory, "./config-helper.js")
+    );
+    const helperCode = `
+      export const defineConfig = (config) => config;
+    `;
+    await fs.ensureDir(distDirectory);
+    await fs.writeFile(configHelperFilePath, helperCode);
+    await bundle(configFilePath, {
+      ...options,
+      getOutputFile,
+      esbuildPlugins: [
+        {
+          name: "native-build-config",
+          setup(ctx) {
+            ctx.onResolve(
+              {
+                filter: /app-tools\/server/
+              },
+              () => {
+                return {
+                  path: configHelperFilePath
+                };
+              }
+            );
+          }
+        }
+      ]
+    });
+  }
+};
+const safeReplacer = () => {
+  const cache = [];
+  const keyCache = [];
+  return function(key, value) {
+    if (typeof value === "object" && value !== null) {
+      const index = cache.indexOf(value);
+      if (index !== -1) {
+        return `[Circular ${keyCache[index]}]`;
+      }
+      cache.push(value);
+      keyCache.push(key || "root");
+    }
+    return value;
+  };
+};
+const emitResolvedConfig = async (appDirectory, resolvedConfig) => {
+  var _a;
+  const outputPath = path.join(
+    appDirectory,
+    ((_a = resolvedConfig.output.distPath) == null ? void 0 : _a.root) || "./dist",
+    OUTPUT_CONFIG_FILE
+  );
+  await fs.writeJSON(outputPath, resolvedConfig, {
+    spaces: 2,
+    replacer: safeReplacer()
+  });
+};
+export {
+  buildServerConfig,
+  defineServerConfig,
+  emitResolvedConfig,
+  safeReplacer
+};

package/dist/esm-node/utils/createServer.js

@@ -0,0 +1,37 @@
+import { Server } from "@modern-js/server";
+let server = null;
+const getServer = () => server;
+const setServer = (newServer) => {
+  server = newServer;
+};
+const closeServer = async () => {
+  if (server) {
+    await server.close();
+    server = null;
+  }
+};
+const createServer = async (options) => {
+  if (server) {
+    await server.close();
+  }
+  server = new Server(options);
+  const app = await server.init();
+  return app;
+};
+const injectDataLoaderPlugin = (internalPlugins) => {
+  const DataLoaderPlugin = require.resolve("@modern-js/plugin-data-loader/server");
+  return {
+    ...internalPlugins,
+    "@modern-js/plugin-data-loader": {
+      path: DataLoaderPlugin,
+      forced: true
+    }
+  };
+};
+export {
+  closeServer,
+  createServer,
+  getServer,
+  injectDataLoaderPlugin,
+  setServer
+};

package/dist/esm-node/utils/env.js

@@ -0,0 +1,15 @@
+function getAutoInjectEnv(appContext) {
+  const { metaName } = appContext;
+  const prefix = `${metaName.split(/[-_]/)[0]}_`.toUpperCase();
+  const envReg = new RegExp(`^${prefix}`);
+  return Object.keys(process.env).reduce((prev, key) => {
+    const value = process.env[key];
+    if (envReg.test(key) && typeof value !== "undefined") {
+      prev[`process.env.${key}`] = value;
+    }
+    return prev;
+  }, {});
+}
+export {
+  getAutoInjectEnv
+};

package/dist/esm-node/utils/generateWatchFiles.js

@@ -0,0 +1,33 @@
+import path from "path";
+import { fs, getServerConfig } from "@modern-js/utils";
+const getPackageConfig = (appDirectory, packageJsonConfig) => {
+  const PACKAGE_JSON_CONFIG_NAME = "modernConfig";
+  const json = JSON.parse(
+    fs.readFileSync(path.resolve(appDirectory, "./package.json"), "utf8")
+  );
+  return json[packageJsonConfig != null ? packageJsonConfig : PACKAGE_JSON_CONFIG_NAME];
+};
+const addServerConfigToDeps = async (dependencies, appDirectory, serverConfigFile) => {
+  const serverConfig = await getServerConfig(appDirectory, serverConfigFile);
+  if (serverConfig) {
+    dependencies.push(serverConfig);
+  }
+};
+async function generateWatchFiles(appContext, configDir) {
+  const { appDirectory, configFile } = appContext;
+  const configPath = path.join(appDirectory, configDir || "");
+  const dependencies = getPackageConfig(
+    appContext.appDirectory,
+    appContext.packageName
+  ) ? [path.resolve(appDirectory, "./package.json")] : [];
+  await addServerConfigToDeps(
+    dependencies,
+    appContext.appDirectory,
+    appContext.serverConfigFile
+  );
+  return [`${configPath}/html`, configFile || "./config", ...dependencies];
+}
+export {
+  addServerConfigToDeps,
+  generateWatchFiles
+};