Class ConfigDefaulter

Sets the defaults of the different kinds of configurations.

Hierarchy

ConfigDefaulter

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new ConfigDefaulter(): ConfigDefaulter

Returns ConfigDefaulter

Properties

Static Readonly DefaultBumpVersionFiles

DefaultBumpVersionFiles: string[] = ...

Static Readonly DefaultConventionalCommit

DefaultConventionalCommit: { noteKeywords: string[]; referenceActions: string[] } = ...

Type declaration

noteKeywords: string[]
referenceActions: string[]

Static Readonly DefaultVersionFile

DefaultVersionFile: "package.json" = 'package.json'

Methods

Static ensureGFlowConfigDefaults

ensureGFlowConfigDefaults(config?: GFlowConfig): GFlowConfig

Ensures the defaults of the GFlow configuration.

Parameters
- Optional config: GFlowConfig
  
  The GFlow configuration should be extended with its defaults.
Returns GFlowConfig
The extended GFlow configuration with its defaults.

Static ensureGitFlowConfigDefaults

ensureGitFlowConfigDefaults(config?: GitFlowConfig): GitFlowConfig

Ensures the defaults of the git flow configuration.

Parameters
- Optional config: GitFlowConfig
  
  The git flow configuration should be extended with its defaults.
Returns GitFlowConfig
The extended git flow configuration with its defaults.

Static ensureProjectConfigDefaults

ensureProjectConfigDefaults(config?: ProjectConfig): ProjectConfig

Ensures the defaults of the project configuration.

Parameters
- Optional config: ProjectConfig
  
  The project configuration should be extended with its defaults.
Returns ProjectConfig
The extended project configuration with its defaults.