https://github.com/aznashwan/gleamsver

Comprehensive set of native Gleam utilities for handling SemVer 2.0.0.
https://github.com/aznashwan/gleamsver

gleam gleam-lang gleam-language semver-compare semver-format semver-parser semver-syntax

Last synced: about 1 month ago
JSON representation

Comprehensive set of native Gleam utilities for handling SemVer 2.0.0.

• Host: GitHub
• URL: https://github.com/aznashwan/gleamsver
• Owner: aznashwan
• License: mit
• Created: 2024-04-01T17:53:42.000Z (3 months ago)
• Default Branch: main
• Last Pushed: 2024-05-20T20:50:32.000Z (about 2 months ago)
• Last Synced: 2024-05-20T22:15:54.208Z (about 2 months ago)
• Topics: gleam, gleam-lang, gleam-language, semver-compare, semver-format, semver-parser, semver-syntax
• Language: Gleam
• Homepage: https://hexdocs.pm/gleamsver/
• Size: 22.5 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Lists

• awesome-gleam - gleamsver - [📚](https://hexdocs.pm/gleamsver/) - Comprehensive set of native Gleam utilities for handling SemVer 2.0.0 version strings. (Packages / Parsing)

README

        
# gleamsver

Comprehensive set of native Gleam utilities for handling

[SemVer 2.0.0](https://semver.org) version strings.

[![Package Version](https://img.shields.io/hexpm/v/gleamsver)](https://hex.pm/packages/gleamsver)

[![Hex Docs](https://img.shields.io/badge/hex-docs-ffaff3)](https://hexdocs.pm/gleamsver/)

```sh

gleam add gleamsver

```

```gleam

import gleam/io

import gleamsver

fn compress_message(message: String) -> String {

  message <> ", but compressed ;)"

}

pub fn main() {

  // Parse correct SemVer 2.0.0 strings using `parse()`:

  let assert Ok(server_version_with_compression) = gleamsver.parse("1.3.7-rc0")

  io.debug(server_version_with_compression)  // SemVer(1, 3, 7, "rc0", "")

  // Parse loose SemVer strings using `parse_loosely()`:

  let assert Ok(current_server_version) = gleamsver.parse_loosely("v1.4")

  // Convert back to SemVer strings using `to_string()`:

  let uncompressed_message =

    "Hello, server version " <> gleamsver.to_string(current_server_version)

  let message = {

    // Guard against version mismatches using `guard_version_*()` functions:

    use <- gleamsver.guard_version_compatible(

      version: server_version_with_compression,

      compatible_with: current_server_version,

      else_return: uncompressed_message,

    )

    // Compression will only occur if the above guard succeeds:

    compress_message(uncompressed_message)

  }

  // Prints "Hello, server version 1.4.0, but compressed ;)"

  io.println(message)

}

```

Further documentation can be found at .

## Development

```sh

gleam run   # Run the project

gleam test  # Run the tests

gleam shell # Run an Erlang shell

```