Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ardalis/Ardalis.Extensions
Some random C# extension methods I've found useful. Published as Ardalis.Extensions on Nuget.
https://github.com/ardalis/Ardalis.Extensions
ardalis csharp dotnet extension-methods extensions hacktoberfest
Last synced: 4 days ago
JSON representation
Some random C# extension methods I've found useful. Published as Ardalis.Extensions on Nuget.
- Host: GitHub
- URL: https://github.com/ardalis/Ardalis.Extensions
- Owner: ardalis
- License: mit
- Created: 2021-07-09T16:26:31.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2023-11-21T20:48:39.000Z (12 months ago)
- Last Synced: 2024-11-05T14:18:31.654Z (8 days ago)
- Topics: ardalis, csharp, dotnet, extension-methods, extensions, hacktoberfest
- Language: C#
- Homepage:
- Size: 1.31 MB
- Stars: 157
- Watchers: 7
- Forks: 34
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://www.nuget.org/packages/Ardalis.Extensions)
[](https://www.nuget.org/packages/Ardalis.Extensions)
[](https://github.com/ardalis/Ardalis.Extensions/actions/workflows/publish.yml)
# Ardalis.Extensions
Some random C# extension methods I've found useful. Published as Ardalis.Extensions on Nuget.
## Table of Contents
- [Installation](#installation)
- [Usage](#usage)
- [String checks](#string-checks)
- [Conventions for Contributors](#conventions-for-contributors)
- [Benchmarks](#benchmarks)
- [Roadmap](#roadmap)
## Installation
Just add a reference the the package and then anywhere you want to use the extensions, add the appropriate `using` statement.
```powershell
dotnet add package Ardalis.Extensions
```
## Usage
### String Checks
IsNull() checks whether a given string is null.
```csharp
// replace
if(someString is null)
// with
if(someString.IsNull())
```
IsNullOrEmpty() checks whether a given string is null or empty.
```csharp
// replace
if(String.IsNullOrEmpty(someString))
// with
if(someString.IsNullOrEmpty())
```
IsNullOrWhiteSpace checks whether a given string is null or empty or consists of only whitespace characters.
```csharp
// replace
if(String.IsNullOrWhiteSpace(someString))
// with
if(someString.IsNullOrWhiteSpace())
```
## Conventions for Contributors
- Extension methods are grouped into folders based on similar purpose.
- Folder nesting should match class namespaces.
- `Ardalis.Extensions.Parsing`
- `Ardalis.Extensions.Encoding.Base64`
- One extension method class per folder.
- Extension methods classes should have an `Extensions` suffix.
- Classes should be made [partial](https://docs.microsoft.com/en-us/dotnet/csharp/programming-guide/classes-and-structs/partial-classes-and-methods#partial-classes).
- One extension method per file.
- Overloads should be placed in the same file.
- File names should be the contained extension method's name.
- Tests should be provided for each extension method and overload.
- Test classes should have a `Tests` suffix.
- Benchmark classe should have a `Benchmarks` suffix.
## Benchmarks
To run all of the benchmarks, run the following command from the benchmarks project folder:
```ps
dotnet run -c Release
```
## Roadmap
For now as I gather different useful extensions there is a single [Ardalis.Extensions](https://www.nuget.org/packages/Ardalis.Extensions) package available on NuGet. Once there are more than a few, I will most likely break up the extensions into separate individual NuGet packages (for example: Ardalis.StringExtensions? Ardalis.Extensions.Strings?) and then the original Ardalis.Extensions would become a meta-package that would pull in all of the separate smaller packages.