chore: add Prettier and csharpier action + formatting instructions, format files

.csharpierrc

@@ -0,0 +1 @@
+printWidth: 180

.github/ISSUE_TEMPLATE/bug_report.md

@@ -1,17 +1,16 @@
 ---
 name: Bug report
 about: Create a report to help us improve
-title: ''
+title: ""
 labels: bug
-assignees: ''
-
+assignees: ""
 ---
 
 **Describe the bug**
 
 **To Reproduce**
 
-1. 
+1.
 
 **Expected behavior**
 

.github/ISSUE_TEMPLATE/feature_request.md

@@ -1,10 +1,7 @@
 ---
 name: Feature request
 about: Suggest an idea for this project
-title: ''
+title: ""
 labels: enhancement
-assignees: ''
-
+assignees: ""
 ---
-
-

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,6 +1,5 @@
-*Issue #, if available:*
-
-*Description of changes:*
+_Issue #, if available:_
 
+_Description of changes:_
 
 By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

.github/workflows/dotnet.yml

@@ -4,7 +4,7 @@ on:
   push:
     branches: [master]
   pull_request:
-    branches: [master]
+    types: [opened, synchronize, ready_for_review]
 
 jobs:
   build:
@@ -16,23 +16,37 @@ jobs:
       - name: Install .NET
         uses: actions/setup-dotnet@v4
         with:
-          dotnet-version: |
-            8
+          dotnet-version: 8
+
+      - name: Check formatting with csharpier
+        run: |
+          dotnet tool install -g csharpier
+          csharpier check .
+
+      - name: Prettier
+        uses: rutajdash/[email protected]
+        with:
+          file_pattern: "**/*.{md,yml}"
+
       - name: Install .NET Framework (add MSBuild to Path)
         uses: microsoft/setup-msbuild@v2
         with:
           msbuild-architecture: x64
+
       - name: Restore dependencies
         run: dotnet restore
+
       - name: Build
         run: dotnet build --no-restore
+
       - name: Test
         # Strong name requires disabling xUnit app domains in order to get coverage using coverlet
         # https://github.com/MarcoRossignoli/coverlet/blob/master/Documentation/KnownIssues.md#tests-fail-if-assembly-is-strong-named
         run: dotnet test --no-build --verbosity normal --collect:"XPlat Code Coverage" test/Amazon.SecretsManager.Extensions.Caching.UnitTests -- RunConfiguration.DisableAppDomain=true
+
       - name: Codecov
         uses: codecov/codecov-action@v5
         with:
           directory: test/Amazon.SecretsManager.Extensions.Caching.UnitTests/TestResults
         env:
-          CODECOV_TOKEN: #{{ secrets.CODECOV_TOKEN }}
+          CODECOV_TOKEN: ${{ secrets.CODECOV_TOKEN }}

.prettierrc

@@ -0,0 +1 @@
+endOfLine: auto

CODE_OF_CONDUCT.md

@@ -1,4 +1,5 @@
 ## Code of Conduct
+
 This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
 For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
 [email protected] with any additional questions or comments.

CONTRIBUTING.md

@@ -6,53 +6,57 @@ documentation, we greatly value feedback and contributions from our community.
 Please read through this document before submitting any issues or pull requests to ensure we have all the necessary
 information to effectively respond to your bug report or contribution.
 
-
 ## Reporting Bugs/Feature Requests
 
 We welcome you to use the GitHub issue tracker to report bugs or suggest features.
 
 When filing an issue, please check [existing open](https://github.com/aws/aws-secretsmanager-caching-csharp/issues), or [recently closed](https://github.com/aws/aws-secretsmanager-caching-csharp/issues?utf8=%E2%9C%93&q=is%3Aissue%20is%3Aclosed%20), issues to make sure somebody else hasn't already
 reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
 
-* A reproducible test case or series of steps
-* The version of our code being used
-* Any modifications you've made relevant to the bug
-* Anything unusual about your environment or deployment
-
+- A reproducible test case or series of steps
+- The version of our code being used
+- Any modifications you've made relevant to the bug
+- Anything unusual about your environment or deployment
 
 ## Contributing via Pull Requests
+
 Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:
 
-1. You are working against the latest source on the *master* branch.
+1. You are working against the latest source on the _master_ branch.
 2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
 3. You open an issue to discuss any significant work - we would hate for your time to be wasted.
 
 To send us a pull request, please:
 
 1. Fork the repository.
 2. Modify the source; please focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to focus on your change.
-3. Ensure local tests pass.
-4. Commit to your fork using clear commit messages.
-5. Send us a pull request, answering any default questions in the pull request interface.
-6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
+3. Use csharpier to ensure consistent formatting for `.cs` files, and Prettier for `.md` and `.yml` files (see [Formatting instructions](#formatting-instructions)).
+4. Ensure local tests pass.
+5. Commit to your fork using clear commit messages.
+6. Send us a pull request, answering any default questions in the pull request interface.
+7. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
 
 GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
 [creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
 
+## Formatting instructions
+
+- Install [csharpier](https://csharpier.com/docs/Installation) and [Prettier](https://prettier.io/docs/install)
+- Run `csharpier format .` and `prettier --write **/*.{md,yml}`
 
 ## Finding contributions to work on
-Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any ['help wanted'](https://github.com/aws/aws-secretsmanager-caching-csharp/labels/help%20wanted) issues is a great place to start.
 
+Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any ['help wanted'](https://github.com/aws/aws-secretsmanager-caching-csharp/labels/help%20wanted) issues is a great place to start.
 
 ## Code of Conduct
+
 This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
 For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
 [email protected] with any additional questions or comments.
 
-
 ## Security issue notifications
-If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public github issue.
 
+If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public github issue.
 
 ## Licensing
 

README.md

@@ -1,7 +1,5 @@
 # AWS Secrets Manager Caching Client for .NET
 
-
-
 [![NuGet](https://img.shields.io/nuget/v/AWSSDK.SecretsManager.Caching)](https://www.nuget.org/packages/AWSSDK.SecretsManager.Caching)
 [![.NET](https://github.com/aws/aws-secretsmanager-caching-net/actions/workflows/dotnet.yml/badge.svg?event=push)](https://github.com/aws/aws-secretsmanager-caching-net/actions/workflows/dotnet.yml)
 [![codecov](https://codecov.io/gh/aws/aws-secretsmanager-caching-net/branch/master/graph/badge.svg?token=cugbEh31cw)](https://codecov.io/gh/aws/aws-secretsmanager-caching-net)
@@ -12,17 +10,16 @@ The AWS Secrets Manager caching client enables in-process caching of secrets for
 
 To use this client, you must have:
 
-* A .NET project with one of the following:
-    * .NET Framework 4.6.2 or higher
-    * .NET Standard 2.0 or higher
-
-* An Amazon Web Services (AWS) account to access secrets stored in AWS Secrets Manager and use AWS SDK for .NET.
+- A .NET project with one of the following:
+  - .NET Framework 4.6.2 or higher
+  - .NET Standard 2.0 or higher
 
-    * **To create an AWS account**, go to [Sign In or Create an AWS Account](https://portal.aws.amazon.com/gp/aws/developer/registration/index.html) and then choose **I am a new user.** Follow the instructions to create an AWS account.
+- An Amazon Web Services (AWS) account to access secrets stored in AWS Secrets Manager and use AWS SDK for .NET.
+  - **To create an AWS account**, go to [Sign In or Create an AWS Account](https://portal.aws.amazon.com/gp/aws/developer/registration/index.html) and then choose **I am a new user.** Follow the instructions to create an AWS account.
 
-    * **To create a secret in AWS Secrets Manager**, go to [Creating Secrets](https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_create-basic-secret.html) and follow the instructions on that page.
+  - **To create a secret in AWS Secrets Manager**, go to [Creating Secrets](https://docs.aws.amazon.com/secretsmanager/latest/userguide/manage_create-basic-secret.html) and follow the instructions on that page.
 
-    * **To download and install the AWS SDK for .NET**, go to [Installing the AWS SDK for .NET](https://aws.amazon.com/sdk-for-net/) in the AWS SDK for .NET documentation and then follow the instructions on that page.
+  - **To download and install the AWS SDK for .NET**, go to [Installing the AWS SDK for .NET](https://aws.amazon.com/sdk-for-net/) in the AWS SDK for .NET documentation and then follow the instructions on that page.
 
 ## Download
 
@@ -43,7 +40,7 @@ using System;
 using Amazon.SecretsManager.Extensions.Caching.SecretsManagerCache;
 
 namespace LambdaExample {
-    public class CachingExample 
+    public class CachingExample
     {
         private SecretsManagerCache cache = new SecretsManagerCache();
         private const String MySecretName = "MySecret";
@@ -57,24 +54,27 @@ namespace LambdaExample {
 }
 ```
 
-* After instantiating the cache, retrieve your secret using `GetSecretString` or `GetSecretBinary`. 
-* On successive retrievals, the cache will return the cached copy of the secret. 
-* Learn more about [AWS Lambda Function Handlers in C#](https://docs.aws.amazon.com/lambda/latest/dg/dotnet-programming-model-handler-types.html).
+- After instantiating the cache, retrieve your secret using `GetSecretString` or `GetSecretBinary`.
+- On successive retrievals, the cache will return the cached copy of the secret.
+- Learn more about [AWS Lambda Function Handlers in C#](https://docs.aws.amazon.com/lambda/latest/dg/dotnet-programming-model-handler-types.html).
 
 ### Cache Configuration
 
 You can configure the `SecretCacheConfiguration` object with the following parameters:
-* `CacheItemTTL` - The TTL of a Cache item in milliseconds. The default value is `3600000` ms, or 1 hour.
-* `MaxCacheSize` - The maximum number of items the Cache can contain before evicting using LRU. The default value is `1024`.
-* `VersionStage` - The Version Stage the Cache will request when retrieving secrets from Secrets Manager. The default value is `AWSCURRENT`.
-* `Client` - The Secrets Manager client to be used by the Cache. The default value is `null`, which causes the Cache to instantiate a new Secrets Manager client.
-* `CacheHook` - An implementation of the ISecretCacheHook interface. The default value is `null`.
+
+- `CacheItemTTL` - The TTL of a Cache item in milliseconds. The default value is `3600000` ms, or 1 hour.
+- `MaxCacheSize` - The maximum number of items the Cache can contain before evicting using LRU. The default value is `1024`.
+- `VersionStage` - The Version Stage the Cache will request when retrieving secrets from Secrets Manager. The default value is `AWSCURRENT`.
+- `Client` - The Secrets Manager client to be used by the Cache. The default value is `null`, which causes the Cache to instantiate a new Secrets Manager client.
+- `CacheHook` - An implementation of the ISecretCacheHook interface. The default value is `null`.
 
 ## Getting Help
+
 We use GitHub issues for tracking bugs and caching library feature requests and have limited bandwidth to address them. Please use these community resources for getting help:
-* Ask a question on [Stack Overflow](https://stackoverflow.com/) and tag it with [aws-secrets-manager](https://stackoverflow.com/questions/tagged/aws-secrets-manager).
-* Open a support ticket with [AWS Support](https://console.aws.amazon.com/support/home#/).
-* If it turns out that you may have found a bug, please [open an issue](https://github.com/aws/aws-secretsmanager-caching-csharp/issues/new). 
+
+- Ask a question on [Stack Overflow](https://stackoverflow.com/) and tag it with [aws-secrets-manager](https://stackoverflow.com/questions/tagged/aws-secrets-manager).
+- Open a support ticket with [AWS Support](https://console.aws.amazon.com/support/home#/).
+- If it turns out that you may have found a bug, please [open an issue](https://github.com/aws/aws-secretsmanager-caching-csharp/issues/new).
 
 ## License
 

buildspec.yml

@@ -8,6 +8,6 @@ phases:
       - dotnet test -c Release --no-build
       - dotnet pack -c Release --no-build
 artifacts:
-  base-directory: 'src/Amazon.SecretsManager.Extensions.Caching/bin'
+  base-directory: "src/Amazon.SecretsManager.Extensions.Caching/bin"
   files:
-    - 'Release/AWSSDK.SecretsManager.Caching.*.nupkg'
+    - "Release/AWSSDK.SecretsManager.Caching.*.nupkg"

src/Amazon.SecretsManager.Extensions.Caching/Amazon.SecretsManager.Extensions.Caching.csproj

@@ -1,32 +1,30 @@
 <Project Sdk="Microsoft.NET.Sdk">
-
-    <PropertyGroup>
-        <TargetFramework>netstandard2.0</TargetFramework>
-        <GenerateDocumentationFile>true</GenerateDocumentationFile>
-        <CodeAnalysisRuleSet>..\..\code-analysis.ruleset</CodeAnalysisRuleSet>
-        <OutputType>Library</OutputType>
-        <DisableImplicitNamespaceImports>true</DisableImplicitNamespaceImports>
-        <PackageId>AWSSDK.SecretsManager.Caching</PackageId>
-        <PackageVersion>2.0.0</PackageVersion>
-        <Title>AWS Secrets Manager Caching for .NET</Title>
-        <Authors>Amazon Web Services</Authors>
-        <Description>The AWS Secrets Manager .NET caching client enables in-process caching of secrets for .NET applications.</Description>
-        <Copyright>Amazon Web Services</Copyright>
-        <PackageProjectUrl>https://github.com/aws/aws-secretsmanager-caching-net</PackageProjectUrl>
-        <PackageLicenseExpression>Apache-2.0</PackageLicenseExpression>
-        <PackageIconUrl>https://sdk-for-net.amazonwebservices.com/images/AWSLogo128x128.png</PackageIconUrl>
-        <RepositoryUrl>https://github.com/aws/aws-secretsmanager-caching-net</RepositoryUrl>
-        <PackageTags>AWS;Amazon;cloud;aws-sdk-v3;secrets;secret manager;secretsmanager;caching;cache</PackageTags>
-        <SignAssembly>true</SignAssembly>
-        <AssemblyOriginatorKeyFile>..\..\aws-secretsmanager-caching-net.snk</AssemblyOriginatorKeyFile>
-    </PropertyGroup>
-
-    <ItemGroup>
-        <PackageReference Include="AWSSDK.SecretsManager" Version="4.*" />
-        <PackageReference Include="Microsoft.Extensions.Caching.Memory" Version="8.*" />
-        <PackageReference Include="StyleCop.Analyzers" Version="1.*">
-            <PrivateAssets>all</PrivateAssets>
-            <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
-        </PackageReference>
-    </ItemGroup>
+  <PropertyGroup>
+    <TargetFramework>netstandard2.0</TargetFramework>
+    <GenerateDocumentationFile>true</GenerateDocumentationFile>
+    <CodeAnalysisRuleSet>..\..\code-analysis.ruleset</CodeAnalysisRuleSet>
+    <OutputType>Library</OutputType>
+    <DisableImplicitNamespaceImports>true</DisableImplicitNamespaceImports>
+    <PackageId>AWSSDK.SecretsManager.Caching</PackageId>
+    <PackageVersion>2.0.0</PackageVersion>
+    <Title>AWS Secrets Manager Caching for .NET</Title>
+    <Authors>Amazon Web Services</Authors>
+    <Description>The AWS Secrets Manager .NET caching client enables in-process caching of secrets for .NET applications.</Description>
+    <Copyright>Amazon Web Services</Copyright>
+    <PackageProjectUrl>https://github.com/aws/aws-secretsmanager-caching-net</PackageProjectUrl>
+    <PackageLicenseExpression>Apache-2.0</PackageLicenseExpression>
+    <PackageIconUrl>https://sdk-for-net.amazonwebservices.com/images/AWSLogo128x128.png</PackageIconUrl>
+    <RepositoryUrl>https://github.com/aws/aws-secretsmanager-caching-net</RepositoryUrl>
+    <PackageTags>AWS;Amazon;cloud;aws-sdk-v3;secrets;secret manager;secretsmanager;caching;cache</PackageTags>
+    <SignAssembly>true</SignAssembly>
+    <AssemblyOriginatorKeyFile>..\..\aws-secretsmanager-caching-net.snk</AssemblyOriginatorKeyFile>
+  </PropertyGroup>
+  <ItemGroup>
+    <PackageReference Include="AWSSDK.SecretsManager" Version="4.*" />
+    <PackageReference Include="Microsoft.Extensions.Caching.Memory" Version="8.*" />
+    <PackageReference Include="StyleCop.Analyzers" Version="1.*">
+      <PrivateAssets>all</PrivateAssets>
+      <IncludeAssets>runtime; build; native; contentfiles; analyzers</IncludeAssets>
+    </PackageReference>
+  </ItemGroup>
 </Project>

src/Amazon.SecretsManager.Extensions.Caching/ISecretsManagerCache.cs

@@ -13,7 +13,6 @@
 
 namespace Amazon.SecretsManager.Extensions.Caching
 {
-
     using System;
     using System.Threading;
     using System.Threading.Tasks;
@@ -23,7 +22,6 @@ namespace Amazon.SecretsManager.Extensions.Caching
     /// </summary>
     public interface ISecretsManagerCache : IDisposable
     {
-
         /// <summary>
         /// Returns the cache entry corresponding to the specified secret if it exists in the cache.
         /// Otherwise, the secret value is fetched from Secrets Manager and a new cache entry is created.
@@ -47,4 +45,4 @@ public interface ISecretsManagerCache : IDisposable
         /// </summary>
         Task<bool> RefreshNowAsync(string secretId, CancellationToken cancellationToken = default);
     }
-}
+}

src/Amazon.SecretsManager.Extensions.Caching/SecretCacheConfiguration.cs

@@ -18,9 +18,9 @@
     /// </summary>
     public class SecretCacheConfiguration
     {
         public const ushort DEFAULT_MAX_CACHE_SIZE = 1024;
         public const string DEFAULT_VERSION_STAGE = "AWSCURRENT";
         public const uint DEFAULT_CACHE_ITEM_TTL = 3600000;
 
         /// <summary>
         /// Gets or sets the TTL of a cache item in milliseconds. The default value for this is 3600000 millseconds, or one hour.
@@ -49,4 +49,4 @@
         /// </summary>
         public ISecretCacheHook CacheHook { get; set; } = null;
     }
-}
+}

src/Amazon.SecretsManager.Extensions.Caching/SecretCacheItem.cs

@@ -25,15 +25,13 @@
     /// </summary>
     public class SecretCacheItem : SecretCacheObject<DescribeSecretResponse>
     {
-        /// The cached secret value versions for this cached secret. 
+        /// The cached secret value versions for this cached secret.
         private readonly MemoryCache versions = new MemoryCache(new MemoryCacheOptions());
         private const ushort MAX_VERSIONS_CACHE_SIZE = 10;
-        
+
         public SecretCacheItem(String secretId, IAmazonSecretsManager client, SecretCacheConfiguration config)
-            : base(secretId, client, config)
-        {
-        }
-
+            : base(secretId, client, config) { }
+
         /// <summary>
         /// Asynchronously retrieves the most current DescribeSecretResponse from Secrets Manager
         /// as part of the Refresh operation.
@@ -56,17 +54,17 @@
             return await version.GetSecretValue(cancellationToken);
         }
 
         public override int GetHashCode()
         {
             return (secretId ?? string.Empty).GetHashCode();
         }
 
         public override string ToString()
         {
             return $"SecretCacheItem: {secretId}";
         }
 
         public override bool Equals(object obj)
         {
             return obj is SecretCacheItem sci && string.Equals(this.secretId, sci.secretId);
         }
@@ -77,7 +75,8 @@
         /// </summary>
         private SecretCacheVersion GetVersion(DescribeSecretResponse describeResult)
         {
-            if (null == describeResult?.VersionIdsToStages) return null;
+            if (null == describeResult?.VersionIdsToStages)
+                return null;
             String currentVersionId = null;
             foreach (KeyValuePair<String, List<String>> entry in describeResult.VersionIdsToStages)
             {
@@ -108,4 +107,4 @@
             versions.Compact((double)(versions.Count - config.MaxCacheSize) / versions.Count);
         }
     }
-}
+}