parseVersionArguments
Parses the command-line arguments for a version update into a version update type and UpdateVersionOptions.
Each behavior is enabled by default; the corresponding --no-* flag turns it off. --changelog-file takes a value instead and has no default. Recognized flags: - --changelog-file=<path> — use this file’s contents as the new version’s changelog section instead of the commit-derived bullets, and skip the interactive review entirely. - --no-build — skip the build step (only safe when the build output already matches the current code). - --no-changelog-editing — generate the changelog without opening it for manual review. - --no-checks — skip the clean-repo check, format, spellcheck, lint, over-exposure analysis, and tests (the build still runs). - --no-commit-verification — pass --no-verify to the release commit, skipping the pre-commit hook. - --no-issue-closing — do not close the issues the release carries once it is published. - --no-release — run all local steps but skip the push and the GitHub release.
Import:
import { parseVersionArguments } from '@mnaoumov/typescript-dev-toolkit/version';Signature:
function parseVersionArguments($arguments: string[]): ParsedVersionArgumentsParameters:
| Parameter | Type | Description |
|---|---|---|
$arguments |
string[] |
Returns: ParsedVersionArguments — The ParsedVersionArguments containing the version update type and the options.
Links to this page: