DigitalZenWorks.Common.Utilities 1.6.0

UtilitiesNet

This is a C# base library project with reusable utilities for text, Unicode, email addresses, files, byte arrays, XML, and encryption.

Available as the DigitalZenWorks.Common.Utilities NuGet package.

Installation

Add the package to your application:

dotnet add package DigitalZenWorks.Common.Utilities

Or use Visual Studio's Package Manager Console:

Install-Package DigitalZenWorks.Common.Utilities

Quick start

String extensions use the DigitalZenWorks.Common.Utilities.Extensions namespace:

using DigitalZenWorks.Common.Utilities.Extensions;

string? propertyName = "email_address".ToCamelCase();
// emailAddress

string digits = "+1 (555) 010-0200".ToDigitsOnly();
// 15550100200

Other utilities use the DigitalZenWorks.Common.Utilities namespace:

using DigitalZenWorks.Common.Utilities;

bool valid = EmailUtilities.IsValidEmailAddress("user@example.com");
// true

Available utilities

See the XML documentation in the library source for individual method parameters, return values, and limitations.

Target frameworks

The current Release configuration targets .NET Standard 2.0 and .NET 5, 6, 7, 8, 9, and 10. Debug builds target .NET 10 only. See the package page for the frameworks included in a published version and its dependencies.

Build and test

Install the .NET 10 SDK to build this checkout. Clone the repository:

git clone https://github.com/jamesjohnmcguire/UtilitiesNet.git
cd UtilitiesNet

From the repository root, build and run the NUnit tests:

dotnet build UtilitiesNet.slnx --configuration Debug
dotnet test UtilitiesNet.slnx --configuration Debug

Release builds compile all configured library targets and generate a NuGet package under UtilitiesNetLibrary/bin/Release/:

dotnet build UtilitiesNet.slnx --configuration Release

Contributing

Report bugs and propose improvements through GitHub issues.

For a pull request:

1. Fork the Project
2. Create your focused branch
3. Add your code changes
4. Add or update tests to validate your changes
5. Commit and Push your Changes
6. Open a Pull Request. Include the description of the change, its validation, and any related issue in the PR.

Coding style

Please match the current coding style. Most notably:

1. One operation per line
2. Use complete, self-documenting English words in variable and method names
3. Attempt to declare variable and method names in a self-documenting manner
4. Use tabs and Allman braces

Keep public API compatibility in mind: this library is consumed as NuGet package.

License

Distributed under the MIT License.

Contact

James John McGuire — jamesjohnmcguire@gmail.com

Project repository. If the library is useful to you, consider giving it a star.