Skip to content

Commit

Permalink
docs
Browse files Browse the repository at this point in the history
  • Loading branch information
SimonCropp committed Sep 18, 2024
1 parent 71f3887 commit 6b95193
Show file tree
Hide file tree
Showing 394 changed files with 22,466 additions and 198 deletions.
1 change: 1 addition & 0 deletions docs/mdsource/wiz/Linux_Other_Cli.source.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ Options:
* [Xunit](Linux_Other_Cli_Xunit.md)
* [XunitV3](Linux_Other_Cli_XunitV3.md)
* [NUnit](Linux_Other_Cli_NUnit.md)
* [TUnit](Linux_Other_Cli_TUnit.md)
* [Fixie](Linux_Other_Cli_Fixie.md)
* [MSTest](Linux_Other_Cli_MSTest.md)
* [Expecto](Linux_Other_Cli_Expecto.md)
11 changes: 11 additions & 0 deletions docs/mdsource/wiz/Linux_Other_Cli_TUnit.source.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
# Getting Started Wizard

[Home](/docs/wiz/readme.md) > [Linux](Linux.md) > [Other](Linux_Other.md) > [Prefer CLI](Linux_Other_Cli.md) > [TUnit](Linux_Other_Cli_TUnit.md)

## Select Build Server

Options:
* [AppVeyor](Linux_Other_Cli_TUnit_AppVeyor.md)
* [GitHub Actions](Linux_Other_Cli_TUnit_GitHubActions.md)
* [Azure DevOps](Linux_Other_Cli_TUnit_AzureDevOps.md)
* [No build server](Linux_Other_Cli_TUnit_None.md)
93 changes: 93 additions & 0 deletions docs/mdsource/wiz/Linux_Other_Cli_TUnit_AppVeyor.source.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
# Getting Started Wizard

[Home](/docs/wiz/readme.md) > [Linux](Linux.md) > [Other](Linux_Other.md) > [Prefer CLI](Linux_Other_Cli.md) > [TUnit](Linux_Other_Cli_TUnit.md) > AppVeyor

## Add NuGet packages

Add the following packages to the test project:

```
dotnet add package TUnit
dotnet add package Verify.TUnit
```

## Implicit Usings

include: implicit-usings


## Conventions


### Source Control Includes/Excludes

include: include-exclude


### Text file settings

include: text-file-settings


### Conventions check

Conventions can be checked by calling `VerifyChecks.Run()` in a test

snippet: VerifyChecksTUnit

## DiffPlex

The text comparison behavior of Verify is pluggable. The default behaviour, on failure, is to output both the received
and the verified contents as part of the exception. This can be noisy when verifying large strings.

[Verify.DiffPlex](https://github.com/VerifyTests/Verify.DiffPlex) changes the text compare result to highlighting text differences inline.

This is optional, but recommended.

### Add the NuGet

```
dotnet add package Verify.DiffPlex
```

### Enable

```cs
[ModuleInitializer]
public static void Initialize() =>
VerifyDiffPlex.Initialize();
```

## Verify.Terminal

[Verify.Terminal](https://github.com/VerifyTests/Verify.Terminal) is a dotnet tool for managing snapshots from the command line.

This is optional.

### Install the tool

```
dotnet tool install -g verify.tool
```


## Sample Test

snippet: SampleTestTUnit

## Diff Tool

Verify supports many [Diff Tools](https://github.com/VerifyTests/DiffEngine/blob/main/docs/diff-tool.md#supported-tools) for comparing received to verified.
While IDEs are supported, due to their MDI nature, using a different Diff Tool is recommended.

Tools supported by Linux:

* [BeyondCompare](https://www.scootersoftware.com)
* [P4Merge](https://www.perforce.com/products/helix-core-apps/merge-diff-tool-p4merge)
* [Rider](https://www.jetbrains.com/rider/)
* [Neovim](https://neovim.io/)

## Getting .received in output on AppVeyor

include: build-server-appveyor

93 changes: 93 additions & 0 deletions docs/mdsource/wiz/Linux_Other_Cli_TUnit_AzureDevOps.source.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
# Getting Started Wizard

[Home](/docs/wiz/readme.md) > [Linux](Linux.md) > [Other](Linux_Other.md) > [Prefer CLI](Linux_Other_Cli.md) > [TUnit](Linux_Other_Cli_TUnit.md) > Azure DevOps

## Add NuGet packages

Add the following packages to the test project:

```
dotnet add package TUnit
dotnet add package Verify.TUnit
```

## Implicit Usings

include: implicit-usings


## Conventions


### Source Control Includes/Excludes

include: include-exclude


### Text file settings

include: text-file-settings


### Conventions check

Conventions can be checked by calling `VerifyChecks.Run()` in a test

snippet: VerifyChecksTUnit

## DiffPlex

The text comparison behavior of Verify is pluggable. The default behaviour, on failure, is to output both the received
and the verified contents as part of the exception. This can be noisy when verifying large strings.

[Verify.DiffPlex](https://github.com/VerifyTests/Verify.DiffPlex) changes the text compare result to highlighting text differences inline.

This is optional, but recommended.

### Add the NuGet

```
dotnet add package Verify.DiffPlex
```

### Enable

```cs
[ModuleInitializer]
public static void Initialize() =>
VerifyDiffPlex.Initialize();
```

## Verify.Terminal

[Verify.Terminal](https://github.com/VerifyTests/Verify.Terminal) is a dotnet tool for managing snapshots from the command line.

This is optional.

### Install the tool

```
dotnet tool install -g verify.tool
```


## Sample Test

snippet: SampleTestTUnit

## Diff Tool

Verify supports many [Diff Tools](https://github.com/VerifyTests/DiffEngine/blob/main/docs/diff-tool.md#supported-tools) for comparing received to verified.
While IDEs are supported, due to their MDI nature, using a different Diff Tool is recommended.

Tools supported by Linux:

* [BeyondCompare](https://www.scootersoftware.com)
* [P4Merge](https://www.perforce.com/products/helix-core-apps/merge-diff-tool-p4merge)
* [Rider](https://www.jetbrains.com/rider/)
* [Neovim](https://neovim.io/)

## Getting .received in output on Azure DevOps

include: build-server-azuredevops

93 changes: 93 additions & 0 deletions docs/mdsource/wiz/Linux_Other_Cli_TUnit_GitHubActions.source.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,93 @@
# Getting Started Wizard

[Home](/docs/wiz/readme.md) > [Linux](Linux.md) > [Other](Linux_Other.md) > [Prefer CLI](Linux_Other_Cli.md) > [TUnit](Linux_Other_Cli_TUnit.md) > GitHub Actions

## Add NuGet packages

Add the following packages to the test project:

```
dotnet add package TUnit
dotnet add package Verify.TUnit
```

## Implicit Usings

include: implicit-usings


## Conventions


### Source Control Includes/Excludes

include: include-exclude


### Text file settings

include: text-file-settings


### Conventions check

Conventions can be checked by calling `VerifyChecks.Run()` in a test

snippet: VerifyChecksTUnit

## DiffPlex

The text comparison behavior of Verify is pluggable. The default behaviour, on failure, is to output both the received
and the verified contents as part of the exception. This can be noisy when verifying large strings.

[Verify.DiffPlex](https://github.com/VerifyTests/Verify.DiffPlex) changes the text compare result to highlighting text differences inline.

This is optional, but recommended.

### Add the NuGet

```
dotnet add package Verify.DiffPlex
```

### Enable

```cs
[ModuleInitializer]
public static void Initialize() =>
VerifyDiffPlex.Initialize();
```

## Verify.Terminal

[Verify.Terminal](https://github.com/VerifyTests/Verify.Terminal) is a dotnet tool for managing snapshots from the command line.

This is optional.

### Install the tool

```
dotnet tool install -g verify.tool
```


## Sample Test

snippet: SampleTestTUnit

## Diff Tool

Verify supports many [Diff Tools](https://github.com/VerifyTests/DiffEngine/blob/main/docs/diff-tool.md#supported-tools) for comparing received to verified.
While IDEs are supported, due to their MDI nature, using a different Diff Tool is recommended.

Tools supported by Linux:

* [BeyondCompare](https://www.scootersoftware.com)
* [P4Merge](https://www.perforce.com/products/helix-core-apps/merge-diff-tool-p4merge)
* [Rider](https://www.jetbrains.com/rider/)
* [Neovim](https://neovim.io/)

## Getting .received in output on GitHub Actions

include: build-server-githubactions

89 changes: 89 additions & 0 deletions docs/mdsource/wiz/Linux_Other_Cli_TUnit_None.source.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
# Getting Started Wizard

[Home](/docs/wiz/readme.md) > [Linux](Linux.md) > [Other](Linux_Other.md) > [Prefer CLI](Linux_Other_Cli.md) > [TUnit](Linux_Other_Cli_TUnit.md) > No build server

## Add NuGet packages

Add the following packages to the test project:

```
dotnet add package TUnit
dotnet add package Verify.TUnit
```

## Implicit Usings

include: implicit-usings


## Conventions


### Source Control Includes/Excludes

include: include-exclude


### Text file settings

include: text-file-settings


### Conventions check

Conventions can be checked by calling `VerifyChecks.Run()` in a test

snippet: VerifyChecksTUnit

## DiffPlex

The text comparison behavior of Verify is pluggable. The default behaviour, on failure, is to output both the received
and the verified contents as part of the exception. This can be noisy when verifying large strings.

[Verify.DiffPlex](https://github.com/VerifyTests/Verify.DiffPlex) changes the text compare result to highlighting text differences inline.

This is optional, but recommended.

### Add the NuGet

```
dotnet add package Verify.DiffPlex
```

### Enable

```cs
[ModuleInitializer]
public static void Initialize() =>
VerifyDiffPlex.Initialize();
```

## Verify.Terminal

[Verify.Terminal](https://github.com/VerifyTests/Verify.Terminal) is a dotnet tool for managing snapshots from the command line.

This is optional.

### Install the tool

```
dotnet tool install -g verify.tool
```


## Sample Test

snippet: SampleTestTUnit

## Diff Tool

Verify supports many [Diff Tools](https://github.com/VerifyTests/DiffEngine/blob/main/docs/diff-tool.md#supported-tools) for comparing received to verified.
While IDEs are supported, due to their MDI nature, using a different Diff Tool is recommended.

Tools supported by Linux:

* [BeyondCompare](https://www.scootersoftware.com)
* [P4Merge](https://www.perforce.com/products/helix-core-apps/merge-diff-tool-p4merge)
* [Rider](https://www.jetbrains.com/rider/)
* [Neovim](https://neovim.io/)

1 change: 1 addition & 0 deletions docs/mdsource/wiz/Linux_Other_Gui.source.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ Options:
* [Xunit](Linux_Other_Gui_Xunit.md)
* [XunitV3](Linux_Other_Gui_XunitV3.md)
* [NUnit](Linux_Other_Gui_NUnit.md)
* [TUnit](Linux_Other_Gui_TUnit.md)
* [Fixie](Linux_Other_Gui_Fixie.md)
* [MSTest](Linux_Other_Gui_MSTest.md)
* [Expecto](Linux_Other_Gui_Expecto.md)
Loading

0 comments on commit 6b95193

Please sign in to comment.