@modern-js/core 2.2.0 → 2.4.0

package/CHANGELOG.md

@@ -1,5 +1,44 @@
 # @modern-js/core
 
+## 2.4.0
+
+### Patch Changes
+
+- 8c2db5f: feat(core): improve support for exporting a function in config file
+
+  feat(core): 完善对配置文件中导出函数的支持
+
+- Updated dependencies [98a2733]
+- Updated dependencies [8c2db5f]
+  - @modern-js/node-bundle-require@2.4.0
+  - @modern-js/utils@2.4.0
+  - @modern-js/plugin@2.4.0
+
+## 2.3.0
+
+### Patch Changes
+
+- 65f1322: fix(core): merge array config correctly
+
+  fix(core): 修复合并配置中的数组时出现错误的问题
+
+- fd5a3ed: fix: failed to exit new command
+
+  fix: 修复 new 命令执行完成后未退出进程的问题
+
+- 7b2cdcb: feat(core): support read modern.config.local.ts
+
+  feat(core): 支持读取 modern.config.local.ts 文件
+
+- 7736171: fix: remove disableRunBuild
+  fix: 移除 disableRunBuild
+- Updated dependencies [fd5a3ed]
+- Updated dependencies [6ca1c0b]
+- Updated dependencies [89b6739]
+  - @modern-js/utils@2.3.0
+  - @modern-js/node-bundle-require@2.3.0
+  - @modern-js/plugin@2.3.0
+
 ## 2.2.0
 
 ### Minor Changes

package/README.md

@@ -1,30 +1,26 @@
-
 <p align="center">
   <a href="https://modernjs.dev" target="blank"><img src="https://lf3-static.bytednsdoc.com/obj/eden-cn/ylaelkeh7nuhfnuhf/modernjs-cover.png" width="300" alt="Modern.js Logo" /></a>
 </p>
+
+<h1 align="center">Modern.js</h1>
+
 <p align="center">
-现代 Web 工程体系
-  <br/>
-  <a href="https://modernjs.dev" target="blank">
-    modernjs.dev
-  </a>
-</p>
-<p align="center">
-  The meta-framework suite designed from scratch for frontend-focused modern web development
+  A Progressive React Framework for modern web development.
 </p>
 
-# Introduction
-
-> 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.
+## Getting Started
 
-- [Modern.js: Hello, World!](https://zhuanlan.zhihu.com/p/426707646)
+Please follow [Quick Start](https://modernjs.dev/en/guides/get-started/quick-start) to get started with Modern.js.
 
-## Getting Started
+## Documentation
 
-- [Quick Start](https://modernjs.dev/docs/start)
-- [Guides](https://modernjs.dev/docs/guides)
-- [API References](https://modernjs.dev/docs/apis)
+- [English Documentation](https://modernjs.dev/en/)
+- [中文文档](https://modernjs.dev)
 
 ## Contributing
 
-- [Contributing Guide](https://github.com/modern-js-dev/modern.js/blob/main/CONTRIBUTING.md)
+Please read the [Contributing Guide](https://github.com/modern-js-dev/modern.js/blob/main/CONTRIBUTING.md).
+
+## License
+
+Modern.js is [MIT licensed](https://github.com/modern-js-dev/modern.js/blob/main/LICENSE).

package/dist/config/createLoadedConfig.d.ts

@@ -1,6 +1,6 @@
-import { LoadedConfig, UserConfig, ConfigParams } from '../types';
+import { LoadedConfig, UserConfig } from '../types';
 /**
  * Assign the pkg config into the user config.
  */
-export declare const assignPkgConfig: (userConfig?: UserConfig, pkgConfig?: ConfigParams) => UserConfig;
+export declare const assignPkgConfig: (userConfig?: UserConfig, pkgConfig?: UserConfig) => UserConfig;
 export declare function createLoadedConfig(appDirectory: string, filePath?: string, packageJsonConfig?: string): Promise<LoadedConfig<{}>>;

package/dist/config/createLoadedConfig.js

@@ -1,9 +1,14 @@
 "use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.createLoadedConfig = exports.assignPkgConfig = void 0;
+const path_1 = __importDefault(require("path"));
 const lodash_1 = require("@modern-js/utils/lodash");
 const utils_1 = require("@modern-js/utils");
-const load_configs_1 = require("../load-configs");
+const utils_2 = require("../utils");
+const loadConfig_1 = require("./loadConfig");
 /**
  * Assign the pkg config into the user config.
  */
@@ -17,15 +22,55 @@ const assignPkgConfig = (userConfig = {}, pkgConfig = {}) => (0, lodash_1.mergeW
     return undefined;
 });
 exports.assignPkgConfig = assignPkgConfig;
+/**
+ * A modern config can export a function or an object
+ * If it's a function, it will be called and return a config object
+ */
+async function getConfigObject(config) {
+    if (typeof config === 'function') {
+        return (await config({ env: (0, utils_1.getNodeEnv)(), command: (0, utils_1.getCommand)() })) || {};
+    }
+    return config || {};
+}
+async function loadLocalConfig(appDirectory, configFile) {
+    let localConfigFile = false;
+    if (typeof configFile === 'string') {
+        for (const ext of utils_1.CONFIG_FILE_EXTENSIONS) {
+            if (configFile.endsWith(ext)) {
+                const replacedPath = configFile.replace(ext, `.local${ext}`);
+                if (utils_1.fs.existsSync(replacedPath)) {
+                    localConfigFile = replacedPath;
+                }
+            }
+        }
+    }
+    else {
+        localConfigFile = (0, utils_1.findExists)(utils_1.CONFIG_FILE_EXTENSIONS.map(extension => path_1.default.resolve(appDirectory, `${loadConfig_1.LOCAL_CONFIG_FILE_NAME}${extension}`)));
+    }
+    if (localConfigFile) {
+        const loaded = await (0, loadConfig_1.loadConfig)(appDirectory, localConfigFile);
+        return getConfigObject(loaded.config);
+    }
+    return null;
+}
 async function createLoadedConfig(appDirectory, filePath, packageJsonConfig) {
-    const loaded = await (0, load_configs_1.loadConfig)(appDirectory, filePath, packageJsonConfig);
-    const config = !loaded
-        ? {}
-        : await (typeof loaded.config === 'function'
-            ? loaded.config(0)
-            : loaded.config);
+    const configFile = (0, loadConfig_1.getConfigFilePath)(appDirectory, filePath);
+    const loaded = await (0, loadConfig_1.loadConfig)(appDirectory, configFile, packageJsonConfig);
+    const config = await getConfigObject(loaded.config);
+    let mergedConfig = config;
+    if (loaded.pkgConfig) {
+        mergedConfig = (0, exports.assignPkgConfig)(config, loaded === null || loaded === void 0 ? void 0 : loaded.pkgConfig);
+    }
+    // Only load local config when running dev command
+    if ((0, utils_1.isDevCommand)()) {
+        const localConfig = await loadLocalConfig(appDirectory, configFile);
+        // The priority of local config is higher than the user config and pkg config
+        if (localConfig) {
+            mergedConfig = (0, utils_2.mergeConfig)([mergedConfig, localConfig]);
+        }
+    }
     return {
-        config: (0, exports.assignPkgConfig)(config, loaded === null || loaded === void 0 ? void 0 : loaded.pkgConfig),
+        config: mergedConfig,
         filePath: loaded.path,
         dependencies: loaded.dependencies || [],
         pkgConfig: loaded.pkgConfig || {},

package/dist/{load-configs/index.d.ts → config/loadConfig.d.ts}

@@ -1,5 +1,6 @@
 import path from 'path';
 export declare const CONFIG_FILE_NAME = "modern.config";
+export declare const LOCAL_CONFIG_FILE_NAME = "modern.config.local";
 export declare const PACKAGE_JSON_CONFIG_NAME = "modernConfig";
 /**
  * Get user config from package.json.
@@ -23,10 +24,10 @@ export declare const getConfigFilePath: (appDirectory: string, filePath?: string
 /**
  * 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.
+ * @param configFile - 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<{
+export declare const loadConfig: <T>(appDirectory: string, configFile: string | false, packageJsonConfig?: string) => Promise<{
     path: string | false;
     config?: T | undefined;
     dependencies?: string[] | undefined;

package/dist/{load-configs/index.js → config/loadConfig.js}

@@ -3,12 +3,13 @@ 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;
+exports.loadConfig = exports.getConfigFilePath = exports.clearFilesOverTime = exports.getDependencies = exports.getPackageConfig = exports.PACKAGE_JSON_CONFIG_NAME = exports.LOCAL_CONFIG_FILE_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.LOCAL_CONFIG_FILE_NAME = 'modern.config.local';
 exports.PACKAGE_JSON_CONFIG_NAME = 'modernConfig';
 /**
  * Get user config from package.json.
@@ -97,11 +98,10 @@ 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.
+ * @param configFile - 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 loadConfig = async (appDirectory, configFile, packageJsonConfig) => {
     const pkgConfig = (0, exports.getPackageConfig)(appDirectory, packageJsonConfig);
     let config;
     const dependencies = pkgConfig
@@ -111,8 +111,6 @@ const loadConfig = async (appDirectory, filePath, packageJsonConfig) => {
         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,

package/dist/types/config/index.d.ts

@@ -46,4 +46,8 @@ export type LoadedConfig<Extends extends {
     pkgConfig: UserConfig<Extends>;
     jsConfig: UserConfig<Extends>;
 };
-export type ConfigParams = UserConfig | Promise<UserConfig> | ((env: any) => UserConfig | Promise<UserConfig>);
+export type ConfigParams = {
+    env: string;
+    command: string;
+};
+export type UserConfigExport<Config = UserConfig> = Config | ((env: ConfigParams) => Config | Promise<Config>);

package/dist/types/hooks.d.ts

@@ -37,7 +37,6 @@ export interface DevToolData<DevOptions = any> {
         name: string;
         value: string;
     };
-    disableRunBuild?: boolean;
     action: (options: DevOptions, context: {
         isTsProject?: boolean;
     }) => void | Promise<void>;

package/dist/utils/createFileWatcher.js

@@ -36,7 +36,7 @@ const hashMap = new Map();
 const md5 = (data) => crypto_1.default.createHash('md5').update(data).digest('hex');
 const createFileWatcher = async (appContext, hooksRunner) => {
     // only add fs watcher on dev mode.
-    if ((0, utils_1.isDev)() || (0, utils_1.isTest)()) {
+    if ((0, utils_1.isDevCommand)()) {
         const { appDirectory } = appContext;
         const extraFiles = await hooksRunner.watchFiles();
         const watched = extraFiles.filter(Boolean);

package/dist/utils/mergeConfig.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.mergeConfig = void 0;
+const utils_1 = require("@modern-js/utils");
 const lodash_1 = require("@modern-js/utils/lodash");
 const mergeConfig = (configs) => (0, lodash_1.mergeWith)({}, ...configs, (target, source, key) => {
     // Do not use the following merge logic for source.designSystem and tools.tailwind(css)
@@ -10,15 +11,16 @@ const mergeConfig = (configs) => (0, lodash_1.mergeWith)({}, ...configs, (target
         key === 'devServer') {
         return (0, lodash_1.mergeWith)({}, target !== null && target !== void 0 ? target : {}, source !== null && source !== void 0 ? source : {});
     }
-    if (Array.isArray(target)) {
-        if (Array.isArray(source)) {
-            return [...target, ...source];
+    if (Array.isArray(target) || Array.isArray(source)) {
+        if (target === undefined) {
+            return source;
         }
-        else {
-            return source !== undefined ? [...target, source] : target;
+        if (source === undefined) {
+            return target;
         }
+        return [...(0, utils_1.ensureArray)(target), ...(0, utils_1.ensureArray)(source)];
     }
-    else if ((0, lodash_1.isFunction)(target) || (0, lodash_1.isFunction)(source)) {
+    if ((0, lodash_1.isFunction)(target) || (0, lodash_1.isFunction)(source)) {
         if (source === undefined) {
             return target;
         }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@modern-js/core",
-  "description": "The meta-framework suite designed from scratch for frontend-focused modern web development.",
+  "description": "A Progressive React Framework for modern web development.",
   "homepage": "https://modernjs.dev",
   "bugs": "https://github.com/modern-js-dev/modern.js/issues",
   "repository": "modern-js-dev/modern.js",
@@ -10,7 +10,7 @@
     "modern",
     "modern.js"
   ],
-  "version": "2.2.0",
+  "version": "2.4.0",
   "jsnext:source": "./src/index.ts",
   "types": "./dist/index.d.ts",
   "main": "./dist/index.js",
@@ -51,9 +51,9 @@
     }
   },
   "dependencies": {
-    "@modern-js/node-bundle-require": "2.2.0",
-    "@modern-js/plugin": "2.2.0",
-    "@modern-js/utils": "2.2.0"
+    "@modern-js/node-bundle-require": "2.4.0",
+    "@modern-js/plugin": "2.4.0",
+    "@modern-js/utils": "2.4.0"
   },
   "devDependencies": {
     "@jest/types": "^27.0.6",
@@ -71,11 +71,11 @@
     "terser-webpack-plugin": "^5.1.4",
     "typescript": "^4",
     "webpack": "^5.75.0",
-    "@modern-js/builder-shared": "2.2.0",
-    "@modern-js/babel-preset-app": "2.2.0",
-    "@modern-js/types": "2.2.0",
-    "@scripts/jest-config": "2.2.0",
-    "@scripts/build": "2.2.0"
+    "@modern-js/builder-shared": "2.4.0",
+    "@modern-js/babel-preset-app": "2.4.0",
+    "@modern-js/types": "2.4.0",
+    "@scripts/jest-config": "2.4.0",
+    "@scripts/build": "2.4.0"
   },
   "sideEffects": false,
   "publishConfig": {