const fs = require('fs') const path = require('path') const deepmerge = require('deepmerge') module.exports = { /** 合并 envar files 和 commander parameters 中的环境变量。 * @param envarFiles: * - 字符串: 导入文件,内容应当是字符串数组,或者对象。 * - 字符串数组: 按顺序导入导入每个文件,后面文件里的变量覆盖前面的。 * - 对象: 直接添加到 global.envar 上。 */ merge_envar ({ rawEnvar = {}, envarFiles = [ './envar-base-basic.js', './envar-base-basic.gitignore.js', './envar-base-dynamic.js', './envar-base-dynamic.gitignore.js', './envar-base-secret.js', './envar-base-secret.gitignore.js', ], } = {}) { if (!global.envar) { global.envar = rawEnvar // 不知为何,必须定义成全局变量,才能保证多次require只执行一次。 console.info(`<<<<<<<< Configuring [${process.env.NODE_ENV}] Environment <<<<<<<<`) console.info('- Loading Configuration Files (读取配置文件)') if (typeof envarFiles === 'string') { // 例如当输入参数为 envarFiles = 'envar-base.js' 里面应当 module.exports 一个数组 if (fs.existsSync(path.resolve(envarFiles))) { envarFiles = require(path.resolve(envarFiles)) } else { console.warn(` - ${envarFiles} is missing.`) envarFiles = undefined } } if (Array.isArray(envarFiles)) { for (let configFile of envarFiles) { if (fs.existsSync(path.resolve(configFile))) { global.envar = deepmerge(global.envar, require(path.resolve(configFile))) console.info(` - ${configFile} is loaded.`) } else { console.warn(` - ${configFile} is missing.`) } } } else if (typeof envarFiles === 'object') { global.envar = deepmerge(global.envar, envarFiles) } else { console.warn(` - unrecognized envarFiles!`) } try { const commander = require('commander') if (Array.isArray(global.envar.commanderOptions)) { console.info('- Loading Command Line Parameters (载入命令行参数)') commander.version(global.envar.Base_Version || '0.0.1', '-v, --version') // 默认是 -V。如果要 -v,就要加 '-v --version' for (let [key, param, desc] of global.envar.commanderOptions || []) { commander.option(param, `${desc} Default = "${global.envar[key]}"`) } commander.parse(process.argv) delete global.envar.commanderOptions // console.log('- Merging Command Line Parameters into Configuration (把命令行参数值合并入配置)') for (let key in commander) { if (!/^_/.test(key) && typeof commander[key] === 'string') { // commander 自带了一批 _开头的属性,过滤掉 global.envar[key] = commander[key] } } } } catch (e) { console.error(' - commander not available!') } console.log(`>>>>>>>> Configured [${process.env.NODE_ENV}] Environment >>>>>>>>`) } return global.envar }, /* 读取动态配置文件中的环境变量。 */ get_dynamic_envar ({ dynamicEnvarFiles = ['./envar-base-dynamic.js', './envar-base-dynamic.gitignore.js'] } = {}) { // config file should be absolute or relative to the node process's dir. let dynamicEnvar = {} if (typeof dynamicEnvarFiles === 'string') { if (fs.existsSync(path.resolve(dynamicEnvarFiles))) { dynamicEnvarFiles = require(path.resolve(dynamicEnvarFiles)) } else { console.warn(` - ${dynamicEnvarFiles} is missing.`) dynamicEnvarFiles = undefined } } if (Array.isArray(dynamicEnvarFiles)) { for (let dynamicFile of dynamicEnvarFiles) { if (fs.existsSync(path.resolve(dynamicFile))) { delete require.cache[require.resolve(path.resolve(dynamicFile))] // delete require.cache[fullpath] 不起作用,必须要加 require.resolve dynamicEnvar = deepmerge(dynamicEnvar, require(path.resolve(dynamicFile))) // 在这里其实不需要 deepmerge console.info(` - ${dynamicFile} for dynamics is parsed.`) } else { console.warn(` - ${dynamicFile} for dynamics is missing.`) } } } else if (typeof dynamicEnvarFiles === 'object') { dynamicEnvar = dynamicEnvarFiles } else { console.warn(` - unrecognized dynamicEnvarFiles!`) } return dynamicEnvar }, /* 隐藏机密配置文件中的环境变量。 * 需要输出当前环境变量时,必须调用本函数,避免机密信息被输出。 */ mask_secret_envar ({ rawEnvar, secretEnvarFiles = ['./envar-base-secret.js', './envar-base-secret.gitignore.js'] } = {}) { let envar = JSON.parse(JSON.stringify(rawEnvar || global.envar)) // 复制一份,避免污染 let secretEnvar = {} if (typeof secretEnvarFiles === 'string') { if (fs.existsSync(path.resolve(secretEnvarFiles))) { secretEnvarFiles = require(path.resolve(secretEnvarFiles)) } else { console.warn(` - ${secretEnvarFiles} is missing.`) secretEnvarFiles = undefined } } console.info(` - Parsing secretEnvarFiles...`) if (Array.isArray(secretEnvarFiles)) { for (let secretFile of secretEnvarFiles) { if (fs.existsSync(path.resolve(secretFile))) { secretEnvar = deepmerge(secretEnvar, require(path.resolve(secretFile))) // 在这里其实不需要 deepmerge console.info(` - ${secretFile} for secrets is parsed.`) } else { console.warn(` - ${secretFile} for secrets is missing.`) } } } else if (typeof secretEnvarFiles === 'object') { secretEnvar = secretEnvarFiles } else { console.warn(` - unrecognized secretEnvarFiles!`) } for (let key in secretEnvar) { envar[key] = '****** confidential ******' } return envar }, }