https://github.com/joellefkowitz/assert-multiple

Chain assertions contained in a monad.
https://github.com/joellefkowitz/assert-multiple

assert chain monad multiple

Last synced: 22 days ago
JSON representation

Chain assertions contained in a monad.

• Host: GitHub
• URL: https://github.com/joellefkowitz/assert-multiple
• Owner: JoelLefkowitz
• License: mit
• Created: 2021-05-30T21:31:05.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2024-06-27T18:56:02.000Z (6 months ago)
• Last Synced: 2024-10-04T21:41:17.248Z (3 months ago)
• Topics: assert, chain, monad, multiple
• Language: PureScript
• Size: 481 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

        
# Assert multiple

Chain assertions contained in a monad.

![Review](https://img.shields.io/github/actions/workflow/status/JoelLefkowitz/assert-multiple/review.yml)

![Version](https://pursuit.purescript.org/packages/purescript-assert-multiple/badge)

![Quality](https://img.shields.io/codacy/grade/e554a1597f8b40d9b7e54d7923c2049f)

## Installing

```bash

spago install assert-multiple

```

## Documentation

Documentation and more detailed examples are hosted on [Pursuit](https://pursuit.purescript.org/packages/purescript-assert-multiple).

## Usage

Normally, an array of assertions will not be evaluated eagerly:

```purs

import Test.Assert (assert)

do

  x <- 1 .. 5

  pure $ assert (x <= 5)

```

`resolve` will fold and invoke them sequentially.

```purs

import Test.Assert.Multiple (resolve)

resolve do

  x <- 1 .. 5

  pure $ assert (x <= 5)

```

## Tooling

### Dependencies

To install dependencies:

```bash

yarn install

yarn spago install

```

### Tests

To run tests:

```bash

yarn spago test

```

### Documentation

To generate the documentation locally:

```bash

yarn spago docs

```

### Linters

To run linters:

```bash

yarn lint

```

### Formatters

To run formatters:

```bash

yarn format

```

## Contributing

Please read this repository's [Code of Conduct](CODE_OF_CONDUCT.md) which outlines our collaboration standards and the [Changelog](CHANGELOG.md) for details on breaking changes that have been made.

This repository adheres to semantic versioning standards. For more information on semantic versioning visit [SemVer](https://semver.org).

Bump2version is used to version and tag changes. For example:

```bash

bump2version patch

```

### Contributors

- [Joel Lefkowitz](https://github.com/joellefkowitz) - Initial work

## Remarks

Lots of love to the open source community!