UNPKG

tfs

Version:

NodeJS wrapper for Team Foundation Source Control CLI.

128 lines (100 loc) 5.34 kB
<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <title>JSDoc: Source: utils/format.js</title> <script src="scripts/prettify/prettify.js"> </script> <script src="scripts/prettify/lang-css.js"> </script> <!--[if lt IE 9]> <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script> <![endif]--> <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css"> <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css"> </head> <body> <div id="main"> <h1 class="page-title">Source: utils/format.js</h1> <section> <article> <pre class="prettyprint source linenums"><code>'use strict'; /** * Formatting functions * * @type {Object} */ var format = { /** * Convert a "natural" string into a camel-case one. * * @todo Missing camelization of initials * @todo Missing test * * @module Utilities Camelize * @version 1.4.1 * * @param {String} string A natural string * @return {String} A camel-case string */ camelize: function(string) { return string.replace(/(?:^\w|[A-Z]|\b\w)/g, function(letter, index) { return !index ? letter.toLowerCase() : letter.toUpperCase(); }).replace(/\s+/g, ''); }, /** * Convert Unix-style command options (-o, --option) * into Windows one (/option). Adapted for TF.exe. * * @todo Missing test * * @see https://msdn.microsoft.com/en-us/library/z51z7zy0.aspx * @module Utilities Format * @version 1.2.7 * * @param {Object} options Unix-style options: { options: true|[String] } * @return {Array} Windows-style options */ options: function(options) { let params = []; for (let option in options) { if (options[option] &amp;&amp; option !== 'verbose') { let param = '/' + option; if (typeof options[option] === 'string') { param = param + ':"' + options[option] + '"'; } if (typeof options[option] === 'number') { param = param + ':' + options[option]; } params.push(param); } } return params; }, /** * [function description] * * @todo Missing description * @todo Missing test * * @param {Srting} text [description] * @return {String} [description] */ text: function(text) { return '"' + text.replace(/"/g, '""') + '"'; }, }; module.exports = format; </code></pre> </article> </section> </div> <nav> <h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-TFS%2520Add.html">TFS Add</a></li><li><a href="module-TFS%2520Checkin.html">TFS Checkin</a></li><li><a href="module-TFS%2520Checkout.html">TFS Checkout</a></li><li><a href="module-TFS%2520Get.html">TFS Get</a></li><li><a href="module-TFS%2520History.html">TFS History</a></li><li><a href="module-TFS%2520Info.html">TFS Info</a></li><li><a href="module-TFS%2520Status.html">TFS Status</a></li><li><a href="module-TFS%2520Undo.html">TFS Undo</a></li><li><a href="module-Utilities%2520Camelize.html">Utilities Camelize</a></li><li><a href="module-Utilities%2520Format.html">Utilities Format</a></li></ul><h3>Global</h3><ul><li><a href="global.html#_delete">_delete</a></li><li><a href="global.html#branch">branch</a></li><li><a href="global.html#branches">branches</a></li><li><a href="global.html#buildSettings">buildSettings</a></li><li><a href="global.html#changeset">changeset</a></li><li><a href="global.html#configure">configure</a></li><li><a href="global.html#debug">debug</a></li><li><a href="global.html#destroy">destroy</a></li><li><a href="global.html#diff">diff</a></li><li><a href="global.html#dir">dir</a></li><li><a href="global.html#fileExists">fileExists</a></li><li><a href="global.html#folderdiff">folderdiff</a></li><li><a href="global.html#format">format</a></li><li><a href="global.html#label">label</a></li><li><a href="global.html#labels">labels</a></li><li><a href="global.html#localversions">localversions</a></li><li><a href="global.html#lock">lock</a></li><li><a href="global.html#merge">merge</a></li><li><a href="global.html#merges">merges</a></li><li><a href="global.html#output">output</a></li><li><a href="global.html#permission">permission</a></li><li><a href="global.html#rename">rename</a></li><li><a href="global.html#resolve">resolve</a></li><li><a href="global.html#rollback">rollback</a></li><li><a href="global.html#setup">setup</a></li><li><a href="global.html#shelve">shelve</a></li><li><a href="global.html#shelvesets">shelvesets</a></li><li><a href="global.html#tf">tf</a></li><li><a href="global.html#tfs">tfs</a></li><li><a href="global.html#undelete">undelete</a></li><li><a href="global.html#unlabel">unlabel</a></li><li><a href="global.html#unshelve">unshelve</a></li><li><a href="global.html#view">view</a></li><li><a href="global.html#workfold">workfold</a></li><li><a href="global.html#workspace">workspace</a></li><li><a href="global.html#workspaces">workspaces</a></li></ul> </nav> <br class="clear"> <footer> Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0</a> on Sun Mar 06 2016 00:07:41 GMT+0100 (Romance Standard Time) </footer> <script> prettyPrint(); </script> <script src="scripts/linenumber.js"> </script> </body> </html>