Options
All
  • Public
  • Public/Protected
  • All
Menu

Options of the git flow node project.

Hierarchy

  • ProjectConfig

Index

Properties

autoStash?: boolean

Auto stashes the uncommited changes on starting a git flow branch. After the git flow branch was created, the latest stash is popped. DEFAULTS: true

bumpVersionFiles?: string[]

Specifies the JSON files containing a version attribute to be overwritten if the version changes. DEFAULTS: 'package.json' and 'package-lock.json'

changelog?: ChangelogConfig<Record<string, unknown>>

Sets the configuration of the changelog.

DEFAULTS:

{
"type": "ConventionalChangelog",
"changelogFileName": "CHANGELOG.md",
"storeLatestChangelog": false,
"conventionalChangelogPresent": "angular"
}
changelogFileName?: string

Specifies the name of the changelog. DEFAULTS: CHANGELOG.md

deprecated

This property was moved to the option changelog. This property will be removed in version 3.*.

conventionalChangelogPresent?: string

Specifies the conventional commit format. The selectable options are:

  • angular (default)
  • atom
  • ember
  • eslint
  • jquery
  • jshint

For more infomation check out the documentation of the conventional-changelog-preset-loader. This loader is used to load the corresponding present.

deprecated

This property was moved to the option changelog. This property will be removed in version 3.*.

conventionalCommit?: Options

Sets the conventional commit options of conventional-commits-parser

Additional DEFAULTS:

 {
"referenceActions": [
"close",
"closes",
"closed",
"fix",
"fixes",
"fixed",
"resolve",
"resolves",
"resolved",
"refs",
"references"
],
"noteKeywords": ["BREAKING CHANGE", "SECURITY", "REMOVED"]
}
projectPath: string

Path to the node project folder / git repository.

storeLatestChangelog?: boolean

Set this flag to keep the changelog of the latest release as changelogFileName.latest.md. This file can be useful for some other tools which processes the release information (ex. gitlab).

deprecated

This property was moved to the option changelog. This property will be removed in version 3.*.

versionFile?: string

Specifies the primary version file containing the version of the project. DEFAULTS: 'package.json'