Skip to content

parseVersionArgs

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. Recognized flags: - --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-demo-vault — skip archiving the plugin’s demo vault (demo-vault/) as a release artifact. - --no-release — run all local steps but skip the push and the GitHub release.

Import:

import { parseVersionArgs } from 'obsidian-dev-utils/script-utils/version';

Signature:

function parseVersionArgs(args: string[]): ParsedVersionArgs

Parameters:

ParameterTypeDescription
argsstring[]The command-line arguments to parse (typically process.argv.slice(2)).

Returns: ParsedVersionArgs — The ParsedVersionArgs containing the version update type and the options.