-

short:'-D'

name:data-source

valueType:'<issues|commits|milestones|prs>'

valueType:'<issues|commits|milestones|prs|prs-with-issues>'

description:'The informations you want to use to build release notes. [issues]'

defaultValue:issues

-

<htmllang="en">

<metacharset="utf-8">

<metaname="viewport"content="width=device-width,initial-scale=1">

<title>_template.js - Documentation</title>

<scriptsrc="scripts/prettify/prettify.js"></script>

<scriptsrc="scripts/prettify/lang-css.js"></script>

<linktype="text/css"rel="stylesheet"href="https://code.ionicframework.com/ionicons/2.0.1/css/ionicons.min.css">

<linktype="text/css"rel="stylesheet"href="styles/prettify-tomorrow.css">

<linktype="text/css"rel="stylesheet"href="styles/jsdoc-default.css">

<inputtype="checkbox"id="nav-trigger"class="nav-trigger"/>

<labelfor="nav-trigger"class="navicon-button x">

<divclass="navicon"></div>

<labelfor="nav-trigger"class="overlay"></label>

<liclass="nav-link nav-home-link"><ahref="index.html">Home</a></li><liclass="nav-heading">Classes</li><liclass="nav-heading"><spanclass="nav-item-type type-class">C</span><spanclass="nav-item-name"><ahref="GitHubInfo.html">GitHubInfo</a></span></li><liclass="nav-item"><spanclass="nav-item-type type-function">F</span><spanclass="nav-item-name"><ahref="GitHubInfo.html#_executeCommand">_executeCommand</a></span></li><liclass="nav-item"><spanclass="nav-item-type type-function">F</span><spanclass="nav-item-name"><ahref="GitHubInfo.html#_repo">_repo</a></span></li><liclass="nav-item"><spanclass="nav-item-type type-function">F</span><spanclass="nav-item-name"><ahref="GitHubInfo.html#_token">_token</a></span></li><liclass="nav-heading"><spanclass="nav-item-type type-class">C</span><spanclass="nav-item-name"><ahref="Gren.html">Gren</a></span></li><liclass="nav-item"><spanclass="nav-item-type type-function">F</span><spanclass="nav-item-name"><ahref="Gren.html#_checkChangelogFile">_checkChangelogFile</a></span></li><liclass="nav-item"><spanclass="nav-item-type type-function">F</span><spanclass="nav-item-name"><ahref="Gren.html#_createChangelog">_createChangelog</a></span></li><liclass="nav-item"><spanclass="nav-item-type type-function">F</span><spanclass="nav-item-name"><ahref="Gren.html#_createRelease">_createRelease</a></span></li><liclass="nav-item"><spanclass="nav-item-type type-function">F</span><spanclass="nav-item-name"><ahref="Gren.html#_createReleaseRanges">_createReleaseRanges</a></span></li><liclass="nav-item"><spanclass="nav-item-type type-function">F</span><spanclass="nav-item-name"><ahref="Gren.html#_editRelease">_editRelease</a></span></li><liclass="nav-item"><spanclass="nav-item-type type-function">F</span><spanclass="nav-item-name"><ahref="Gren.html#_filterBlockIssue">_filterBlockIssue</a></span></li><liclass="nav-item"><spanclass="nav-item-type type-function">F</span><spanclass="nav-item-name"><ahref="Gren.html#_filterBlockPullRequest">_filterBlockPullRequest</a></span></li><liclass="nav-item"><spanclass="nav-item-type type-function">F</span><spanclass="nav-item-name"><ahref="Gren.html#_filterCommit">_filterCommit</a></span></li><liclass="nav-item"><spanclass="nav-item-type type-function">F</span><spanclass="nav-item-name"><ahref="Gren.html#_filterIssue">_filterIssue</a></span></li><liclass="nav-item"><spanclass="nav-item-type type-function">F</span><spanclass="nav-item-name"><ahref="Gren.html#_filterPullRequest">_filterPullRequest</a></span></li><liclass="nav-item"><spanclass="nav-item-type type-function">F</span><spanclass="nav-item-name"><ahref="Gren.html#_generateCommitsBody">_generateCommitsBody</a></span></li><liclass="nav-item"><spanclass="nav-item-type type-function">F</span><spanclass="nav-item-name"><ahref="Gren.html#_getAllTags">_getAllTags</a></span></li><liclass="nav-item"><spanclass="nav-item-type type-function">F</span><spanclass="nav-item-name"><ahref="Gren.html#_getClosedIssues">_getClosedIssues</a></span></li><liclass="nav-item"><spanclass="nav-item-type type-function">F</span><spanclass="nav-item-name"><ahref="Gren.html#_getCommitBlocks">_getCommitBlocks</a></span></li><liclass="nav-item"><spanclass="nav-item-type type-function">F</span><spanclass="nav-item-name"><ahref="Gren.html#_getCommitsBetweenTwo">_getCommitsBetweenTwo</a></span></li><liclass="nav-item"><spanclass="nav-item-type type-function">F</span><spanclass="nav-item-name"><ahref="Gren.html#_getIssueBlocks">_getIssueBlocks</a></span></li><liclass="nav-item"><spanclass="nav-item-type type-function">F</span><spanclass="nav-item-name"><ahref="Gren.html#_getLastPage">_getLastPage</a></span></li><liclass="nav-item"><spanclass="nav-item-type type-function">F</span><spanclass="nav-item-name"><ahref="Gren.html#_getLastTags">_getLastTags</a></span></li><liclass="nav-item"><spanclass="nav-item-type type-function">F</span><spanclass="nav-item-name"><ahref="Gren.html#_getListReleases">_getListReleases</a></span></li><liclass="nav-item"><spanclass="nav-item-type type-function">F</span><spanclass="nav-item-name"><ahref="Gren.html#_getMergedPullRequests">_getMergedPullRequests</a></span></li><liclass="nav-item"><spanclass="nav-item-type type-function">F</span><spanclass="nav-item-name"><ahref="Gren.html#_getPullRequestsBlocks">_getPullRequestsBlocks</a></span></li><liclass="nav-item"><spanclass="nav-item-type type-function">F</span><spanclass="nav-item-name"><ahref="Gren.html#_getReleaseBlocks">_getReleaseBlocks</a></span></li><liclass="nav-item"><spanclass="nav-item-type type-function">F</span><spanclass="nav-item-name"><ahref="Gren.html#_getSelectedTags">_getSelectedTags</a></span></li><liclass="nav-item"><spanclass="nav-item-type type-function">F</span><spanclass="nav-item-name"><ahref="Gren.html#_getTagDates">_getTagDates</a></span></li><liclass="nav-item"><spanclass="nav-item-type type-function">F</span><spanclass="nav-item-name"><ahref="Gren.html#_groupBy">_groupBy</a></span></li><liclass="nav-item"><spanclass="nav-item-type type-function">F</span><spanclass="nav-item-name"><ahref="Gren.html#_groupByLabel">_groupByLabel</a></span></li><liclass="nav-item"><spanclass="nav-item-type type-function">F</span><spanclass="nav-item-name"><ahref="Gren.html#_hasNetwork">_hasNetwork</a></span></li><liclass="nav-item"><spanclass="nav-item-type type-function">F</span><spanclass="nav-item-name"><ahref="Gren.html#_lablesAreIgnored">_lablesAreIgnored</a></span></li><liclass="nav-item"><spanclass="nav-item-type type-function">F</span><spanclass="nav-item-name"><ahref="Gren.html#_listReleases">_listReleases</a></span></li><liclass="nav-item"><spanclass="nav-item-type type-function">F</span><spanclass="nav-item-name"><ahref="Gren.html#_listTags">_listTags</a></span></li><liclass="nav-item"><spanclass="nav-item-type type-function">F</span><spanclass="nav-item-name"><ahref="Gren.html#_outputOptions">_outputOptions</a></span></li><liclass="nav-item"><spanclass="nav-item-type type-function">F</span><spanclass="nav-item-name"><ahref="Gren.html#_prepareRelease">_prepareRelease</a></span></li><liclass="nav-item"><spanclass="nav-item-type type-function">F</span><spanclass="nav-item-name"><ahref="Gren.html#_sortReleasesByDate">_sortReleasesByDate</a></span></li><liclass="nav-item"><spanclass="nav-item-type type-function">F</span><spanclass="nav-item-name"><ahref="Gren.html#_templateBody">_templateBody</a></span></li><liclass="nav-item"><spanclass="nav-item-type type-function">F</span><spanclass="nav-item-name"><ahref="Gren.html#_templateCommits">_templateCommits</a></span></li><liclass="nav-item"><spanclass="nav-item-type type-function">F</span><spanclass="nav-item-name"><ahref="Gren.html#_templateGroups">_templateGroups</a></span></li><liclass="nav-item"><spanclass="nav-item-type type-function">F</span><spanclass="nav-item-name"><ahref="Gren.html#_templateIssue">_templateIssue</a></span></li><liclass="nav-item"><spanclass="nav-item-type type-function">F</span><spanclass="nav-item-name"><ahref="Gren.html#_templateLabels">_templateLabels</a></span></li><liclass="nav-item"><spanclass="nav-item-type type-function">F</span><spanclass="nav-item-name"><ahref="Gren.html#_validateRequiredTagsExists">_validateRequiredTagsExists</a></span></li><liclass="nav-item"><spanclass="nav-item-type type-function">F</span><spanclass="nav-item-name"><ahref="Gren.html#changelog">changelog</a></span></li><liclass="nav-item"><spanclass="nav-item-type type-function">F</span><spanclass="nav-item-name"><ahref="Gren.html#release">release</a></span></li><liclass="nav-heading"><spanclass="nav-item-type type-class">C</span><spanclass="nav-item-name"><ahref="Program.html">Program</a></span></li><liclass="nav-item"><spanclass="nav-item-type type-function">F</span><spanclass="nav-item-name"><ahref="Program.html#_camelCaseObjectKeys">_camelCaseObjectKeys</a></span></li><liclass="nav-item"><spanclass="nav-item-type type-function">F</span><spanclass="nav-item-name"><ahref="Program.html#_consumeOptions">_consumeOptions</a></span></li><liclass="nav-item"><spanclass="nav-item-type type-function">F</span><spanclass="nav-item-name"><ahref="Program.html#_dashToCamelCase">_dashToCamelCase</a></span></li><liclass="nav-item"><spanclass="nav-item-type type-function">F</span><spanclass="nav-item-name"><ahref="Program.html#_filterObject">_filterObject</a></span></li><liclass="nav-item"><spanclass="nav-item-type type-function">F</span><spanclass="nav-item-name"><ahref="Program.html#_getEnvOptions">_getEnvOptions</a></span></li><liclass="nav-item"><spanclass="nav-item-type type-function">F</span><spanclass="nav-item-name"><ahref="Program.html#_getOptionsFromObject">_getOptionsFromObject</a></span></li><liclass="nav-item"><spanclass="nav-item-type type-function">F</span><spanclass="nav-item-name"><ahref="Program.html#_programWithEvents">_programWithEvents</a></span></li><liclass="nav-item"><spanclass="nav-item-type type-function">F</span><spanclass="nav-item-name"><ahref="Program.html#_programWithOptions">_programWithOptions</a></span></li><liclass="nav-item"><spanclass="nav-item-type type-function">F</span><spanclass="nav-item-name"><ahref="Program.html#init">init</a></span></li><liclass="nav-heading"><ahref="global.html">Globals</a></li><liclass="nav-item"><spanclass="nav-item-type type-function">F</span><spanclass="nav-item-name"><ahref="global.html#cleanConfig">cleanConfig</a></span></li><liclass="nav-item"><spanclass="nav-item-type type-function">F</span><spanclass="nav-item-name"><ahref="global.html#clearTasks">clearTasks</a></span></li><liclass="nav-item"><spanclass="nav-item-type type-function">F</span><spanclass="nav-item-name"><ahref="global.html#convertStringToArray">convertStringToArray</a></span></li><liclass="nav-item"><spanclass="nav-item-type type-function">F</span><spanclass="nav-item-name"><ahref="global.html#dashToCamelCase">dashToCamelCase</a></span></li><liclass="nav-item"><spanclass="nav-item-type type-function">F</span><spanclass="nav-item-name"><ahref="global.html#formatDate">formatDate</a></span></li><liclass="nav-item"><spanclass="nav-item-type type-function">F</span><spanclass="nav-item-name"><ahref="global.html#generate">generate</a></span></li><liclass="nav-item"><spanclass="nav-item-type type-function">F</span><spanclass="nav-item-name"><ahref="global.html#getConfigFromFile">getConfigFromFile</a></span></li><liclass="nav-item"><spanclass="nav-item-type type-function">F</span><spanclass="nav-item-name"><ahref="global.html#getConfigFromRemote">getConfigFromRemote</a></span></li><liclass="nav-item"><spanclass="nav-item-type type-function">F</span><spanclass="nav-item-name"><ahref="global.html#getFileExtension">getFileExtension</a></span></li><liclass="nav-item"><spanclass="nav-item-type type-function">F</span><spanclass="nav-item-name"><ahref="global.html#getFileNameFromPath">getFileNameFromPath</a></span></li><liclass="nav-item"><spanclass="nav-item-type type-function">F</span><spanclass="nav-item-name"><ahref="global.html#getFileTypes">getFileTypes</a></span></li><liclass="nav-item"><spanclass="nav-item-type type-function">F</span><spanclass="nav-item-name"><ahref="global.html#getGrenConfig">getGrenConfig</a></span></li><liclass="nav-item"><spanclass="nav-item-type type-function">F</span><spanclass="nav-item-name"><ahref="global.html#getRemoteUrl">getRemoteUrl</a></span></li><liclass="nav-item"><spanclass="nav-item-type type-function">F</span><spanclass="nav-item-name"><ahref="global.html#isInRange">isInRange</a></span></li><liclass="nav-item"><spanclass="nav-item-type type-function">F</span><spanclass="nav-item-name"><ahref="global.html#noop">noop</a></span></li><liclass="nav-item"><spanclass="nav-item-type type-function">F</span><spanclass="nav-item-name"><ahref="global.html#printTask">printTask</a></span></li><liclass="nav-item"><spanclass="nav-item-type type-function">F</span><spanclass="nav-item-name"><ahref="global.html#requireConfig">requireConfig</a></span></li><liclass="nav-item"><spanclass="nav-item-type type-function">F</span><spanclass="nav-item-name"><ahref="global.html#sortObject">sortObject</a></span></li><liclass="nav-item"><spanclass="nav-item-type type-function">F</span><spanclass="nav-item-name"><ahref="global.html#task">task</a></span></li><liclass="nav-item"><spanclass="nav-item-type type-function">F</span><spanclass="nav-item-name"><ahref="global.html#writeConfigToFile">writeConfigToFile</a></span></li>

<divid="main">

<h1class="page-title">_template.js</h1>

<preclass="prettyprint source linenums"><code>/**

* Generate the templated string based on

* a placeholders Object

*

* @since 0.6.0

* @private

*

* @param {Object} placeholders All the keys/values to update

* @param {string|Function} string The string or the function that needs to be replaced

*

* @return {string}

*/

function generate(placeholders, string) {

if (typeof string === 'function') {

return string(placeholders);

}

return Object.entries(placeholders)

.reduce((carry, [key, placeholder]) => {

const placeholderRegExp = new RegExp(`{{${key}}}`, 'g');

return carry.replace(placeholderRegExp, placeholder);

}, string);

}

export {

generate

};

<brclass="clear">

Generated by<ahref="https://github.com/jsdoc3/jsdoc">JSDoc 3.6.3</a> on Thu Dec 12 2019 15:54:57 GMT+0100 (Central European Standard Time) using the Minami theme.

<scriptsrc="scripts/linenumber.js"></script>