AndcultureCode.CSharp

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

AndcutlureCode.CSharp.Core

Commonly used interfaces, patterns and utilities by andculture engineering

Getting Started (AndcutlureCode.CSharp.Core)

This package is installed via NuGet

dotnet add [<PROJECT>] package AndcultureCode.CSharp.Core

Documentation (AndcutlureCode.CSharp.Core)

Full API Documentation

AndcultureCode.CSharp.Extensions

Commonly used CSharp extension methods used at andculture.

Getting Started (AndcultureCode.CSharp.Extensions)

This package is installed via NuGet

dotnet add [<PROJECT>] package AndcultureCode.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 AndcultureCode.CSharp.Extensions;

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

Documentation (AndcultureCode.CSharp.Extensions)

Full API Documentation

AndcultureCode.CSharp.Testing

Commonly used CSharp testing code used at andculture.

Getting Started (AndcultureCode.CSharp.Testing)

This package is installed via NuGet

dotnet add [<PROJECT>] package AndcultureCode.CSharp.Testing

Documentation (AndcultureCode.CSharp.Testing)

Full API Documentation

AndcultureCode.CSharp.Conductors

Commonly used interfaces, patterns and utilities for writing conductors by andculture engineering.

Getting Started (AndcultureCode.CSharp.Conductors)

This package is installed via NuGet

dotnet add [<PROJECT>] package AndcultureCode.CSharp.Conductors

Documentation (AndcultureCode.CSharp.Conductors)

Full API Documentation

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

Install Dotnet Core 3.1
Install the and-cli tooling found at AndcultureCode.Cli

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

Run the publish command with the next version number (See semver package versioning)
```
and-cli nuget --publish <version>
```

Contributing

Information on contributing to this repo is in the Contributing Guide

Contributors ✨

Thanks goes to these wonderful people (emoji key):

_{Winton DeShong} 💻 ⚠️ 📖 👀	_{Brandon Scott} 💻 ⚠️ 🚧 👀 📖	_{Stefanie Leitch} 💻	_Jeb 💻 ⚠️	_{Joshua Hughes} 💻 👀	_{Dylan Justice} 💻 ⚠️ 📖	_{Said B Shah} 📖 💻 🚧
_{Scott Savage} 💻 ⚠️ 📖	_{Mike Koser} 💻 ⚠️ 👀	_{Joshua Peters} 💻 ⚠️	_{Mat Jones} 💻 ⚠️	_{Davyd McColl} ⚠️	_{kamal-mansouri} ⚠️	_{Jim Stevenson} 👀
_{Ralph J McIntyre} 🚧	_{Davide Zoccarato} 💻 ⚠️ 📖	_{Kyle Lauffer} 🚧 📆 👀	_{Michael Tyson} 🚧 📆 👀