@types/standard-version

property bumpFiles

bumpFiles?: Array<string | Options.VersionFile> | undefined;

• [ 'package-lock.json', 'npm-shrinkwrap.json', 'composer.lock' ]

property changelogHeader

changelogHeader?: string | undefined;

• Use a custom header when generating and updating changelog.

  Deprecated

  This option will be removed in the next major version, please use header.

property commitAll

commitAll?: boolean | undefined;

• Commit all staged changes, not just files affected by standard-version.

  false

property dryRun

dryRun?: boolean | undefined;

• See the commands that running standard-version would run.

  false

property firstRelease

firstRelease?: boolean | undefined;

• Is this the first release?

  false

property gitTagFallback

gitTagFallback?: boolean | undefined;

• Fallback to git tags for version, if no meta-information file is found (e.g., package.json).

  true

property infile

infile?: string | Buffer | URL | number | undefined;

• Read the CHANGELOG from this file.

  'CHANGELOG.md'

property message

message?: string | undefined;

• Commit message, replaces %s with new version.

  Deprecated

  This option will be removed in the next major version, please use releaseCommitMessageFormat.

property noVerify

noVerify?: boolean | undefined;

• Bypass pre-commit or commit-msg git hooks during the commit phase.

  false

property packageFiles

packageFiles?: Array<string | Options.VersionFile> | undefined;

• [ 'package.json', 'bower.json', 'manifest.json', 'composer.json' ]

property path

path?: string | undefined;

• Only populate commits made under this path.

property prerelease

prerelease?: string | undefined;

• Make a pre-release with optional option value to specify a tag id.

property preset

preset?: string | undefined;

• Commit message guideline preset.

  require.resolve('conventional-changelog-conventionalcommits')

property releaseAs

releaseAs?: string | undefined;

• Specify the release type manually (like npm version <major|minor|patch>).

property scripts

scripts?: Options.Scripts | undefined;

• Provide scripts to execute for lifecycle events (prebump, precommit, etc.,).

  {}

property sign

sign?: boolean | undefined;

• Should the git commit and tag be signed?

  false

property silent

silent?: boolean | undefined;

• Don't print logs and errors.

  false

property skip

skip?: Options.Skip | undefined;

• Map of steps in the release process that should be skipped.

  {}

property tagPrefix

tagPrefix?: string | undefined;

• Set a custom prefix for the git tag to be created.

  'v'

type Skip

type Skip = Partial<Record<'bump' | 'changelog' | 'commit' | 'tag', boolean>>;