Global

Methods

(async) collectLocalData(cliPackageJson) → {Promise.<DATA>}

collect local data

Parameters:
Name Type Description
cliPackageJson CLI_PACKAGE_JSON

cli package.json data
Source:
Returns:

local data

Type
Promise.<DATA>

(async) init()

init cli

Source:
Returns:

undefined

parseArgs() → {any}

parse cli args

Source:
Returns:

cli args

Type
any

Type Definitions

CLI_PACKAGE_JSON

cli package.json object

Type:
  • Object
Properties:
Name Type Description
version string

package version
engines Object

engines

Properties
Name Type Description
node string

node version
npm string

npm version
Source:

COMMIT_MESSAGE

commit message object

Type:
  • Object
Properties:
Name Type Attributes Description
commit string <optional>

commit
prefix string

commit message prefix
message string

commit message
hash string

commit message hash
name string

commit message author name
date string <optional>

commit message date
Source:

DATA

data object

Type:
  • Object
Properties:
Name Type Description
cli CLI_PACKAGE_JSON

cli info
cwd Object

current working directory

Properties
Name Type Description
path string

current working directory path
dir string

current working directory dir
base string

current working directory base
name string

current working directory name
env Object

node env

Properties
Name Type Attributes Description
GITHUB_TOKEN string <optional>

github token
system Object

system info

Properties
Name Type Description
node string

system node version
npm string

system npm version
git string

system git version
config QUICKRELEASE_CONFIG

quick-release config
git GIT_DATA

git info
answers PROMPTS_ANSWERS

prompt answers
changelog Object

changelog data

Properties
Name Type Description
generic Array.<COMMIT_MESSAGE>

changelog generic commits data
breaking Array.<COMMIT_MESSAGE>

changelog breaking commits data
draft string

changelog draft
github Object

GitHub data

Properties
Name Type Description
token boolean

GitHub token
commits Object

GitHub commits data

Properties
Name Type Description
all Array.<COMMIT_MESSAGE>

all GitHub commits
generic Array.<COMMIT_MESSAGE>

GitHub generic commits
breaking Array.<COMMIT_MESSAGE>

GitHub breaking commits
releaseNotes string

GitHub release notes
Source:

GIT_DATA

git data object

Type:
  • Object
Properties:
Name Type Description
isRepo boolean

is git repo in current directory
isRoot boolean

is git root in current directory
isCommits boolean

is git commits
isTagInCurrentCommit boolean

is git tag in current commit
isRemote boolean

is git remote
isBranchDetached boolean

is git branch detached
isBranchAhead boolean

is git branch ahead
isBranchBehind boolean

is git branch behind
hash string

git hash
branch string

git branch
lastTag string

git last tag
status string

git status
log Array.<COMMIT_MESSAGE>

git log
branchUpstream string

git branch upstream
stagedFiles Array.<string>

is git staged files
changedFiles Array.<string>

is git staged files
remote Object

git remote origin

Properties
Name Type Attributes Description
protocol string <optional>

git remote origin protocol
href string <optional>

git remote origin href
full_name string <optional>

git remote origin full_name
host string <optional>

git remote origin host
owner string <optional>

git remote origin owner
name string <optional>

git remote origin name
Source:

JSON_FORMATING_INFO

json formating info

Type:
  • Object
Properties:
Name Type Description
space string | undefined | number

json space size
newline string

json newline
Source:

JSON_WITH_FORMATING

json file data with formating info

Type:
  • Object
Properties:
Name Type Description
data any

json data
format JSON_FORMATING_INFO

json formating info
Source:

PROMPTS_ANSWERS

prompts answers object

Type:
  • Object
Properties:
Name Type Attributes Description
releaseType string <optional>

release type
releaseVersion string <optional>

release version
changelog boolean <optional>

release version
githubRelease boolean <optional>

github release
Source:

QUICKRELEASE_CONFIG

quickrelease.json config object

Type:
  • Object
Properties:
Name Type Attributes Default Description
files Array.<string> package.json,package-lock.json

additional files to parse and include into release process
changelog Object

changelog config

Properties
Name Type Attributes Default Description
file string CHANGELOG.md

changelog file name, CHANGELOG.md by default
labels Array.<string> <optional>

git commit labels to use for buildin changelog
breakingLabel string <optional>

label to indicate breaking changes in git log.
githubReleaseTitles Array.<string> <optional>

github release titles
Source:

SPLIT_LOG

object with breaking and generic commits

Type:
  • Object
Properties:
Name Type Description
breaking Array.<COMMIT_MESSAGE>

breaking changes
generic Array.<COMMIT_MESSAGE>

generic changes
Source:

Table of contents