Utils functions
- Source:
Members
(static, constant) text :TEXT
text object
Type:
- TEXT
- Source:
Methods
(static) debug(title, info)
show debug info
Parameters:
| Name | Type | Description |
|---|---|---|
title |
string | debug title |
info |
any | debug info |
- Source:
Returns:
undefined
(static) filterGenericCommits(log, labelsopt) → {Array.<COMMIT_MESSAGE>}
filter generic commits by labels
Parameters:
| Name | Type | Attributes | Description |
|---|---|---|---|
log |
Array.<COMMIT_MESSAGE> | array of commit objects |
|
labels |
Array.<string> |
<optional> |
array of commit objects |
- Source:
Returns:
- Type
- Array.<COMMIT_MESSAGE>
(async, static) installNpmDeps(data)
reinstall npm deps to update lockfile
Parameters:
| Name | Type | Description |
|---|---|---|
data |
DATA | data object |
- Source:
Returns:
undefined
(async, static) isFileDirExists(path) → {Promise.<boolean>}
check if file/dir exists
Parameters:
| Name | Type | Description |
|---|---|---|
path |
string | file/dir path |
- Source:
Returns:
- Type
- Promise.<boolean>
(async, static) parseCliPackageJson() → {Promise.<CLI_PACKAGE_JSON>}
parse CLI package.json
- Source:
Returns:
cli package.json
- Type
- Promise.<CLI_PACKAGE_JSON>
(async, static) readJsonWithFormat(filePath) → {Promise.<(JSON_WITH_FORMATING|false)>}
Read JSON file with formating info
Parameters:
| Name | Type | Description |
|---|---|---|
filePath |
string | file path |
- Source:
Returns:
quickrelease.json config
- Type
- Promise.<(JSON_WITH_FORMATING|false)>
(async, static) updateVersionInFiles(data)
write new version data to JSON files
Parameters:
| Name | Type | Description |
|---|---|---|
data |
DATA | data object |
- Source:
Returns:
undefined
Type Definitions
TEXT
text object
text object for cli output messages to keep them in one place
Type:
- Object
Properties:
| Name | Type | Description |
|---|---|---|
title |
function | title message |
releaseType |
function | release type message |
possiblereleaseTypes |
function | possible release types message |
possibleNewVersions |
function | possible new versions message |
branch |
function | branch message |
versions |
function | versions message |
currentVersion |
function | current version message |
releaseFiles |
function | release files message |
preCommitInfo |
function | pre commit info message |
branchUpstream |
function | commit info message |
branchUpstreamInfo |
function | branch upstream info message |
remoteName |
function | remote name message |
remoteUrl |
function | remote url message |
remoteProtocol |
function | remote protocol message |
changelogFile |
function | changelog file message |
githubRelease |
function | changelog file message |
- Source: