ea3d738823
**What** - add error handling when loading project config **How** - Add error parameter to get-medusa-config result if an error was thrown (previously we returned an empty config) - Discussion: A different, but equally valid approach could be just throwing the error rather than creating an error parameter. This causes a more ugly output without warnings and changes the api a bit but it would force error handling. wdyt? **Why** - cli would fail with database error `databaseMissingDriverError` if config was invalid, ex. missing a comma ### example (missing `,` in config) **old output** ``` Successfully compiled 2 files with Babel (143ms). [medusa-config] ⚠️ redis_url not found. A fake redis instance will be used. [medusa-config] ⚠️ database_type not found. fallback to default sqlite. info: Using flag MEDUSA_FF_ORDER_EDITING from environment with value true info: Using flag MEDUSA_FF_SALES_CHANNELS from environment with value true info: Using flag MEDUSA_FF_TAX_INCLUSIVE_PRICING from environment with value true info: Using fake Redis ✔ Models initialized – 13ms ✔ Plugin models initialized – 0ms ✔ Repositories initialized – 17ms ⠋ Initializing databaseMissingDriverError: Wrong driver: "undefined" given. Supported drivers are: "aurora-data-api", "aurora-data-api-pg", "better-sqlite3", "capacitor", "cockroachdb", "cordova", "expo", "mariadb", "mongodb", "mssql", "mysql", "nativescript", "oracle", "postgres", "react-native", "sap", "sqlite", "sqljs". ``` **new output** ``` Successfully compiled 2 files with Babel (185ms). error: Error in loading config: Unexpected identifier error: /Users/phko/projects/community/my-medusa-store/medusa-config.js:129 plugins, ^^^^^^^ SyntaxError: Unexpected identifier at compileFunction (<anonymous>) at Object.compileFunction (node:vm:352:18) at wrapSafe (node:internal/modules/cjs/loader:1033:15) at Module._compile (node:internal/modules/cjs/loader:1069:27) at Object.Module._extensions..js (node:internal/modules/cjs/loader:1159:10) at Module.load (node:internal/modules/cjs/loader:981:32) at Function.Module._load (node:internal/modules/cjs/loader:822:12) at Module.require (node:internal/modules/cjs/loader:1005:19) at require (node:internal/modules/cjs/helpers:102:18) at getConfigFile (/Users/phko/projects/community/my-medusa-store/node_modules/medusa-core-utils/dist/get-config-file.js:26:20) ```
27 lines
744 B
JavaScript
27 lines
744 B
JavaScript
import path from "path"
|
|
|
|
/**
|
|
* Attempts to resolve the config file in a given root directory.
|
|
* @param {string} rootDir - the directory to find the config file in.
|
|
* @param {string} configName - the name of the config file.
|
|
* @return {object} an object containing the config module and its path as well as an error property if the config couldn't be loaded.
|
|
*/
|
|
function getConfigFile(rootDir, configName) {
|
|
const configPath = path.join(rootDir, configName)
|
|
let configFilePath = ``
|
|
let configModule
|
|
|
|
try {
|
|
configFilePath = require.resolve(configPath)
|
|
configModule = require(configFilePath)
|
|
} catch (err) {
|
|
return {
|
|
error: err,
|
|
}
|
|
}
|
|
|
|
return { configModule, configFilePath }
|
|
}
|
|
|
|
export default getConfigFile
|