@modern-js/core 1.12.4 → 1.13.0

package/CHANGELOG.md

@@ -1,5 +1,25 @@
 # @modern-js/core
 
+## 1.13.0
+
+### Minor Changes
+
+- 33cebd2: chore(core): move Hooks types define to `@modern-js/core`
+
+  chore(core): 移动 Hooks 类型定义到 `@modern-js/core` 包
+
+- 33cebd2: chore(plugin-i18n): merge `@modern-js/i18n-cli-language-detector` to `@modern-js/plugin-i18n`
+
+  chore(plugin-i18n): 合并 `@modern-js/i18n-cli-language-detector` 包到 `@modern-js/plugin-i18n` 包作为子路径
+
+- 33cebd2: chore(core): merge `@modern-js/load-config` package to `@modern-js/core` utils
+
+  chore(core): 合并 `@modern-js/load-config` 包到 `@modern-js/core` 包作为 utils 函数
+
+### Patch Changes
+
+- @modern-js/utils@1.7.12
+
 ## 1.12.4
 
 ### Patch Changes

package/dist/config/index.js

@@ -18,9 +18,9 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.resolveConfig = exports.loadUserConfig = exports.assignPkgConfig = exports.defineConfig = exports.addServerConfigToDeps = exports.defaultsConfig = void 0;
-const load_config_1 = require("@modern-js/load-config");
 const utils_1 = require("@modern-js/utils");
 const lodash_1 = require("@modern-js/utils/lodash");
+const load_configs_1 = require("../load-configs");
 const ajv_1 = __importDefault(require("../../compiled/ajv"));
 const ajv_keywords_1 = __importDefault(require("../../compiled/ajv-keywords"));
 const better_ajv_errors_1 = __importDefault(require("../../compiled/better-ajv-errors"));
@@ -56,7 +56,7 @@ const assignPkgConfig = (userConfig = {}, pkgConfig = {}) => (0, lodash_1.mergeW
 });
 exports.assignPkgConfig = assignPkgConfig;
 const loadUserConfig = async (appDirectory, filePath, packageJsonConfig) => {
-    const loaded = await (0, load_config_1.loadConfig)(appDirectory, filePath, packageJsonConfig);
+    const loaded = await (0, load_configs_1.loadConfig)(appDirectory, filePath, packageJsonConfig);
     const config = !loaded
         ? {}
         : await (typeof loaded.config === 'function'

package/dist/index.d.ts

@@ -1,17 +1,15 @@
 import { INTERNAL_PLUGINS } from '@modern-js/utils';
-import type { Hooks } from '@modern-js/types';
 import type { ErrorObject } from '../compiled/ajv';
 import { TransformPlugin } from './loadPlugins';
 import { IAppContext, initAppContext } from './context';
-import type { NormalizedConfig } from './config/mergeConfig';
-export type { Hooks };
 export * from './config';
+export type { Hooks, ImportSpecifier, ImportStatement, RuntimePlugin, } from './types';
 export * from '@modern-js/plugin';
 export { manager, mountHook, usePlugins, createPlugin, registerHook, } from './manager';
 export type { CliHooks, CliPlugin, CliHookCallbacks } from './manager';
 export { AppContext, ConfigContext, ResolvedConfigContext, useAppContext, useConfigContext, useResolvedConfigContext, } from './pluginAPI';
 export type { PluginAPI } from './pluginAPI';
-export type { NormalizedConfig, IAppContext };
+export type { IAppContext };
 declare const initAppDir: (cwd?: string) => Promise<string>;
 export interface CoreOptions {
     version?: string;
@@ -52,7 +50,7 @@ export declare const cli: {
     init: (argv?: string[], options?: CoreOptions) => Promise<{
         loadedConfig: import("./config").LoadedConfig;
         appContext: IAppContext;
-        resolved: NormalizedConfig;
+        resolved: import("./config").NormalizedConfig;
     }>;
     run: (argv: string[], options?: CoreOptions) => Promise<void>;
     restart: () => Promise<void>;

package/dist/load-configs/index.d.ts

@@ -0,0 +1,34 @@
+import path from 'path';
+export declare const CONFIG_FILE_NAME = "modern.config";
+export declare const PACKAGE_JSON_CONFIG_NAME = "modernConfig";
+/**
+ * Get user config from package.json.
+ * @param appDirectory - App root directory.
+ * @returns modernConfig or undefined
+ */
+export declare const getPackageConfig: <T>(appDirectory: string, packageJsonConfig?: string) => T | undefined;
+/**
+ * Get the file dependencies by module.children, ignore file path in node_modules and this monorepo packages default.
+ * @param filePath - Absolute file path.
+ * @returns File dependencies array.
+ */
+export declare const getDependencies: (filePath: string) => string[];
+/**
+ *
+ * @param targetDir target dir
+ * @param overtime Unit of second
+ */
+export declare const clearFilesOverTime: (targetDir: string, overtime: number) => Promise<void>;
+export declare const getConfigFilePath: (appDirectory: string, filePath?: string) => string | false;
+/**
+ * Parse and load user config file, support extensions like .ts, mjs, js, ejs.
+ * @param appDirectory - App root directory, from which start search user config file.
+ * @param filePath - Specific absolute config file path.
+ * @returns Object contain config file path, user config object and dependency files used by config file.
+ */
+export declare const loadConfig: <T>(appDirectory: string, filePath?: string, packageJsonConfig?: string) => Promise<{
+    path: string | false;
+    config?: T | undefined;
+    dependencies?: string[] | undefined;
+    pkgConfig?: T | undefined;
+}>;

package/dist/load-configs/index.js

@@ -0,0 +1,124 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.loadConfig = exports.getConfigFilePath = exports.clearFilesOverTime = exports.getDependencies = exports.getPackageConfig = exports.PACKAGE_JSON_CONFIG_NAME = exports.CONFIG_FILE_NAME = void 0;
+const path_1 = __importDefault(require("path"));
+const utils_1 = require("@modern-js/utils");
+const node_bundle_require_1 = require("@modern-js/node-bundle-require");
+const debug = (0, utils_1.createDebugger)('load-config');
+exports.CONFIG_FILE_NAME = 'modern.config';
+exports.PACKAGE_JSON_CONFIG_NAME = 'modernConfig';
+/**
+ * Get user config from package.json.
+ * @param appDirectory - App root directory.
+ * @returns modernConfig or undefined
+ */
+const getPackageConfig = (appDirectory, packageJsonConfig) => {
+    const json = JSON.parse(utils_1.fs.readFileSync(path_1.default.resolve(appDirectory, './package.json'), 'utf8'));
+    return json[packageJsonConfig !== null && packageJsonConfig !== void 0 ? packageJsonConfig : exports.PACKAGE_JSON_CONFIG_NAME];
+};
+exports.getPackageConfig = getPackageConfig;
+/**
+ * Get the file dependencies by module.children, ignore file path in node_modules and this monorepo packages default.
+ * @param filePath - Absolute file path.
+ * @returns File dependencies array.
+ */
+const getDependencies = (filePath) => {
+    const mod = require.cache[filePath];
+    if (!mod) {
+        debug(`${filePath} has not been required yet`);
+        return [];
+    }
+    const deps = [];
+    if (!/\/node_modules\/|\/modern-js\/packages\//.test(mod.id)) {
+        deps.push(mod.id);
+        for (const child of mod.children) {
+            deps.push(...(0, exports.getDependencies)(child.id));
+        }
+    }
+    return deps;
+};
+exports.getDependencies = getDependencies;
+/**
+ *
+ * @param targetDir target dir
+ * @param overtime Unit of second
+ */
+const clearFilesOverTime = async (targetDir, overtime) => {
+    // when stats is true, globby return Stats[]
+    const files = (await (0, utils_1.globby)(`${targetDir}/**/*`, {
+        stats: true,
+        absolute: true,
+    }));
+    const currentTime = Date.now();
+    if (files.length > 0) {
+        for (const file of files) {
+            if (currentTime - file.stats.birthtimeMs >= overtime * 1000) {
+                utils_1.fs.unlinkSync(file.path);
+            }
+        }
+    }
+};
+exports.clearFilesOverTime = clearFilesOverTime;
+const bundleRequireWithCatch = async (configFile, { appDirectory }) => {
+    try {
+        const mod = await (0, node_bundle_require_1.bundleRequire)(configFile, {
+            autoClear: false,
+            getOutputFile: async (filePath) => {
+                const defaultOutputFileName = path_1.default.basename(await (0, node_bundle_require_1.defaultGetOutputFile)(filePath));
+                const outputPath = path_1.default.join(appDirectory, utils_1.CONFIG_CACHE_DIR);
+                // 10 min
+                const timeLimit = 10 * 60;
+                await (0, exports.clearFilesOverTime)(outputPath, timeLimit);
+                return path_1.default.join(outputPath, defaultOutputFileName);
+            },
+        });
+        return mod;
+    }
+    catch (e) {
+        if (e instanceof Error) {
+            e.message = `Get Error while loading config file: ${configFile}, please check it and retry.\n${e.message || ''}`;
+        }
+        throw e;
+    }
+};
+const getConfigFilePath = (appDirectory, filePath) => {
+    if (filePath) {
+        if (path_1.default.isAbsolute(filePath)) {
+            return filePath;
+        }
+        return path_1.default.resolve(appDirectory, filePath);
+    }
+    return (0, utils_1.findExists)(utils_1.CONFIG_FILE_EXTENSIONS.map(extension => path_1.default.resolve(appDirectory, `${exports.CONFIG_FILE_NAME}${extension}`)));
+};
+exports.getConfigFilePath = getConfigFilePath;
+/**
+ * Parse and load user config file, support extensions like .ts, mjs, js, ejs.
+ * @param appDirectory - App root directory, from which start search user config file.
+ * @param filePath - Specific absolute config file path.
+ * @returns Object contain config file path, user config object and dependency files used by config file.
+ */
+const loadConfig = async (appDirectory, filePath, packageJsonConfig) => {
+    const configFile = (0, exports.getConfigFilePath)(appDirectory, filePath);
+    const pkgConfig = (0, exports.getPackageConfig)(appDirectory, packageJsonConfig);
+    let config;
+    const dependencies = pkgConfig
+        ? [path_1.default.resolve(appDirectory, './package.json')]
+        : [];
+    if (configFile) {
+        delete require.cache[configFile];
+        const mod = await bundleRequireWithCatch(configFile, { appDirectory });
+        config = mod.default || mod;
+        // TODO: get deps.
+        // dependencies = dependencies.concat(getDependencies(configFile));
+    }
+    return {
+        path: configFile,
+        config,
+        pkgConfig,
+        dependencies,
+    };
+};
+exports.loadConfig = loadConfig;

package/dist/manager.d.ts

@@ -1,5 +1,5 @@
 import { ToThreads, ToRunners, AsyncSetup, PluginOptions, AsyncWorkflow, AsyncWaterfall, ParallelWorkflow } from '@modern-js/plugin';
-import type { Hooks } from '@modern-js/types';
+import type { Hooks } from './types';
 import type { Command } from './utils/commander';
 import type { NormalizedConfig } from './config/mergeConfig';
 import type { UserConfig } from './config';
@@ -45,26 +45,26 @@ export declare type CliHooks = typeof baseHooks & Hooks;
 /** All hook callbacks of cli plugin. */
 export declare type CliHookCallbacks = ToThreads<CliHooks>;
 export declare const manager: import("@modern-js/plugin").AsyncManager<CliHooks, {
-    setAppContext: (value: import("@modern-js/types").IAppContext) => void;
-    useAppContext: () => import("@modern-js/types").IAppContext;
+    setAppContext: (value: import("@modern-js/types/cli").IAppContext) => void;
+    useAppContext: () => import("@modern-js/types/cli").IAppContext;
     useConfigContext: () => UserConfig;
     useResolvedConfigContext: () => NormalizedConfig;
 }>;
 /** Plugin options of a cli plugin. */
 export declare type CliPlugin = PluginOptions<CliHooks, AsyncSetup<CliHooks, typeof pluginAPI>>;
 export declare const createPlugin: (setup?: AsyncSetup<CliHooks, {
-    setAppContext: (value: import("@modern-js/types").IAppContext) => void;
-    useAppContext: () => import("@modern-js/types").IAppContext;
+    setAppContext: (value: import("@modern-js/types/cli").IAppContext) => void;
+    useAppContext: () => import("@modern-js/types/cli").IAppContext;
     useConfigContext: () => UserConfig;
     useResolvedConfigContext: () => NormalizedConfig;
 }> | undefined, options?: PluginOptions<CliHooks, AsyncSetup<CliHooks, {
-    setAppContext: (value: import("@modern-js/types").IAppContext) => void;
-    useAppContext: () => import("@modern-js/types").IAppContext;
+    setAppContext: (value: import("@modern-js/types/cli").IAppContext) => void;
+    useAppContext: () => import("@modern-js/types/cli").IAppContext;
     useConfigContext: () => UserConfig;
     useResolvedConfigContext: () => NormalizedConfig;
 }>> | undefined) => import("@modern-js/plugin").AsyncPlugin<CliHooks, {
-    setAppContext: (value: import("@modern-js/types").IAppContext) => void;
-    useAppContext: () => import("@modern-js/types").IAppContext;
+    setAppContext: (value: import("@modern-js/types/cli").IAppContext) => void;
+    useAppContext: () => import("@modern-js/types/cli").IAppContext;
     useConfigContext: () => UserConfig;
     useResolvedConfigContext: () => NormalizedConfig;
 }>, registerHook: (newHooks: Partial<CliHooks>) => void, mountHook: () => ToRunners<CliHooks>;

package/dist/types/cli.d.ts

@@ -0,0 +1,73 @@
+import { AsyncWaterfall, AsyncWorkflow } from '@modern-js/plugin';
+import { Entrypoint, HtmlPartials, Route, ServerRoute } from '@modern-js/types';
+import { Compiler, Configuration, MultiCompiler } from 'webpack';
+export interface ImportSpecifier {
+    local?: string;
+    imported?: string;
+}
+export interface ImportStatement {
+    specifiers: ImportSpecifier[];
+    value: string;
+    initialize?: string;
+}
+export interface RuntimePlugin {
+    name: string;
+    options: string;
+    args?: string;
+}
+export interface Hooks {
+    beforeDev: AsyncWorkflow<void, unknown>;
+    afterDev: AsyncWorkflow<void, unknown>;
+    beforeCreateCompiler: AsyncWorkflow<{
+        webpackConfigs: Configuration[];
+    }, unknown>;
+    afterCreateCompiler: AsyncWorkflow<{
+        compiler: Compiler | MultiCompiler | undefined;
+    }, unknown>;
+    beforePrintInstructions: AsyncWaterfall<{
+        instructions: string;
+    }>;
+    beforeBuild: AsyncWorkflow<{
+        webpackConfigs: Configuration[];
+    }, unknown>;
+    afterBuild: AsyncWorkflow<void, unknown>;
+    afterMonorepoDeploy: AsyncWorkflow<{
+        operator: any;
+        deployProjectNames: string[];
+    }, void>;
+    beforeDeploy: AsyncWorkflow<Record<string, any>, unknown>;
+    afterDeploy: AsyncWorkflow<Record<string, any>, unknown>;
+    modifyEntryExport: AsyncWaterfall<{
+        entrypoint: Entrypoint;
+        exportStatement: string;
+    }>;
+    modifyEntryImports: AsyncWaterfall<{
+        imports: ImportStatement[];
+        entrypoint: Entrypoint;
+    }>;
+    modifyEntryRuntimePlugins: AsyncWaterfall<{
+        entrypoint: Entrypoint;
+        plugins: RuntimePlugin[];
+    }>;
+    modifyEntryRenderFunction: AsyncWaterfall<{
+        entrypoint: Entrypoint;
+        code: string;
+    }>;
+    modifyFileSystemRoutes: AsyncWaterfall<{
+        entrypoint: Entrypoint;
+        routes: Route[];
+    }>;
+    modifyServerRoutes: AsyncWaterfall<{
+        routes: ServerRoute[];
+    }>;
+    htmlPartials: AsyncWaterfall<{
+        entrypoint: Entrypoint;
+        partials: HtmlPartials;
+    }>;
+    addRuntimeExports: AsyncWaterfall<void>;
+    beforeGenerateRoutes: AsyncWaterfall<{
+        entrypoint: Entrypoint;
+        code: string;
+    }>;
+    addDefineTypes: AsyncWaterfall<void>;
+}

package/dist/types/cli.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/types/index.d.ts

@@ -0,0 +1 @@
+export * from './cli';

package/dist/types/index.js

@@ -0,0 +1,17 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./cli"), exports);

package/package.json

@@ -11,7 +11,7 @@
     "modern",
     "modern.js"
   ],
-  "version": "1.12.4",
+  "version": "1.13.0",
   "jsnext:source": "./src/index.ts",
   "types": "./dist/index.d.ts",
   "main": "./dist/index.js",
@@ -39,13 +39,13 @@
     }
   },
   "dependencies": {
-    "@modern-js/load-config": "^1.3.6",
-    "@modern-js/plugin": "^1.4.0",
-    "@modern-js/utils": "^1.7.11"
+    "@modern-js/plugin": "^1.4.2",
+    "@modern-js/utils": "^1.7.12",
+    "@modern-js/node-bundle-require": "^1.3.7"
   },
   "devDependencies": {
     "@jest/types": "^27.0.6",
-    "@modern-js/types": "1.5.5",
+    "@modern-js/types": "1.6.0",
     "@scripts/build": "0.0.0",
     "@scripts/jest-config": "0.0.0",
     "@types/babel__code-frame": "^7.0.3",