https://github.com/eoehen/arguard

Argument and parameter validator library.
https://github.com/eoehen/arguard

argument argument-validation hacktoberfest nuget nuget-package parameter-validation validation

Last synced: 4 months ago
JSON representation

Argument and parameter validator library.

• Host: GitHub
• URL: https://github.com/eoehen/arguard
• Owner: eoehen
• License: mit
• Created: 2020-10-29T12:31:24.000Z (over 4 years ago)
• Default Branch: develop
• Last Pushed: 2024-10-24T01:31:27.000Z (6 months ago)
• Last Synced: 2024-10-24T17:10:01.829Z (6 months ago)
• Topics: argument, argument-validation, hacktoberfest, nuget, nuget-package, parameter-validation, validation
• Language: C#
• Homepage: https://eoehen.github.io/arguard/
• Size: 2.61 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# oehen.arguard

[![NuGet](https://img.shields.io/nuget/v/oehen.arguard.svg)](https://www.nuget.org/packages/oehen.arguard) [![NuGet Downloads](https://img.shields.io/nuget/dt/oehen.arguard.svg)](https://www.nuget.org/packages/oehen.arguard/)

![oehen.arguard](https://raw.githubusercontent.com/eoehen/arguard/master/docs/logo/arguardlogo_1000x400.jpg)

oehen.arguard is a dotnet argument and parameter validator extension library.

## Installation

Use the nuget package manager to install oehen.arguard:

Package [oehen.arguard](https://www.nuget.org/packages/oehen.arguard) is publish to [nuget.org](https://www.nuget.org/).

`dotnet add package oehen.arguard --version `

## Documentation

The latest documentation can find at [https://eoehen.github.io/arguard/](https://eoehen.github.io/arguard/).

## Information

| | Stable | Pre-release |

|:--:|:--:|:--:|

|GitHub Release|[![GitHub prerelease](https://img.shields.io/github/v/release/eoehen/arguard?include_prereleases)](https://github.com/eoehen/arguard/releases/latest)|[![GitHub release](https://img.shields.io/github/v/release/eoehen/arguard)](https://github.com/eoehen/arguard/releases/latest)|

|NuGet|[![NuGet](https://img.shields.io/nuget/v/oehen.arguard.svg)](https://www.nuget.org/packages/oehen.arguard)|[![NuGet](https://img.shields.io/nuget/vpre/oehen.arguard.svg)](https://www.nuget.org/packages/oehen.arguard)|

## Build

|Develop|Master|

|:--:|:--:|

|![develop](https://github.com/eoehen/arguard/workflows/CI-Build/badge.svg?branch=develop)|![master](https://github.com/eoehen/arguard/workflows/CI-Build/badge.svg?branch=master)|

To build this package we are using [Cake.Recipe](https://github.com/cake-contrib/Cake.Recipe).

On Windows PowerShell run:

`.\build.ps1`

### New Release

- Prepare [Milestone](https://github.com/eoehen/arguard/milestones) for releasing.

- Create and switch to gitflow release branch.

- Set `GITHUB_TOKEN` environment variable.

> `$Env:GITHUB_TOKEN="{token}"`

- Run `Cake.Recipe` for creating release notes.

> `.\build.ps1 --target=releasenotes`

- Check release notes.

- Merge gitflow release branche to develop and master.

- Finish the created [release](https://github.com/eoehen/arguard/releases) version on github.

## Code Coverage & Quality

## Codacy

[![Codacy Badge](https://app.codacy.com/project/badge/Grade/b09d240a2f6a4a398a582ff7295f4830)](https://www.codacy.com/gh/eoehen/arguard/dashboard?utm_source=github.com&utm_medium=referral&utm_content=eoehen/arguard&utm_campaign=Badge_Grade)

[![Codacy Badge](https://app.codacy.com/project/badge/Coverage/b09d240a2f6a4a398a582ff7295f4830)](https://www.codacy.com/gh/eoehen/arguard/dashboard?utm_source=github.com&utm_medium=referral&utm_content=eoehen/arguard&utm_campaign=Badge_Coverage)

### CodeCov

[![codecov](https://codecov.io/gh/eoehen/arguard/branch/develop/graph/badge.svg?token=9B8NT9L82D)](https://codecov.io/gh/eoehen/arguard)



## Contributing

Contributions are welcome. See [Contribution Guidelines](CONTRIBUTING.md).

## License

[![License](http://img.shields.io/:license-mit-blue.svg)](https://github.com/eoehen/arguard/blob/master/LICENSE)