-
-
Notifications
You must be signed in to change notification settings - Fork 140
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
71f3887
commit 6b95193
Showing
394 changed files
with
22,466 additions
and
198 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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
93
docs/mdsource/wiz/Linux_Other_Cli_TUnit_AppVeyor.source.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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
93
docs/mdsource/wiz/Linux_Other_Cli_TUnit_AzureDevOps.source.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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
93
docs/mdsource/wiz/Linux_Other_Cli_TUnit_GitHubActions.source.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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 | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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/) | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.