@cocreate/config
Version:
A convenient chain handler allows user to chain multiple CoCreate components together. When one action is complete next one will start. The sequence goes untill all config completed. Grounded on Vanilla javascript, easily configured using HTML5 attributes
206 lines (186 loc) • 8.05 kB
JavaScript
const readline = require('readline');
const os = require('os');
const path = require('path');
const fs = require('fs');
const util = require('node:util');
const exec = util.promisify(require('node:child_process').exec);
const { dotNotationToObject, getValueFromObject } = require('@cocreate/utils');
/**
* Asynchronously retrieves configuration values. This function allows for
* fetching values from project-specific configuration, global configuration, or
* environment variables. Project configuration takes precedence over global and
* environment settings. It also supports interactive prompts to gather critical values
* from the user if they are not already defined in the configuration.
*
* @async
* @param {Object} items - An object representing the configuration items to retrieve.
* The keys are the config paths, and the values are objects
* specifying the prompt and any variable substitutions.
* @param {boolean} [env=true] - Flag to consider environment variables during config lookup.
* @param {boolean} [global=true] - Flag to consider global configuration during config lookup.
* @param {string} [configPath='CoCreate.config.js'] - Path to the project-specific configuration file.
* @returns {Promise<Object>} A promise that resolves with the configuration object.
*
* @example
* // Usage of the Config function
* async function initConfig() {
* this.config = await Config({
* 'organization_id': { prompt: 'Enter your organization_id: ' },
* 'storage': {
* prompt: 'Enter a friendly name for the new storage: ',
* variable: 'name'
* },
* 'storage.{{name}}.provider': {
* prompt: 'Enter the storage provider, ex mongodb: '
* },
* 'storage.{{name}}.url': {
* prompt: 'Enter the storage providers url: '
* }
* });
*
* const lazyLoadConfig = await Config('lazyload', false, false);
* }
*/
module.exports = async function (items, env = true, global = true, configPath = 'CoCreate.config.js') {
async function promptForInput(question) {
const rl = readline.createInterface({
input: process.stdin,
output: process.stdout
});
return new Promise((resolve) => {
rl.question(question, (answer) => {
rl.close();
resolve(answer.trim());
});
});
}
const filterEmptyValues = (obj) => {
return Object.fromEntries(
Object.entries(obj).filter(([_, value]) => {
if (typeof value === 'object' && !Array.isArray(value)) {
return Object.keys(value).length > 0;
} else if (Array.isArray(value)) {
return value.length > 0;
} else {
return value !== '';
}
})
);
};
async function getValue(value) {
if (typeof value === 'string' || typeof value === 'number' || typeof value === 'boolean') {
return value;
} else if (value.$branch) {
try {
const { stdout } = await exec('git branch --show-current');
return value.$branch[stdout.trim()];
} catch (error) {
console.error(`exec error: ${error}`);
// Handle the error or return a default value
return null; // or a default value as per your logic
}
} else {
return value;
}
}
let config = {};
let update = false;
let variables = {};
async function getConfig(items) {
if (typeof items === 'string')
items = { [items]: '' }
for (let key of Object.keys(items)) {
let { value, prompt, choices, variable } = items[key];
const placeholders = key.match(/{{\s*([\w\W]+?)\s*}}/g);
if (placeholders && placeholders.length) {
for (let placeholder of placeholders) {
placeholder.trim()
if (variables[placeholder])
key = key.replace(placeholder, variables[placeholder])
}
}
if (choices) {
if (!prompt && prompt !== '') continue;
let isAnswered = false
for (let choice of Object.keys(choices)) {
let isAnsweredChoice = true
for (let choicekey of Object.keys(choices[choice])) {
let choiceValue = localConfig[choicekey] || globalConfig[choicekey]
if (choiceValue) {
config[choicekey] = choiceValue
} else
isAnsweredChoice = false
}
if (isAnsweredChoice)
isAnswered = true
}
if (!isAnswered) {
const answer = await promptForInput(prompt || `${key}: `);
const choice = choices[answer];
if (choice) {
await getConfig(choice);
}
}
} else if (variable) {
let variableValue = localConfig[key] || globalConfig[key]
if (!variableValue) {
variables[`{{${variable}}}`] = value || await promptForInput(prompt || `${variable}: `);
} else {
variables[`{{${variable}}}`] = Object.keys(variableValue)[0]
}
} else {
if (value || value === "") {
config[key] = value;
if (global)
update = true;
} else if (process.env[key]) {
// TODO: if JSON.String object.parse()
config[key] = process.env[key];
} else {
let localKey, globalKey
if (localKey = getValueFromObject(localConfig, key)) {
config[key] = await getValue(localKey);
} else if (globalKey = getValueFromObject(globalConfig, key)) {
config[key] = await getValue(globalKey);
} else if (prompt || prompt === '') {
config[key] = await promptForInput(prompt || `${key}: `);
if (global) update = true;
}
if (env) {
if (typeof config[key] === 'object')
process.env[key] = JSON.stringify(config[key]);
else
process.env[key] = config[key];
}
}
}
}
}
let localConfig = {};
const localConfigPath = path.resolve(process.cwd(), configPath);
if (fs.existsSync(localConfigPath)) {
localConfig = require(localConfigPath);
}
let globalConfig = {};
const globalConfigPath = path.resolve(os.homedir(), 'CoCreate.config.js');
if (fs.existsSync(globalConfigPath)) {
globalConfig = require(globalConfigPath);
}
if (items) {
await getConfig(items);
if (update) {
let updatedGlobalConfig = filterEmptyValues(
dotNotationToObject(config, globalConfig)
);
const globalConfigString = `module.exports = ${JSON.stringify(updatedGlobalConfig, null, 2)};`;
fs.writeFileSync(globalConfigPath, globalConfigString);
}
} else {
config = {
...filterEmptyValues(globalConfig),
...filterEmptyValues(localConfig)
};
}
config = dotNotationToObject(config);
return config
}