Skip to content

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 and --min-app-version take a value instead and have 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. - --min-app-version=<x.y.z> — write this minAppVersion into the plugin’s manifest.json and its new versions.json entry instead of tracking the latest Obsidian desktop version. - --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 { parseVersionArguments } from 'obsidian-dev-utils/script-utils/version';

Signature:

function parseVersionArguments($arguments: string[]): ParsedVersionArguments

Parameters:

ParameterTypeDescription
$argumentsstring[]

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