roc

<!DOCTYPE html> <html> <head> <meta charset="utf-8"> <base data-ice="baseUrl" href="../../../"> <title data-ice="title">src/cli/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/cli/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 minimist from 'minimist'; import { isString } from 'lodash'; import { execute } from './execute'; import { getAbsolutePath } from '../helpers'; import { validate } from '../validation'; import { merge, appendConfig } from '../configuration'; import buildDocumentationObject from '../documentation/build-documentation-object'; import { getApplicationConfig } from '../configuration/helpers'; import { buildCompleteConfig, generateCommandsDocumentation, generateCommandDocumentation, parseOptions, getMappings, parseArguments, getSuggestions } from './helpers'; import { error as styleError } from '../helpers/style'; /** * Invokes the Roc cli. * * @param {{version: string, name: string}} info - Information about the cli. * @param {rocConfig} initalConfig - The inital configuration, will be merged with the selected extensions and * application. * @param {rocMetaConfig} initalMeta - The inital meta configuration, will be merged with the selected extensions. * @param {string[]} [args=process.argv] - From where it should parse the arguments. * * @returns {undefined} */ export function runCli(info = {version: 'Unknown', name: 'Unknown'}, initalConfig, initalMeta, args = process.argv) { const {_, h, help, d, debug, v, version, c, config, D, directory, ...restArgs} = minimist(args.slice(2)); // The first should be our command if there is one const [command, ...options] = _; // If version is selected output that and stop if (version || v) { return console.log(info.version); } // Possibe to set a command in debug mode const debugEnabled = (debug || d) ? true : false; // Get the application configuration path const applicationConfigPath = config || c; // Get the directory Path const directoryPath = getAbsolutePath(directory || D); // Build the complete config object const applicationConfig = getApplicationConfig(applicationConfigPath, directoryPath, debugEnabled); let { extensionConfig, config: configObject, meta: metaObject } = buildCompleteConfig(debugEnabled, initalConfig, initalMeta, applicationConfig, undefined, directoryPath); // If we have no command we will display some help information about all possible commands if (!command) { return console.log(generateCommandsDocumentation(extensionConfig, metaObject)); } // If the command does not exist show error // Will ignore application configuration if (!extensionConfig.commands || !extensionConfig.commands[command]) { console.log(styleError('Invalid command'), '\n'); return console.log(getSuggestions([command], Object.keys(extensionConfig.commands)), '\n'); } // Show command help information if requested // Will ignore application configuration if (help || h) { return console.log(generateCommandDocumentation(extensionConfig, metaObject, command, info.name)); } const parsedOptions = parseOptions(command, metaObject.commands, options); // Only parse arguments if the command accepts it if (metaObject.commands[command] && metaObject.commands[command].settings) { // Get config from application and only parse options that this command cares about. const filter = metaObject.commands[command].settings === true ? [] : metaObject.commands[command].settings; const documentationObject = buildDocumentationObject(configObject.settings, metaObject.settings, filter); const configuration = parseArguments(restArgs, getMappings(documentationObject)); configObject = merge(configObject, { settings: configuration }); // Validate configuration validate(configObject.settings, metaObject.settings, metaObject.commands[command].settings); } // Set the configuration object appendConfig(configObject); // If string run as shell command if (isString(configObject.commands[command])) { return execute(configObject.commands[command]); } // Run the command return configObject.commands[command]({ debug: debugEnabled, configObject, metaObject, extensionConfig, parsedOptions }); } </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>