Namespace: CHECK

CHECK

General checks

Source:

Methods

(async, static) checkIfBinExists(bin)

Check if shell bin exists

Parameters:
Name Type Description
bin string

bin name

Source:
Throws:

process.exit(1) if bin does not exist

Returns:

undefined

(async, static) checkIfCommitHasTag(data)

Check if current commit has a tag

Parameters:
Name Type Description
data DATA

data

Source:
Throws:

process.exit(1)

Returns:

undefined

(async, static) checkIfCommitMessageExists()

Check if commit message exists

Source:
Throws:

process.exit(1) if no commit message exists

Returns:

undefined

(async, static) checkIfGitRepoAndRoot()

Check if git repo and git root

Source:
Throws:

process.exit(1) if not git repo or not git root

Returns:

undefined

(async, static) checkIsOnline()

check is online

Source:
Throws:

process.exit(1) if not online

Returns:

undefined

(async, static) checkLocalRepo(data)

check local repo status

Parameters:
Name Type Description
data DATA

data

Source:
Throws:

process.exit(1) or warning if repo status is not ok

Returns:

undefined

(async, static) checkNode(packageJson)

Check node version

Will throw an error if node version is wrong

Parameters:
Name Type Description
packageJson CLI_PACKAGE_JSON

CLI package.json

Source:
Throws:

console.error & process.exit(1) if node version is wrong

Returns:

undefined

(async, static) checkRemoteRepo(data)

check remote repo status

Parameters:
Name Type Description
data DATA

data

Source:
Throws:

process.exit(1) or warning if remote repo status is not ok

Returns:

undefined

(async, static) checkSshConnection(serverUrl)

check ssh connection

Parameters:
Name Type Description
serverUrl string

server url

Source:
Throws:

process.exit(1) if ssh connection fails

Returns:

undefined

(async, static) checkSshPermissions()

Check ssh permissions to current repo

Source:
Throws:

process.exit(1) if ssh permissions to current repo fails

Returns:

undefined

Table of contents