roc

<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <base data-ice="baseUrl" href="../../../"> <title data-ice="title">src/configuration/index.js | API Document</title> <link type="text/css" rel="stylesheet" href="css/style.css"> <link type="text/css" rel="stylesheet" href="css/prettify-tomorrow.css"> <script src="script/prettify/prettify.js"></script> <script src="script/manual.js"></script> </head> <body class="layout-container" data-ice="rootContainer"> <header> <a href="./">Home</a> <a href="identifiers.html">Reference</a> <a href="source.html">Source</a> <a data-ice="repoURL" href="https://github.com/vgno/roc.git" class="repo-url-github">Repository</a> <div class="search-box"> <img src="./image/search.png"> <input class="search-input"> <ul class="search-result"></ul> </div> </header> <nav class="navigation" data-ice="nav"><div> <ul> <li data-ice="doc"><div data-ice="dirPath" class="nav-dir-path">cli</div>F<a href="function/index.html#static-function-execute">execute</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-buildCompleteConfig">buildCompleteConfig</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-generateCommandDocumentation">generateCommandDocumentation</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-generateCommandsDocumentation">generateCommandsDocumentation</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-getMappings">getMappings</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-getSuggestions">getSuggestions</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-parseArguments">parseArguments</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-parseOptions">parseOptions</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-runCli">runCli</a></li> <li data-ice="doc"><div data-ice="dirPath" class="nav-dir-path">commands</div>F<a href="function/index.html#static-function-init">init</a></li> <li data-ice="doc"><div data-ice="dirPath" class="nav-dir-path">commands/helpers</div>F<a href="function/index.html#static-function-validRocProject">validRocProject</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-get">get</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-getVersions">getVersions</a></li> <li data-ice="doc">V<a href="variable/index.html#static-variable-defaultPrompt">defaultPrompt</a></li> <li data-ice="doc"><div data-ice="dirPath" class="nav-dir-path">configuration</div>F<a href="function/index.html#static-function-getApplicationConfig">getApplicationConfig</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-appendConfig">appendConfig</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-appendSettings">appendSettings</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-getConfig">getConfig</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-getSettings">getSettings</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-merge">merge</a></li> <li data-ice="doc"><div data-ice="dirPath" class="nav-dir-path">documentation</div>F<a href="function/index.html#static-function-buildDocumentationObject">buildDocumentationObject</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-generateTable">generateTable</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-addPadding">addPadding</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-getDefaultValue">getDefaultValue</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-pad">pad</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-toCliFlag">toCliFlag</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-generateMarkdownDocumentation">generateMarkdownDocumentation</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-generateTextDocumentation">generateTextDocumentation</a></li> <li data-ice="doc"><div data-ice="dirPath" class="nav-dir-path">helpers</div>F<a href="function/index.html#static-function-fileExists">fileExists</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-getAbsolutePath">getAbsolutePath</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-getPackageJson">getPackageJson</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-getRocDependencies">getRocDependencies</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-error">error</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-errorLabel">errorLabel</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-important">important</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-importantLabel">importantLabel</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-ok">ok</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-okLabel">okLabel</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-warning">warning</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-warningLabel">warningLabel</a></li> <li data-ice="doc"><div data-ice="dirPath" class="nav-dir-path">typedef</div>T<a href="typedef/index.html#static-typedef-infoObject">infoObject</a></li> <li data-ice="doc">T<a href="typedef/index.html#static-typedef-rocCommandObject">rocCommandObject</a></li> <li data-ice="doc">T<a href="typedef/index.html#static-typedef-rocConfig">rocConfig</a></li> <li data-ice="doc">T<a href="typedef/index.html#static-typedef-rocDocumentationObject">rocDocumentationObject</a></li> <li data-ice="doc">T<a href="typedef/index.html#static-typedef-rocMapObject">rocMapObject</a></li> <li data-ice="doc">T<a href="typedef/index.html#static-typedef-rocMetaConfig">rocMetaConfig</a></li> <li data-ice="doc">T<a href="typedef/index.html#static-typedef-rocMetaSettings">rocMetaSettings</a></li> <li data-ice="doc">T<a href="typedef/index.html#static-typedef-rocMetaSettings">rocMetaSettings</a></li> <li data-ice="doc">T<a href="typedef/index.html#static-typedef-rocOptions">rocOptions</a></li> <li data-ice="doc">T<a href="typedef/index.html#static-typedef-rocSettings">rocSettings</a></li> <li data-ice="doc">T<a href="typedef/index.html#static-typedef-rocTableHeader">rocTableHeader</a></li> <li data-ice="doc">T<a href="typedef/index.html#static-typedef-rocTableSettings">rocTableSettings</a></li> <li data-ice="doc"><div data-ice="dirPath" class="nav-dir-path">validation</div>F<a href="function/index.html#static-function-isValid">isValid</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-throwError">throwError</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-validate">validate</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-validateMightThrow">validateMightThrow</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-isArray">isArray</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-isArrayOrSingle">isArrayOrSingle</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-isBoolean">isBoolean</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-isInteger">isInteger</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-isObject">isObject</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-isPath">isPath</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-isString">isString</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-oneOf">oneOf</a></li> <li data-ice="doc">F<a href="function/index.html#static-function-required">required</a></li> </ul> </div> </nav> <div class="content" data-ice="content"><h1 data-ice="title">src/configuration/index.js</h1> <pre class="source-code line-number raw-source-code"><code class="prettyprint linenums" data-ice="content">import 'source-map-support/register'; import deepExtend from 'deep-extend'; import { warning } from '../helpers/style'; /* Make sure that we only print some feedback once */ let onceSettings = true; /* Using global variables here to make sure that we can access the values set from different projects. * This guarantees that the variables will live outside the require cache, something that we need for stability. */ global.rocConfig = global.rocConfig || {}; /** * Merges two configuration objects. * * @param {!Object} a - Configuration object to base the merge on. * @param {!Object} b - Configuration object that is merged into the first, overwriting the first one. * * @returns {Object} - The merged configuration object */ export function merge(a, b) { return deepExtend({}, a, b); } /** * Gets the current configuration object. * * @returns {rocConfig} - The application configuration object. */ export function getConfig() { if (onceSettings && process.env.ROC_CONFIG_SETTINGS) { onceSettings = false; if (global.rocConfig.settings && Object.keys(global.rocConfig.settings).length > 0 && process.env.ROC_CONFIG_SETTINGS ) { console.log( warning('You have settings defined on the environment variable ROC_CONFIG_SETTINGS ' + 'and they will be appended to the settings. Will append the following:\n' + JSON.stringify(process.env.ROC_CONFIG_SETTINGS, null, 2)) , '\n'); } appendSettings(JSON.parse(process.env.ROC_CONFIG_SETTINGS)); } return global.rocConfig; } /** * Gets the settings in the configuration object. * * Will by default get all settings. * * @param {string} [key] - The settings key to fetch. * * @returns {rocSettings|Object} - The application settings object. */ export function getSettings(key) { const settings = getConfig().settings; return key ? settings[key] : settings; } /** * Appends settings to the configuration object. * * Will merge with the already existing settings object meaning that this function can be called multiple times and * the settings will be a merge of all those calls. * * @param {!rocSettings} settingsObject - A settings object. * * @returns {rocSettings} - The settings object. */ export function appendSettings(settingsObject) { global.rocConfig = merge(getConfig(), { settings: settingsObject }); return getSettings(); } /** * Appends to the configuration object. * * Will merge with the already existing configuration object meaning that this function can be called multiple times and * the configuration will be a merge of all those calls. * * @param {!rocConfig} configObject - A configuration object. * * @returns {rocConfig} - The configuration object. */ export function appendConfig(configObject) { global.rocConfig = merge(getConfig(), configObject); return getConfig(); } </code></pre> </div> <footer class="footer"> Generated by <a href="https://esdoc.org">ESDoc(0.4.3)</a> </footer> <script src="script/search_index.js"></script> <script src="script/search.js"></script> <script src="script/pretty-print.js"></script> <script src="script/inherited-summary.js"></script> <script src="script/test-summary.js"></script> <script src="script/inner-link.js"></script> <script src="script/patch-for-local.js"></script> </body> </html>