mznjs API Documentation - v0.0.31-beta.5
    Preparing search index...

    Class VersionManager

    版本管理类 - 提供版本更新和发布的核心功能

    Index

    Constructors

    • 构造函数

      Parameters

      • options: VersionManagerOptions = {}

      Returns VersionManager

    Methods

    • 更新指定包的版本号

      Parameters

      • pkgName: string

        要更新的包名称,'all' 表示更新所有配置的包

      • releaseType: ReleaseType = 'patch'

        版本发布类型,可选值: major, minor, patch, pre-patch, pre-minor, pre-major, as-is, conventional

      • options: UpdateOptions = {}

        更新选项,可包含 dryRun, verbose, customVersion, autoCommit, push, npm 等

      Returns Promise<UpdateResult>

      返回更新结果,包含成功状态、更新和发布的包列表

      const manager = new VersionManager({ config, rootDir })
      const result = await manager.updateVersion('my-package', 'minor', { dryRun: true })
      console.log(result.updatedPackages)
    • 执行 Git 提交和推送操作

      Parameters

      • push: boolean = true

        是否推送到远程仓库,默认为 true

      Returns Promise<void>

      await versionManager.gitCommitAndPush(true)
      
    • 获取包的当前版本

      Parameters

      • pkgName: string

      Returns string | null

    • 检查版本是否有效

      Parameters

      • version: string

      Returns boolean

    • 解析版本号差异

      Parameters

      • oldVersion: string
      • newVersion: string

      Returns string | null