#daqing/parse-version

#Installation

moon add daqing/parse-version

///|
import {
  "daqing/parse-version",
}

#Usage

#Read the version from moon.mod

///|
fn main {
  let version = @parse-version.Version::parse("moon.mod")
  println(version) // e.g. "0.1.0"
}

#Handle a missing version

///|
fn read_version(path : String) -> String {
  @parse-version.Version::parse(path) catch {
    @parse-version.VersionNotFound(path) =>
      "unknown (\{path} has no version field)"
  }
}

#Parsing rules

• Blank lines and lines starting with // are skipped.
• The key and the value may be separated by any amount of whitespace: version="1.2.3" and version = "1.2.3" both work.
• The value must be a quoted string; anything after the closing quote is ignored, so trailing comments are fine.
• The first matching line wins.
• The manifest is not parsed as full TOML, so a version line nested in another table would also be picked up.

#API

pub struct Version {}

pub suberror VersionError {
  VersionNotFound(String)
}

pub fn Version::parse(path : String) -> String raise

• Version::parse(path) returns the version string, or raises VersionNotFound(path).
• VersionError is a sub-error, so it can be caught and re-raised freely in your own error types.

#Development

moon test          # run tests
moon info && moon fmt

#License