API de SemVer

As utilidades para parse, validação, comparação e incremento de versão ficam em ptool.semver e p.semver.

ptool.semver.parse

v0.1.0 - Introduced.

ptool.semver.parse(version) faz o parse de uma string de versão e retorna um objeto Version.

• version (string, obrigatório): Uma string de versão semântica, com prefixo v opcional.

Exemplo:

local v = ptool.semver.parse("v1.2.3-alpha.1+build.9")
print(v.major, v.minor, v.patch)
print(v.pre, v.build)
print(tostring(v))

ptool.semver.is_valid

v0.1.0 - Introduced.

ptool.semver.is_valid(version) verifica se uma string de versão é válida.

• version (string, obrigatório): Uma string de versão semântica.
• Retorna: boolean.

print(ptool.semver.is_valid("1.2.3")) -- true
print(ptool.semver.is_valid("x.y.z")) -- false

ptool.semver.compare

v0.1.0 - Introduced.

ptool.semver.compare(a, b) compara duas versões.

• a / b (string|Version, obrigatório): Uma string de versão ou um objeto Version.
• Retorna: -1 | 0 | 1.

print(ptool.semver.compare("1.2.3", "1.2.4")) -- -1

ptool.semver.bump

v0.1.0 - Introduced.

ptool.semver.bump(v, op[, channel]) retorna um novo objeto de versão depois de aplicar o incremento.

• v (string|Version, obrigatório): A versão original.
• op (string, obrigatório): Um entre major, minor, patch, release, alpha, beta, rc, prepatch, preminor ou premajor.
• channel (string, opcional): Suportado apenas para prepatch, preminor e premajor. Deve ser um entre alpha, beta ou rc. O padrão é alpha.
• Retorna: Version.

local v = ptool.semver.bump("1.2.3", "alpha")
print(tostring(v)) -- 1.2.4-alpha.1

local next_minor_rc = ptool.semver.bump("1.2.3", "preminor", "rc")
print(tostring(next_minor_rc)) -- 1.3.0-rc.1

local stable = ptool.semver.bump("1.2.4-rc.2", "release")
print(tostring(stable)) -- 1.2.4

Version

v0.1.0 - Introduced.

Version representa uma versão semântica analisada retornada por ptool.semver.parse(...) ou ptool.semver.bump(...).

Ela é implementada como userdata Lua.

Campos e métodos:

• Campos:
  • major (integer)
  • minor (integer)
  • patch (integer)
  • pre (string|nil)
  • build (string|nil)
• Métodos:
  • v:compare(other) -> -1|0|1
  • v:bump(op[, channel]) -> Version
  • v:to_string() -> string
• Metamétodos:
  • tostring(v) está disponível.
  • Comparações ==, < e <= são suportadas.

compare

Nome canônico da API: ptool.semver.Version:compare.

v:compare(other) compara a versão atual com other.

• other (string|Version, obrigatório): Uma string de versão ou outro objeto Version.
• Retorna: -1 | 0 | 1.

bump

Nome canônico da API: ptool.semver.Version:bump.

v:bump(op[, channel]) retorna um novo objeto Version depois de aplicar o incremento.

• op (string, obrigatório): Um entre major, minor, patch, release, alpha, beta, rc, prepatch, preminor ou premajor.
• channel (string, opcional): Suportado apenas para prepatch, preminor e premajor. Deve ser um entre alpha, beta ou rc. O padrão é alpha.
• Retorna: Version.

to_string

Nome canônico da API: ptool.semver.Version:to_string.

v:to_string() retorna a forma canônica da versão em string.

• Retorna: string.

Regras de incremento de prerelease:

• Ao incrementar uma versão estável para alpha, beta ou rc, primeiro a versão patch é incrementada e depois o canal alvo começa em .1.
• prepatch, preminor e premajor iniciam uma nova prerelease a partir da próxima versão patch, minor ou major, respectivamente, por exemplo 1.2.3 -> 1.3.0-rc.1 com preminor + rc.
• Incrementar dentro do mesmo canal aumenta o número de sequência, como em alpha.1 -> alpha.2.
• release remove metadados de prerelease e build, mantendo o mesmo major.minor.patch, por exemplo 1.2.3-rc.2 -> 1.2.3.
• Promoção de canal é permitida (alpha -> beta -> rc), mas rebaixamento não é permitido, por exemplo rc -> beta gera erro.