Move snippets to src folder

martintmk · martintmk · commit 2500d3cff316 · 2023-09-04T12:01:58.000+02:00
diff --git a/.github/workflows/on-push-do-docs.yml b/.github/workflows/on-push-do-docs.yml
@@ -3,7 +3,7 @@ name: on-push-do-docs
 on:
   push:
     branches: [main]
-    paths: [ "samples/Snippets/**" ]
+    paths: [ "src/Snippets/**" ]
   workflow_dispatch:
 
 permissions:
diff --git a/Polly.sln b/Polly.sln
@@ -56,6 +56,8 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Polly.Testing", "src\Polly.
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Polly.Testing.Tests", "test\Polly.Testing.Tests\Polly.Testing.Tests.csproj", "{D333B5CE-982D-4C11-BDAF-4217AA02306E}"
 EndProject
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Snippets", "src\Snippets\Snippets.csproj", "{D812B941-79B0-4E1E-BB70-4FAE345B5234}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -114,6 +116,10 @@ Global
 		{D333B5CE-982D-4C11-BDAF-4217AA02306E}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{D333B5CE-982D-4C11-BDAF-4217AA02306E}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{D333B5CE-982D-4C11-BDAF-4217AA02306E}.Release|Any CPU.Build.0 = Release|Any CPU
+		{D812B941-79B0-4E1E-BB70-4FAE345B5234}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{D812B941-79B0-4E1E-BB70-4FAE345B5234}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{D812B941-79B0-4E1E-BB70-4FAE345B5234}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{D812B941-79B0-4E1E-BB70-4FAE345B5234}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -133,6 +139,7 @@ Global
 		{C04DEE61-C1EA-4028-B457-CDBD304B8ED9} = {A6CC41B9-E0B9-44F8-916B-3E4A78DA3BFB}
 		{9AD2D6AD-56E4-49D6-B6F1-EE975D5760B9} = {B7BF406B-B06F-4025-83E6-7219C53196A6}
 		{D333B5CE-982D-4C11-BDAF-4217AA02306E} = {A6CC41B9-E0B9-44F8-916B-3E4A78DA3BFB}
+		{D812B941-79B0-4E1E-BB70-4FAE345B5234} = {B7BF406B-B06F-4025-83E6-7219C53196A6}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {2E5D54CD-770A-4345-B585-1848FC2EA6F4}
diff --git a/mdsnippets.json b/mdsnippets.json
@@ -1,7 +1,7 @@
 {
     "$schema": "https://raw.githubusercontent.com/SimonCropp/MarkdownSnippets/main/schema.json",
     "ExcludeDirectories": [ "test", "artifacts", "bench", "eng" ],
-    "ExcludeSnippetDirectories": [ "src", "artifacts", "test" ],
+    "ExcludeSnippetDirectories": [ "src/Polly", "src/Polly.Core", "src/Polly.RateLimiting", "src/Polly.Testing", "src/Polly.Extensions", "artifacts", "test" ],
     "OmitSnippetLinks": true,
     "Convention": "InPlaceOverwrite"
   }
diff --git a/samples/README.md b/samples/README.md
@@ -7,6 +7,5 @@ This repository contains a solution with basic examples demonstrating the creati
 - [`Retries`](./Retries) - This part explains how to configure a retry resilience strategy.
 - [`Extensibility`](./Extensibility) - In this part, you can learn how Polly can be extended with custom resilience strategies.
 - [`DependencyInjection`](./DependencyInjection) - This section demonstrates the integration of Polly with `IServiceCollection`.
-- [`Snippets`](./Snippets) - Various code-snippets that are referenced in the documentation.
 
 These examples are designed as a quick-start guide to Polly. If you wish to explore more advanced scenarios and further enhance your learning, consider visiting the [Polly-Samples](https://github.com/App-vNext/Polly-Samples) repository.
diff --git a/samples/Samples.sln b/samples/Samples.sln
@@ -20,8 +20,6 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Retries", "Retries\Retries.
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "DependencyInjection", "DependencyInjection\DependencyInjection.csproj", "{9B8BFE03-4457-4C55-91AD-4096DDE622C3}"
 EndProject
-Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Snippets", "Snippets\Snippets.csproj", "{E112D575-A3CD-41DA-8BE9-9D9C5A008F7D}"
-EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -48,10 +46,6 @@ Global
 		{9B8BFE03-4457-4C55-91AD-4096DDE622C3}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{9B8BFE03-4457-4C55-91AD-4096DDE622C3}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{9B8BFE03-4457-4C55-91AD-4096DDE622C3}.Release|Any CPU.Build.0 = Release|Any CPU
-		{E112D575-A3CD-41DA-8BE9-9D9C5A008F7D}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
-		{E112D575-A3CD-41DA-8BE9-9D9C5A008F7D}.Debug|Any CPU.Build.0 = Debug|Any CPU
-		{E112D575-A3CD-41DA-8BE9-9D9C5A008F7D}.Release|Any CPU.ActiveCfg = Release|Any CPU
-		{E112D575-A3CD-41DA-8BE9-9D9C5A008F7D}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
diff --git a/samples/Snippets/Program.cs b/samples/Snippets/Program.cs
diff --git a/samples/Snippets/Snippets.csproj b/samples/Snippets/Snippets.csproj
diff --git a/src/Polly.Core/README.md b/src/Polly.Core/README.md
@@ -220,7 +220,6 @@ Below are some examples illustrating the usage of these delegates:
 new ResiliencePipelineBuilder()
     .AddRetry(new RetryStrategyOptions
     {
-
         // Non-Generic predicate for multiple result types
         ShouldHandle = args => args.Outcome switch
         {
diff --git a/src/Polly.Extensions/README.md b/src/Polly.Extensions/README.md
@@ -31,7 +31,7 @@ var pipelineProvider = serviceProvider.GetRequiredService<ResiliencePipelineProv
 var pipeline = pipelineProvider.GetPipeline("my-key");
 
 // Use it
-await pipeline.ExecuteAsync(async cancellation => await Task.Delay(100));
+await pipeline.ExecuteAsync(async cancellation => await Task.Delay(100, cancellation));
 ```
 <!-- endSnippet -->
 
@@ -44,10 +44,11 @@ Upon invoking the `ConfigureTelemetry` extension method, Polly begins to emit lo
 
 <!-- snippet: configure-telemetry -->
 ```cs
-var telemetryOptions = new TelemetryOptions();
-
-// Configure logging
-telemetryOptions.LoggerFactory = LoggerFactory.Create(builder => builder.AddConsole());
+var telemetryOptions = new TelemetryOptions
+{
+    // Configure logging
+    LoggerFactory = LoggerFactory.Create(builder => builder.AddConsole())
+};
 
 // Configure enrichers
 telemetryOptions.MeteringEnrichers.Add(new MyMeteringEnricher());
@@ -64,15 +65,15 @@ var builder = new ResiliencePipelineBuilder()
 
 <!-- snippet: telemetry-listeners -->
 ```cs
-class MyTelemetryListener : TelemetryListener
+internal class MyTelemetryListener : TelemetryListener
 {
     public override void Write<TResult, TArgs>(in TelemetryEventArguments<TResult, TArgs> args)
     {
         Console.WriteLine($"Telemetry event occurred: {args.Event.EventName}");
     }
 }
 
-class MyMeteringEnricher : MeteringEnricher
+internal class MyMeteringEnricher : MeteringEnricher
 {
     public override void Enrich<TResult, TArgs>(in EnrichmentContext<TResult, TArgs> context)
     {
@@ -89,7 +90,6 @@ Alternatively, you can use the `AddResiliencePipeline` extension which automatic
 var serviceCollection = new ServiceCollection()
     .AddLogging(builder => builder.AddConsole())
     .AddResiliencePipeline("my-strategy", builder => builder.AddTimeout(TimeSpan.FromSeconds(1)))
-    // Configure the default settings for TelemetryOptions
     .Configure<TelemetryOptions>(options =>
     {
         // Configure enrichers
diff --git a/src/Snippets/Core/Snippets.cs b/src/Snippets/Core/Snippets.cs
@@ -3,9 +3,6 @@
 
 namespace Snippets.Core;
 
-#pragma warning disable IDE0022 // Use expression body for method
-#pragma warning disable IDE0021 // Use expression body for constructor
-
 internal static class Snippets
 {
     public static void NonGenericPipeline()
@@ -89,7 +86,6 @@ public MyCustomStrategyOptions()
 
     #endregion
 
-
     #region my-custom-strategy
 
     internal class MyCustomStrategy : ResilienceStrategy
@@ -118,7 +114,6 @@ public static void DelegateUsage()
         new ResiliencePipelineBuilder()
             .AddRetry(new RetryStrategyOptions
             {
-
                 // Non-Generic predicate for multiple result types
                 ShouldHandle = args => args.Outcome switch
                 {
diff --git a/src/Snippets/Extensions/Snippets.cs b/src/Snippets/Extensions/Snippets.cs
@@ -1,24 +1,22 @@
-﻿using Microsoft.Extensions.Logging;
-using Polly.Telemetry;
+﻿using Microsoft.Extensions.DependencyInjection;
+using Microsoft.Extensions.Logging;
 using Polly;
-using Microsoft.Extensions.DependencyInjection;
-using Microsoft.Extensions.Options;
 using Polly.Registry;
+using Polly.Telemetry;
 
 namespace Snippets.Extensions;
 
-#pragma warning disable IDE0022 // Use expression body for method
-
 internal static class Snippets
 {
     public static void ConfigureTelemetry()
     {
         #region configure-telemetry
 
-        var telemetryOptions = new TelemetryOptions();
-
-        // Configure logging
-        telemetryOptions.LoggerFactory = LoggerFactory.Create(builder => builder.AddConsole());
+        var telemetryOptions = new TelemetryOptions
+        {
+            // Configure logging
+            LoggerFactory = LoggerFactory.Create(builder => builder.AddConsole())
+        };
 
         // Configure enrichers
         telemetryOptions.MeteringEnrichers.Add(new MyMeteringEnricher());
@@ -63,7 +61,7 @@ public static async Task AddResiliencePipeline()
         var pipeline = pipelineProvider.GetPipeline("my-key");
 
         // Use it
-        await pipeline.ExecuteAsync(async cancellation => await Task.Delay(100));
+        await pipeline.ExecuteAsync(async cancellation => await Task.Delay(100, cancellation));
 
         #endregion
     }
@@ -75,7 +73,6 @@ public static void AddResiliencePipelineWithTelemetry()
         var serviceCollection = new ServiceCollection()
             .AddLogging(builder => builder.AddConsole())
             .AddResiliencePipeline("my-strategy", builder => builder.AddTimeout(TimeSpan.FromSeconds(1)))
-            // Configure the default settings for TelemetryOptions
             .Configure<TelemetryOptions>(options =>
             {
                 // Configure enrichers
@@ -94,15 +91,15 @@ private class MyTimeoutOptions
 
     #region telemetry-listeners
 
-    class MyTelemetryListener : TelemetryListener
+    internal class MyTelemetryListener : TelemetryListener
     {
         public override void Write<TResult, TArgs>(in TelemetryEventArguments<TResult, TArgs> args)
         {
             Console.WriteLine($"Telemetry event occurred: {args.Event.EventName}");
         }
     }
 
-    class MyMeteringEnricher : MeteringEnricher
+    internal class MyMeteringEnricher : MeteringEnricher
     {
         public override void Enrich<TResult, TArgs>(in EnrichmentContext<TResult, TArgs> context)
         {
diff --git a/src/Snippets/README.md b/src/Snippets/README.md
@@ -0,0 +1,7 @@
+# Snippets
+
+Various code-snippets used in the Polly documentation. Run the following command in the root directory to update the snippets in the docs:
+
+```powershell
+dotnet mdsnippets
+```
diff --git a/src/Snippets/RateLimiting/Snippets.cs b/src/Snippets/RateLimiting/Snippets.cs
@@ -1,6 +1,6 @@
-﻿using Polly;
+﻿using System.Threading.RateLimiting;
+using Polly;
 using Polly.RateLimiting;
-using System.Threading.RateLimiting;
 
 namespace Snippets.RateLimiting;
 
diff --git a/src/Snippets/Snippets.csproj b/src/Snippets/Snippets.csproj
@@ -0,0 +1,26 @@
+﻿<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <OutputType>Library</OutputType>
+    <TargetFramework>net7.0</TargetFramework>
+    <ImplicitUsings>enable</ImplicitUsings>
+    <Nullable>enable</Nullable>
+    <ProjectType>Library</ProjectType>
+    <GenerateDocumentationFile>false</GenerateDocumentationFile>
+    <IsPackable>false</IsPackable>
+    <NoWarn>$(NoWarn);SA1123;SA1515;CA2000;CA2007;CA1303;IDE0021</NoWarn>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <PackageReference Include="Microsoft.Extensions.Logging.Console" />
+    <PackageReference Include="xunit" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\Polly.Extensions\Polly.Extensions.csproj" />
+    <ProjectReference Include="..\Polly.RateLimiting\Polly.RateLimiting.csproj" />
+    <ProjectReference Include="..\Polly.Testing\Polly.Testing.csproj" />
+  </ItemGroup>
+
+</Project>
+
diff --git a/src/Snippets/Testing/Snippets.cs b/src/Snippets/Testing/Snippets.cs
@@ -1,9 +1,9 @@
 ﻿using Microsoft.Extensions.Logging.Abstractions;
+using Polly;
 using Polly.Retry;
+using Polly.Testing;
 using Polly.Timeout;
-using Polly;
 using Xunit;
-using Polly.Testing;
 
 namespace Snippets.Testing;
 

Original file line number	Diff line number	Diff line change
`@@ -1,7 +1,7 @@`
`1`	`1`	`{`
`2`	`2`	`"$schema": "https://raw.githubusercontent.com/SimonCropp/MarkdownSnippets/main/schema.json",`
`3`	`3`	`"ExcludeDirectories": [ "test", "artifacts", "bench", "eng" ],`
`4`		`- "ExcludeSnippetDirectories": [ "src", "artifacts", "test" ],`
	`4`	`+ "ExcludeSnippetDirectories": [ "src/Polly", "src/Polly.Core", "src/Polly.RateLimiting", "src/Polly.Testing", "src/Polly.Extensions", "artifacts", "test" ],`
`5`	`5`	`"OmitSnippetLinks": true,`
`6`	`6`	`"Convention": "InPlaceOverwrite"`
`7`	`7`	`}`
Original file line number	Diff line number	Diff line change
`@@ -220,7 +220,6 @@ Below are some examples illustrating the usage of these delegates:`
`220`	`220`	`new ResiliencePipelineBuilder()`
`221`	`221`	`.AddRetry(new RetryStrategyOptions`
`222`	`222`	`{`
`223`		`-`
`224`	`223`	`// Non-Generic predicate for multiple result types`
`225`	`224`	`ShouldHandle = args => args.Outcome switch`
`226`	`225`	`{`
Original file line number	Diff line number	Diff line change
`@@ -3,9 +3,6 @@`
`3`	`3`
`4`	`4`	`namespace Snippets.Core;`
`5`	`5`
`6`		`-#pragma warning disable IDE0022 // Use expression body for method`
`7`		`-#pragma warning disable IDE0021 // Use expression body for constructor`
`8`		`-`
`9`	`6`	`internal static class Snippets`
`10`	`7`	`{`
`11`	`8`	`public static void NonGenericPipeline()`
`@@ -89,7 +86,6 @@ public MyCustomStrategyOptions()`
`89`	`86`
`90`	`87`	`#endregion`
`91`	`88`
`92`		`-`
`93`	`89`	`#region my-custom-strategy`
`94`	`90`
`95`	`91`	`internal class MyCustomStrategy : ResilienceStrategy`
`@@ -118,7 +114,6 @@ public static void DelegateUsage()`
`118`	`114`	`new ResiliencePipelineBuilder()`
`119`	`115`	`.AddRetry(new RetryStrategyOptions`
`120`	`116`	`{`
`121`		`-`
`122`	`117`	`// Non-Generic predicate for multiple result types`
`123`	`118`	`ShouldHandle = args => args.Outcome switch`
`124`	`119`	`{`