Skip to content

Commonly used C# interfaces, patterns, extension methods and utilities by andculture engineering

License

Apache-2.0, Apache-2.0 licenses found

Licenses found

Apache-2.0
LICENSE
Apache-2.0
LICENSE.txt
Notifications You must be signed in to change notification settings

rsm-hcd/RSM.HCD.CSharp

RSM.HCD.CSharp

build status codecov

Supplemental Documentation

Deploying Supplemental Documentation

$: cd documentation
$: npx cross-env CURRENT_BRANCH=main USE_SSH=true GIT_USER={GITHUB_USERNAME} GIT_PASS={GITHUB_PASSWORD} docusaurus deploy

Packages

RSM.HCD.CSharp.Core

Commonly used interfaces, patterns and utilities by the HCD engineering team at RSM

Getting Started (RSM.HCD.CSharp.Core)

This package is installed via NuGet

dotnet add [<PROJECT>] package RSM.HCD.CSharp.Core

RSM.HCD.CSharp.Extensions

Commonly used CSharp extension methods used by the HCD engineering team at RSM.

Getting Started (RSM.HCD.CSharp.Extensions)

This package is installed via NuGet

dotnet add [<PROJECT>] package RSM.HCD.CSharp.Extensions

After installation, simply import the extensions namespace to gain access to all of the available extension methods

using System;
using System.Collection.Generic;
using RSM.HCD.CSharp.Extensions;

public class Program
{
    public static int Main(string[] args)
    {
        new List<string>().IsEmpty(); // returns true
    }
}

RSM.HCD.CSharp.Testing

Commonly used CSharp testing code used by the HCD engineering team at RSM.

Getting Started (RSM.HCD.CSharp.Testing)

This package is installed via NuGet

dotnet add [<PROJECT>] package RSM.HCD.CSharp.Testing

RSM.HCD.CSharp.Conductors

Commonly used interfaces, patterns and utilities for writing conductors by the HCD engineering team at RSM.

Getting Started (RSM.HCD.CSharp.Conductors)

This package is installed via NuGet

dotnet add [<PROJECT>] package RSM.HCD.CSharp.Conductors

Features

Factories

TODO: In-depth documentation on test factories

Configuration

Using the FactorySettings singleton class you can configure test factories. To access properties use the singleton instance FactorySettings.Instance.{property|method};

Debug (default: false)

To enable debug output set the Debug setting to true. Now warnings will be output via standard out for troubleshooting purposes. By default, only exceptional cases will be output.

Development Setup

Below are a few basics to get you started, but there are many more commands and options for managing this and other projects found in the and-cli.

Building project

  • Run the build command

    and-cli dotnet --build

Running tests

  • Run the test command

    and-cli dotnet-test

Running tests along with code coverage

  • Run the test command

    and-cli dotnet-test --coverage
  • Open the coverage.opencover.xml file in your browser

Publishing a new version

Contributing

Information on contributing to this repo is in the Contributing Guide

About

Commonly used C# interfaces, patterns, extension methods and utilities by andculture engineering

Topics

Resources

License

Apache-2.0, Apache-2.0 licenses found

Licenses found

Apache-2.0
LICENSE
Apache-2.0
LICENSE.txt

Stars

Watchers

Forks

Languages