Skip to content

relizy / getDefaultConfig

Function: getDefaultConfig()

getDefaultConfig(): object

Defined in: src/core/config.ts:13

Returns

object

bump

bump: Required<Omit<BumpConfig, "preid">>

changelog

changelog: Required<ChangelogConfig>

cwd

cwd: string

excludeAuthors

excludeAuthors: never[] = []

logLevel

logLevel: "error" | "default" | "silent" | "warning" | "normal" | "debug" | "trace" | "verbose"

noAuthors

noAuthors: boolean = false

publish

publish: object

publish.args

args: never[] = []

publish.private

private: boolean = false

publish.registry

registry: string = 'https://registry.npmjs.org/'

publish.safetyCheck

safetyCheck: boolean = true

publish.token

token: string | undefined

release

release: Required<ReleaseConfig>

safetyCheck

safetyCheck: boolean = true

scopeMap

scopeMap: object = {}

social

social: object

social.slack

slack: object

social.slack.enabled

enabled: boolean = false

social.slack.onlyStable

onlyStable: boolean = true

social.twitter

twitter: object

social.twitter.enabled

enabled: false = false

social.twitter.onlyStable

onlyStable: true = true

social.twitter.postMaxLength

postMaxLength: number = 280

templates

templates: object

templates.commitMessage

commitMessage: string = 'chore(release): bump version to '

templates.emptyChangelogContent

emptyChangelogContent: string = 'No relevant changes for this release'

templates.slackMessage

slackMessage: undefined = undefined

templates.tagBody

tagBody: string = 'v'

templates.tagMessage

tagMessage: string = 'Bump version to '

templates.twitterMessage

twitterMessage: string = '🚀 is out!\n\n\n\n\n'

tokens

tokens: object

tokens.github

github: string | undefined

tokens.gitlab

gitlab: string | undefined

tokens.registry

registry: string | undefined

tokens.slack

slack: string | undefined

tokens.twitter

twitter: object

tokens.twitter.accessToken

accessToken: string | undefined

tokens.twitter.accessTokenSecret

accessTokenSecret: string | undefined

tokens.twitter.apiKey

apiKey: string | undefined

tokens.twitter.apiKeySecret

apiKeySecret: string | undefined

types

types: Record<string, false | { semver?: SemverBumpType; title: string; }>

Released under the MIT License.