https://github.com/kotools/assert

Kotlin Multiplatform library providing lightweight assertions.
https://github.com/kotools/assert

assert assertions kotlin kotlin-js kotlin-jvm kotlin-multiplatform kotlin-native

Last synced: 3 days ago
JSON representation

Kotlin Multiplatform library providing lightweight assertions.

• Host: GitHub
• URL: https://github.com/kotools/assert
• Owner: kotools
• License: mit
• Archived: true
• Created: 2022-02-11T19:00:06.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2023-11-25T11:16:15.000Z (about 1 year ago)
• Last Synced: 2024-09-27T00:02:49.017Z (4 months ago)
• Topics: assert, assertions, kotlin, kotlin-js, kotlin-jvm, kotlin-multiplatform, kotlin-native
• Language: Kotlin
• Homepage: https://kotools.github.io/assert
• Size: 333 KB
• Stars: 1
• Watchers: 0
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
> This project is deprecated.

> We recommend using the [testing library from Kotlin][kotlin.test] instead.

[kotlin.test]: https://kotlinlang.org/api/latest/kotlin.test

# Kotools Assert

[![Maven Central](https://img.shields.io/maven-central/v/io.github.kotools/assert)](https://search.maven.org/artifact/io.github.kotools/assert)

[![Kotlin](https://img.shields.io/badge/kotlin-1.5.31-blue.svg?logo=kotlin)][kotlin]

Kotools Assert is a multiplatform library providing lightweight assertions for

[Kotlin].

> This library currently supports the JVM, JS and Native platforms.

```kotlin

1 assertEquals 1

2 assertNotEquals 0

assertNull { null }

null.assertNull()

assertNotNull { 3 }

3.assertNotNull()

assertPass { println("Hello") }

assertFails { throw Exception() }

assertFailsWith { throw RuntimeException() }

```

[kotlin]: https://kotlinlang.org

## Installation

### Gradle

#### Kotlin DSL

```kotlin

testImplementation("io.github.kotools:assert:3.0.2")

```

#### Groovy DSL

```groovy

testImplementation 'io.github.kotools:assert:3.0.2'

```

### Maven

```xml

    io.github.kotools

    assert

    3.0.2

    test

```

## Documentation

Latest documentation of Kotools Assert is available

[here](https://kotools.github.io/assert).

## Contributing

Feel free to contribute to the project with

[issues](https://github.com/kotools/assert/issues) and

[pull requests](https://github.com/kotools/assert/pulls).

This project follows the [Conventional Commits][conventional-commits] guidelines

for committing with Git.

Please read [the specifications][conventional-commits] before committing to this

project.

[conventional-commits]: https://www.conventionalcommits.org/en/v1.0.0/

## License

This project is licensed under the

[MIT License](https://choosealicense.com/licenses/mit).