Skip to content

Commit

Permalink
Bump MarkdownSnippets.MsBuild from 19.1.3 to 19.1.4 (#185)
Browse files Browse the repository at this point in the history
* Bump MarkdownSnippets.MsBuild from 19.1.3 to 19.1.4

Bumps [MarkdownSnippets.MsBuild](https://github.com/SimonCropp/MarkdownSnippets) from 19.1.3 to 19.1.4.
- [Release notes](https://github.com/SimonCropp/MarkdownSnippets/releases)
- [Commits](SimonCropp/MarkdownSnippets@19.1.3...19.1.4)

Signed-off-by: dependabot-preview[bot] <support@dependabot.com>

* Docs changes

Co-authored-by: dependabot-preview[bot] <27856297+dependabot-preview[bot]@users.noreply.github.com>
Co-authored-by: GitHub Action <action@github.com>
  • Loading branch information
dependabot-preview[bot] and actions-user authored Aug 6, 2020
1 parent 4408051 commit b643fc7
Show file tree
Hide file tree
Showing 14 changed files with 100 additions and 100 deletions.
8 changes: 4 additions & 4 deletions docs/anonymous-types.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ When validating multiple instances, an [anonymous type](https://docs.microsoft.c
## xUnit

<!-- snippet: anonXunit -->
<a id='snippet-anonxunit'/></a>
<a id='snippet-anonxunit'></a>
```cs
[Fact]
public async Task Anon()
Expand Down Expand Up @@ -44,7 +44,7 @@ public async Task Anon()
## NUnit

<!-- snippet: anonNUnit -->
<a id='snippet-anonnunit'/></a>
<a id='snippet-anonnunit'></a>
```cs
[Test]
public async Task Anon()
Expand Down Expand Up @@ -75,7 +75,7 @@ public async Task Anon()
## MSTest

<!-- snippet: anonMSTest -->
<a id='snippet-anonmstest'/></a>
<a id='snippet-anonmstest'></a>
```cs
[TestMethod]
public async Task Anon()
Expand Down Expand Up @@ -108,7 +108,7 @@ public async Task Anon()
Results in the following:

<!-- snippet: Verify.Xunit.Tests/VerifyObjectSamples.Anon.verified.txt -->
<a id='snippet-Verify.Xunit.Tests/VerifyObjectSamples.Anon.verified.txt'/></a>
<a id='snippet-Verify.Xunit.Tests/VerifyObjectSamples.Anon.verified.txt'></a>
```txt
{
person1: {
Expand Down
4 changes: 2 additions & 2 deletions docs/build-server.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ To change this file edit the source file and then run MarkdownSnippets.
Use an [on_failure build step](https://www.appveyor.com/docs/build-configuration/#build-pipeline) to call [Push-AppveyorArtifact](https://www.appveyor.com/docs/build-worker-api/#push-artifact).

<!-- snippet: AppVeyorArtifacts -->
<a id='snippet-appveyorartifacts'/></a>
<a id='snippet-appveyorartifacts'></a>
```yml
on_failure:
- ps: Get-ChildItem *.received.* -recurse | % { Push-AppveyorArtifact $_.FullName -FileName $_.Name }
Expand All @@ -38,7 +38,7 @@ In some scenarios, as part of a build, the test assemblies are copied to a diffe
For example a possible implementation for [AppVeyor](https://www.appveyor.com/) could be:

<!-- snippet: DeriveTestDirectory -->
<a id='snippet-derivetestdirectory'/></a>
<a id='snippet-derivetestdirectory'></a>
```cs
if (BuildServerDetector.Detected)
{
Expand Down
6 changes: 3 additions & 3 deletions docs/clipboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ The clipboard behavior can be disable using the following:
### Per Test

<!-- snippet: DisableClipboard -->
<a id='snippet-disableclipboard'/></a>
<a id='snippet-disableclipboard'></a>
```cs
var settings = new VerifySettings();
settings.DisableClipboard();
Expand All @@ -73,7 +73,7 @@ settings.DisableClipboard();
### For all tests

<!-- snippet: DisableClipboardGlobal -->
<a id='snippet-disableclipboardglobal'/></a>
<a id='snippet-disableclipboardglobal'></a>
```cs
VerifierSettings.DisableClipboard();
```
Expand All @@ -83,7 +83,7 @@ VerifierSettings.DisableClipboard();
If clipboard is disabled for all tests, it can be re-enabled at the test level:

<!-- snippet: EnableClipboard -->
<a id='snippet-enableclipboard'/></a>
<a id='snippet-enableclipboard'></a>
```cs
var settings = new VerifySettings();
settings.EnableClipboard();
Expand Down
6 changes: 3 additions & 3 deletions docs/compared-to-assertion.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ Given the following method:
### Class being tested

<!-- snippet: ClassBeingTested -->
<a id='snippet-classbeingtested'/></a>
<a id='snippet-classbeingtested'></a>
```cs
public static class ClassBeingTested
{
Expand Down Expand Up @@ -65,7 +65,7 @@ Compare a traditional assertion based test to a verification test.
#### Traditional assertion test:

<!-- snippet: TraditionalTest -->
<a id='snippet-traditionaltest'/></a>
<a id='snippet-traditionaltest'></a>
```cs
[Fact]
public void TraditionalTest()
Expand All @@ -90,7 +90,7 @@ public void TraditionalTest()
#### Verification test

<!-- snippet: VerificationTest -->
<a id='snippet-verificationtest'/></a>
<a id='snippet-verificationtest'></a>
```cs
[Fact]
public Task Simple()
Expand Down
8 changes: 4 additions & 4 deletions docs/comparer.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Using a custom comparer can be helpful when a result has changed, but not enough
For samples purposes an image difference hash algorithm from the [ImageHash project](https://github.com/pgrho/phash) will be used:

<!-- snippet: ImageComparer -->
<a id='snippet-imagecomparer'/></a>
<a id='snippet-imagecomparer'></a>
```cs
static Task<CompareResult> CompareImages(
VerifySettings settings,
Expand Down Expand Up @@ -53,7 +53,7 @@ The returned `CompareResult.NotEqual` takes an optional message that will be ren
### Instance comparer

<!-- snippet: InstanceComparer -->
<a id='snippet-instancecomparer'/></a>
<a id='snippet-instancecomparer'></a>
```cs
var settings = new VerifySettings();
settings.UseComparer(CompareImages);
Expand All @@ -67,7 +67,7 @@ await Verifier.Verify("TheImage.png", settings);
### Static comparer

<!-- snippet: StaticComparer -->
<a id='snippet-staticcomparer'/></a>
<a id='snippet-staticcomparer'></a>
```cs
VerifierSettings.RegisterComparer(
extension: "png",
Expand All @@ -81,7 +81,7 @@ await Verifier.VerifyFile("TheImage.png");
## Default Comparison

<!-- snippet: DefualtCompare -->
<a id='snippet-defualtcompare'/></a>
<a id='snippet-defualtcompare'></a>
```cs
static async Task<CompareResult> StreamsAreEqual(Stream stream1, Stream stream2)
{
Expand Down
14 changes: 7 additions & 7 deletions docs/converter.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ Both the following examples take an input tiff and convert it to:
The info file:

<!-- snippet: ConverterSnippets.Type.info.verified.txt -->
<a id='snippet-ConverterSnippets.Type.info.verified.txt'/></a>
<a id='snippet-ConverterSnippets.Type.info.verified.txt'></a>
```txt
{
PixelFormat: 'Format8bppIndexed',
Expand All @@ -49,7 +49,7 @@ Multiple png files:
This sample uses a typed approach. So the converter acts on an in memory instance matching based on type.

<!-- snippet: RegisterFileConverterType -->
<a id='snippet-registerfileconvertertype'/></a>
<a id='snippet-registerfileconvertertype'></a>
```cs
VerifierSettings.RegisterFileConverter<Image>(
canConvert: (target, settings) => Equals(target.RawFormat, ImageFormat.Tiff),
Expand Down Expand Up @@ -80,7 +80,7 @@ VerifierSettings.RegisterFileConverter<Image>(
<!-- endsnippet -->

<!-- snippet: FileConverterTypeVerify -->
<a id='snippet-fileconvertertypeverify'/></a>
<a id='snippet-fileconvertertypeverify'></a>
```cs
await using var stream = File.OpenRead("sample.tif");
await Verifier.Verify(Image.FromStream(stream));
Expand All @@ -91,7 +91,7 @@ await Verifier.Verify(Image.FromStream(stream));
Note that this sample also uses the optional `canConvert` to ensure that only `Image`s that are tiffs are converted.

<!-- snippet: ConverterCanConvert -->
<a id='snippet-convertercanconvert'/></a>
<a id='snippet-convertercanconvert'></a>
```cs
canConvert: (target, settings) => Equals(target.RawFormat, ImageFormat.Tiff),
```
Expand All @@ -104,7 +104,7 @@ canConvert: (target, settings) => Equals(target.RawFormat, ImageFormat.Tiff),
This sample uses a extension approach. So the converter acts on a file or stream based on the extension (configured or detected).

<!-- snippet: RegisterFileConverterExtension -->
<a id='snippet-registerfileconverterextension'/></a>
<a id='snippet-registerfileconverterextension'></a>
```cs
VerifierSettings.RegisterFileConverter(
fromExtension: "tif",
Expand Down Expand Up @@ -136,7 +136,7 @@ VerifierSettings.RegisterFileConverter(
<!-- endsnippet -->

<!-- snippet: FileConverterExtensionVerify -->
<a id='snippet-fileconverterextensionverify'/></a>
<a id='snippet-fileconverterextensionverify'></a>
```cs
await Verifier.VerifyFile("sample.tif");
```
Expand All @@ -149,7 +149,7 @@ await Verifier.VerifyFile("sample.tif");
If cleanup needs to occur after verification a callback can be passes to `ConversionResult`:

<!-- snippet: ConversionResultWithCleanup -->
<a id='snippet-conversionresultwithcleanup'/></a>
<a id='snippet-conversionresultwithcleanup'></a>
```cs
return new ConversionResult(
info: info,
Expand Down
6 changes: 3 additions & 3 deletions docs/named-tuples.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ Due to the use of [ITuple](https://docs.microsoft.com/en-us/dotnet/api/system.ru
Given a method that returns a named tuple:

<!-- snippet: MethodWithNamedTuple -->
<a id='snippet-methodwithnamedtuple'/></a>
<a id='snippet-methodwithnamedtuple'></a>
```cs
static (bool Member1, string Member2, string Member3) MethodWithNamedTuple()
{
Expand All @@ -27,7 +27,7 @@ static (bool Member1, string Member2, string Member3) MethodWithNamedTuple()
Can be verified:

<!-- snippet: VerifyTuple -->
<a id='snippet-verifytuple'/></a>
<a id='snippet-verifytuple'></a>
```cs
await Verifier.Verify(() => MethodWithNamedTuple());
```
Expand All @@ -37,7 +37,7 @@ await Verifier.Verify(() => MethodWithNamedTuple());
Resulting in:

<!-- snippet: SerializationTests.NamedTuple.verified.txt -->
<a id='snippet-SerializationTests.NamedTuple.verified.txt'/></a>
<a id='snippet-SerializationTests.NamedTuple.verified.txt'></a>
```txt
{
Member1: true,
Expand Down
18 changes: 9 additions & 9 deletions docs/naming.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ UniqueFor allows for one or more delimiters to be added to the file name.
### XUnit

<!-- snippet: UniqueForSampleXunit -->
<a id='snippet-uniqueforsamplexunit'/></a>
<a id='snippet-uniqueforsamplexunit'></a>
```cs
using static VerifyXunit.Verifier;

Expand Down Expand Up @@ -67,7 +67,7 @@ public class UniqueForSample
### NUnit

<!-- snippet: UniqueForSampleNUnit -->
<a id='snippet-uniqueforsamplenunit'/></a>
<a id='snippet-uniqueforsamplenunit'></a>
```cs
using static VerifyNUnit.Verifier;

Expand Down Expand Up @@ -106,7 +106,7 @@ public class UniqueForSample
### MSTest

<!-- snippet: UniqueForSampleMSTest -->
<a id='snippet-uniqueforsamplemstest'/></a>
<a id='snippet-uniqueforsamplemstest'></a>
```cs
[TestClass]
public class UniqueForSample :
Expand Down Expand Up @@ -171,7 +171,7 @@ It can be overridden at two levels:
Usage:

<!-- snippet: ExtensionSample.cs -->
<a id='snippet-ExtensionSample.cs'/></a>
<a id='snippet-ExtensionSample.cs'></a>
```cs
using System.Threading.Tasks;
using Microsoft.VisualStudio.TestTools.UnitTesting;
Expand Down Expand Up @@ -218,7 +218,7 @@ public class ExtensionSample :
}
```
<sup><a href='/src/Verify.MSTest.Tests/Snippets/ExtensionSample.cs#L1-L43' title='File snippet `ExtensionSample.cs` was extracted from'>snippet source</a> | <a href='#snippet-ExtensionSample.cs' title='Navigate to start of snippet `ExtensionSample.cs`'>anchor</a></sup>
<a id='snippet-ExtensionSample.cs-1'/></a>
<a id='snippet-ExtensionSample.cs-1'></a>
```cs
using System.Threading.Tasks;
using NUnit.Framework;
Expand Down Expand Up @@ -264,7 +264,7 @@ public class ExtensionSample
}
```
<sup><a href='/src/Verify.NUnit.Tests/Snippets/ExtensionSample.cs#L1-L42' title='File snippet `ExtensionSample.cs` was extracted from'>snippet source</a> | <a href='#snippet-ExtensionSample.cs-1' title='Navigate to start of snippet `ExtensionSample.cs`'>anchor</a></sup>
<a id='snippet-ExtensionSample.cs-2'/></a>
<a id='snippet-ExtensionSample.cs-2'></a>
```cs
using System.Threading.Tasks;
using VerifyTests;
Expand Down Expand Up @@ -316,7 +316,7 @@ public class ExtensionSample
Result in two files:

<!-- snippet: Verify.Xunit.Tests/Snippets/ExtensionSample.SharedClassLevelSettings.verified.json -->
<a id='snippet-Verify.Xunit.Tests/Snippets/ExtensionSample.SharedClassLevelSettings.verified.json'/></a>
<a id='snippet-Verify.Xunit.Tests/Snippets/ExtensionSample.SharedClassLevelSettings.verified.json'></a>
```json
{
"fruit": "Apple",
Expand All @@ -328,7 +328,7 @@ Result in two files:
<!-- endsnippet -->

<!-- snippet: Verify.Xunit.Tests/Snippets/ExtensionSample.AtMethod.verified.xml -->
<a id='snippet-Verify.Xunit.Tests/Snippets/ExtensionSample.AtMethod.verified.xml'/></a>
<a id='snippet-Verify.Xunit.Tests/Snippets/ExtensionSample.AtMethod.verified.xml'></a>
```xml
<note>
<to>Joe</to>
Expand All @@ -345,7 +345,7 @@ Result in two files:
To access the current Namer `Runtime` or `RuntimeAndVersion` strings use:

<!-- snippet: AccessNamerRuntimeAndVersion -->
<a id='snippet-accessnamerruntimeandversion'/></a>
<a id='snippet-accessnamerruntimeandversion'></a>
```cs
Debug.WriteLine(Namer.Runtime);
Debug.WriteLine(Namer.RuntimeAndVersion);
Expand Down
10 changes: 5 additions & 5 deletions docs/parameterised.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ A test with two parameters `param1` + `param2`, and called twice with the values
### InlineData

<!-- snippet: xunitInlineData -->
<a id='snippet-xunitinlinedata'/></a>
<a id='snippet-xunitinlinedata'></a>
```cs
[Theory]
[InlineData("Value1")]
Expand All @@ -45,7 +45,7 @@ public Task InlineDataUsage(string arg)
### MemberData

<!-- snippet: xunitMemberData -->
<a id='snippet-xunitmemberdata'/></a>
<a id='snippet-xunitmemberdata'></a>
```cs
[Theory]
[MemberData(nameof(GetData))]
Expand All @@ -71,7 +71,7 @@ public static IEnumerable<object[]> GetData()
xUnit only exposes parameter information when the types certain types. For unknown types the parameter information cannot be retrieved from the xUnit context, and instead the parameters need to be explicitly passed in. This is done by calling `UseParameters()` on the base class.

<!-- snippet: xunitComplexMemberData -->
<a id='snippet-xunitcomplexmemberdata'/></a>
<a id='snippet-xunitcomplexmemberdata'></a>
```cs
[UsesVerify]
public class ComplexParametersSample
Expand Down Expand Up @@ -121,7 +121,7 @@ public class ComplexParametersSample
### TestCase

<!-- snippet: NUnitTestCase -->
<a id='snippet-nunittestcase'/></a>
<a id='snippet-nunittestcase'></a>
```cs
[TestCase("Value1")]
[TestCase("Value2")]
Expand All @@ -142,7 +142,7 @@ MSTest does not expose the parameter values via its extensibility context. So pa
### DataRow

<!-- snippet: MSTestDataRow -->
<a id='snippet-mstestdatarow'/></a>
<a id='snippet-mstestdatarow'></a>
```cs
[DataTestMethod]
[DataRow("Value1")]
Expand Down
Loading

0 comments on commit b643fc7

Please sign in to comment.