packages/changelog/docs/miscellaneous/functions.html
<!doctype html>
<html class="no-js" lang="">
<head>
<meta charset="utf-8">
<meta http-equiv="x-ua-compatible" content="ie=edge">
<title>@java-patterns/changelog documentation</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="icon" type="image/x-icon" href="../images/favicon.ico">
<link rel="stylesheet" href="../styles/style.css">
<link rel="stylesheet" href="../styles/dark.css">
</head>
<body>
<div class="navbar navbar-default navbar-fixed-top visible-xs">
<a href="../" class="navbar-brand">@java-patterns/changelog documentation</a>
<button type="button" class="btn btn-default btn-menu ion-ios-menu" id="btn-menu"></button>
</div>
<div class="xs-menu menu" id="mobile-menu">
<div id="book-search-input" role="search"><input type="text" placeholder="Type to search"></div> <compodoc-menu></compodoc-menu>
</div>
<div class="container-fluid main">
<div class="row main">
<div class="hidden-xs menu">
<compodoc-menu mode="normal"></compodoc-menu>
</div>
<!-- START CONTENT -->
<div class="content miscellaneous-functions">
<div class="content-data">
<ol class="breadcrumb">
<li>Miscellaneous</li>
<li>Functions</li>
</ol>
<section>
<h3 id="index">Index</h3>
<table class="table table-sm table-bordered index-table">
<tbody>
<tr>
<td class="col-md-4">
<ul class="index-list">
<li>
<a href="#filterReverts" title="src/helpers/filter.ts" ><b>filterReverts</b> (src/.../filter.ts)</a>
</li>
<li>
<a href="#findUniqPackagesAffected" title="src/index.ts" ><b>findUniqPackagesAffected</b> (src/.../index.ts)</a>
</li>
<li>
<a href="#generateLog" title="src/index.ts" ><b>generateLog</b> (src/.../index.ts)</a>
</li>
<li>
<a href="#getCommitMessage" title="src/helpers/parser.ts" ><b>getCommitMessage</b> (src/.../parser.ts)</a>
</li>
<li>
<a href="#getLatestStableTag" title="src/index.ts" ><b>getLatestStableTag</b> (src/.../index.ts)</a>
</li>
<li>
<a href="#groupLog" title="src/helpers/group.ts" ><b>groupLog</b> (src/.../group.ts)</a>
</li>
<li>
<a href="#main" title="src/index.ts" ><b>main</b> (src/.../index.ts)</a>
</li>
<li>
<a href="#normalizeLog" title="src/helpers/filter.ts" ><b>normalizeLog</b> (src/.../filter.ts)</a>
</li>
<li>
<a href="#parseAreas" title="src/helpers/parser.ts" ><b>parseAreas</b> (src/.../parser.ts)</a>
</li>
<li>
<a href="#parseCommits" title="src/helpers/parser.ts" ><b>parseCommits</b> (src/.../parser.ts)</a>
</li>
<li>
<a href="#parseRevertCommit" title="src/helpers/parser.ts" ><b>parseRevertCommit</b> (src/.../parser.ts)</a>
</li>
<li>
<a href="#serializeLog" title="src/index.ts" ><b>serializeLog</b> (src/.../index.ts)</a>
</li>
</ul>
</td>
</tr>
</tbody>
</table>
</section>
<h3>src/helpers/filter.ts</h3>
<section>
<h3></h3> <table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="filterReverts"></a>
<span class="name">
<span ><b>filterReverts</b></span>
<a href="#filterReverts"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>filterReverts(commits)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description"><p>Filters out "Revert" commits as well as the commits they revert, if found.</p>
</div>
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>commits</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
<div>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="normalizeLog"></a>
<span class="name">
<span ><b>normalizeLog</b></span>
<a href="#normalizeLog"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>normalizeLog(commits)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>commits</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
<div>
</div>
</td>
</tr>
</tbody>
</table>
</section> <h3>src/index.ts</h3>
<section>
<h3></h3> <table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="findUniqPackagesAffected"></a>
<span class="name">
<span ><b>findUniqPackagesAffected</b></span>
<a href="#findUniqPackagesAffected"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>findUniqPackagesAffected(tagName)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>tagName</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
<div>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="generateLog"></a>
<span class="name">
<span ><b>generateLog</b></span>
<a href="#generateLog"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>generateLog(tagName)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>tagName</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
<div>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="getLatestStableTag"></a>
<span class="name">
<span ><b>getLatestStableTag</b></span>
<a href="#getLatestStableTag"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>getLatestStableTag()</code>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="main"></a>
<span class="name">
<span ><b>main</b></span>
<a href="#main"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>main()</code>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="serializeLog"></a>
<span class="name">
<span ><b>serializeLog</b></span>
<a href="#serializeLog"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>serializeLog(groupedLog)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>groupedLog</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
<div>
</div>
</td>
</tr>
</tbody>
</table>
</section> <h3>src/helpers/parser.ts</h3>
<section>
<h3></h3> <table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="getCommitMessage"></a>
<span class="name">
<span ><b>getCommitMessage</b></span>
<a href="#getCommitMessage"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>getCommitMessage(hash)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>hash</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
<div>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="parseAreas"></a>
<span class="name">
<span ><b>parseAreas</b></span>
<a href="#parseAreas"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>parseAreas(subject)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>subject</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
<div>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="parseCommits"></a>
<span class="name">
<span ><b>parseCommits</b></span>
<a href="#parseCommits"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>parseCommits(logLines)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>logLines</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
<div>
</div>
</td>
</tr>
</tbody>
</table>
<table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="parseRevertCommit"></a>
<span class="name">
<span ><b>parseRevertCommit</b></span>
<a href="#parseRevertCommit"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>parseRevertCommit(message)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>message</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
<div>
</div>
</td>
</tr>
</tbody>
</table>
</section> <h3>src/helpers/group.ts</h3>
<section>
<h3></h3> <table class="table table-sm table-bordered">
<tbody>
<tr>
<td class="col-md-4">
<a name="groupLog"></a>
<span class="name">
<span ><b>groupLog</b></span>
<a href="#groupLog"><span class="icon ion-ios-link"></span></a>
</span>
</td>
</tr>
<tr>
<td class="col-md-4">
<code>groupLog(commits)</code>
</td>
</tr>
<tr>
<td class="col-md-4">
<div class="io-description">
<b>Parameters :</b>
<table class="params">
<thead>
<tr>
<td>Name</td>
<td>Optional</td>
</tr>
</thead>
<tbody>
<tr>
<td>commits</td>
<td>
No
</td>
</tr>
</tbody>
</table>
</div>
<div>
</div>
</td>
</tr>
</tbody>
</table>
</section>
</div><div class="search-results">
<div class="has-results">
<h1 class="search-results-title"><span class='search-results-count'></span> results matching "<span class='search-query'></span>"</h1>
<ul class="search-results-list"></ul>
</div>
<div class="no-results">
<h1 class="search-results-title">No results matching "<span class='search-query'></span>"</h1>
</div>
</div>
</div>
<!-- END CONTENT -->
</div>
</div>
<label class="dark-mode-switch">
<input type="checkbox">
<span class="slider">
<svg class="slider-icon" viewBox="0 0 24 24" fill="none" height="20" stroke="#000" stroke-linecap="round" stroke-linejoin="round" stroke-width="2" width="20" xmlns="http://www.w3.org/2000/svg">
<path d="M21 12.79A9 9 0 1111.21 3 7 7 0 0021 12.79z"></path>
</svg>
</span>
</label>
<script>
var COMPODOC_CURRENT_PAGE_DEPTH = 1;
var COMPODOC_CURRENT_PAGE_CONTEXT = 'miscellaneous-functions';
var COMPODOC_CURRENT_PAGE_URL = 'functions.html';
var MAX_SEARCH_RESULTS = 15;
</script>
<script src="../js/libs/custom-elements.min.js"></script>
<script src="../js/libs/lit-html.js"></script>
<script src="../js/menu-wc.js" defer></script>
<script nomodule src="../js/menu-wc_es5.js" defer></script>
<script src="../js/libs/bootstrap-native.js"></script>
<script src="../js/libs/es6-shim.min.js"></script>
<script src="../js/libs/EventDispatcher.js"></script>
<script src="../js/libs/promise.min.js"></script>
<script src="../js/libs/zepto.min.js"></script>
<script src="../js/compodoc.js"></script>
<script src="../js/tabs.js"></script>
<script src="../js/menu.js"></script>
<script src="../js/libs/clipboard.min.js"></script>
<script src="../js/libs/prism.js"></script>
<script src="../js/sourceCode.js"></script>
<script src="../js/search/search.js"></script>
<script src="../js/search/lunr.min.js"></script>
<script src="../js/search/search-lunr.js"></script>
<script src="../js/search/search_index.js"></script>
<script src="../js/lazy-load-graphs.js"></script>
</body>
</html>