Merge pull request #77 from sillsdev/use-jetbrains-annotations

Replaced SuppressMessage attributes with PublicAPI from JetBrains.Annotations

Author: tombogle

CHANGELOG.md

@@ -16,7 +16,15 @@ and this project adheres to [Semantic Versioning](http://semver.org/).
 
 ## [Unreleased]
 
+### Changed
+- [SIL.BuildTasks.AWS] Changed case of text in log message from "Publishing Sourcefiles" "Publishing SourceFiles". If anything is doing a case-sensitive parse of the log file, looking for this text, this could be a breaking change.
+
+### Deprecated
+
+- [SIL.BuildTasks] Deprecated `AbandondedSuites` in favor of correctly spelled `AbandonedSuites`.
+
 ## [3.1.1] - 2025-03-18
+
 ### Changed
 
 - [SIL.BuildTasks] Upgraded dependency on Markdig.Signed to version 0.37.0 (to be consistent with SIL.ReleaseTasks)

SIL.BuildTasks.AWS/AwsTaskBase.cs

@@ -1,4 +1,4 @@
-// Copyright (c) 2018 SIL Global
+// Copyright (c) 2018-2025 SIL Global
 // This software is licensed under the MIT License (http://opensource.org/licenses/MIT)
 /*
  * Original code from https://code.google.com/archive/p/snowcode/
@@ -9,16 +9,15 @@
  */
 
 using System;
-using System.Diagnostics.CodeAnalysis;
 using Amazon.Runtime;
 using Amazon.Runtime.CredentialManagement;
+using JetBrains.Annotations;
 using Microsoft.Build.Framework;
 using Microsoft.Build.Utilities;
 
 namespace SIL.BuildTasks.AWS
 {
-	[SuppressMessage("ReSharper", "MemberCanBePrivate.Global")]
-	[SuppressMessage("ReSharper", "UnusedAutoPropertyAccessor.Global")]
+	[PublicAPI]
 	public abstract class AwsTaskBase : Task
 	{
 		/// <summary>
@@ -33,8 +32,7 @@ public abstract class AwsTaskBase : Task
 		/// <returns></returns>
 		protected AWSCredentials GetAwsCredentials()
 		{
-			AWSCredentials awsCredentials;
-			if (!new CredentialProfileStoreChain().TryGetAWSCredentials(CredentialStoreProfileName, out awsCredentials))
+			if (!new CredentialProfileStoreChain().TryGetAWSCredentials(CredentialStoreProfileName, out var awsCredentials))
 				throw new ApplicationException("Unable to get AWS credentials from the credential profile store");
 
 			Log.LogMessage(MessageImportance.Normal, "Connecting to AWS using AwsAccessKeyId: {0}",

SIL.BuildTasks.AWS/S3/S3BuildPublisher.cs

@@ -1,4 +1,4 @@
-// Copyright (c) 2018 SIL Global
+// Copyright (c) 2018-2025 SIL Global
 // This software is licensed under the MIT License (http://opensource.org/licenses/MIT)
 /*
  * Original code from https://code.google.com/archive/p/snowcode/
@@ -9,8 +9,8 @@
  */
 
 using System;
-using System.Diagnostics.CodeAnalysis;
 using Amazon.Runtime;
+using JetBrains.Annotations;
 using Microsoft.Build.Framework;
 
 namespace SIL.BuildTasks.AWS.S3
@@ -19,9 +19,7 @@ namespace SIL.BuildTasks.AWS.S3
 	/// MSBuild task to publish a set of files to a S3 bucket.
 	/// </summary>
 	/// <remarks>If made public the files will be available at https://s3.amazonaws.com/bucket_name/folder/file_name</remarks>
-	[SuppressMessage("ReSharper", "MemberCanBePrivate.Global")]
-	[SuppressMessage("ReSharper", "UnusedMember.Global")]
-	[SuppressMessage("ReSharper", "UnusedAutoPropertyAccessor.Global")]
+	[PublicAPI]
 	public class S3BuildPublisher : AwsTaskBase
 	{
 		#region Properties
@@ -51,7 +49,7 @@ public class S3BuildPublisher : AwsTaskBase
 		public string DestinationBucket { get; set; }
 
 		/// <summary>
-		/// Gets or sets if the files should be publically readable
+		/// Gets or sets if the files should be publicly readable
 		/// </summary>
 		public bool IsPublicRead { get; set; }
 
@@ -83,7 +81,7 @@ public override bool Execute()
 
 		private bool ProcessFiles()
 		{
-			Log.LogMessage(MessageImportance.Normal, "Publishing Sourcefiles={0} to {1}", Join(SourceFiles), DestinationBucket);
+			Log.LogMessage(MessageImportance.Normal, "Publishing SourceFiles={0} to {1}", Join(SourceFiles), DestinationBucket);
 
 			ShowAclWarnings();
 

SIL.BuildTasks.AWS/SIL.BuildTasks.AWS.csproj

@@ -1,13 +1,16 @@
 <Project Sdk="Microsoft.NET.Sdk">
   <PropertyGroup>
     <TargetFrameworks>net472</TargetFrameworks>
-    <RootNamespace>SIL.BuildTasks</RootNamespace>
+    <RootNamespace>SIL.BuildTasks.AWS</RootNamespace>
     <Description>SIL.BuildTasks.AWS defines a S3BuildPublisher msbuild task to publish a set of files to a S3 bucket.</Description>
     <AssemblyTitle>SIL.BuildTasks.AWS</AssemblyTitle>
     <IsTool>true</IsTool>
   </PropertyGroup>
   <ItemGroup>
     <PackageReference Include="AWSSDK.S3" Version="3.3.110.50" IncludeAssets="All" PrivateAssets="All" />
+    <PackageReference Include="JetBrains.Annotations" Version="2024.3.0">
+      <PrivateAssets>All</PrivateAssets>
+    </PackageReference>
     <PackageReference Include="Markdig.Signed" Version="0.41.1" />
     <PackageReference Include="Microsoft.Build.Tasks.Core" Version="17.14.8" />
     <PackageReference Include="SIL.ReleaseTasks.Dogfood" Version="[2.3.3-*,)" PrivateAssets="All" />

SIL.BuildTasks.Tests/SIL.BuildTasks.Tests.csproj

@@ -11,6 +11,9 @@
     <Reference Include="Microsoft.Build.Utilities.v4.0" />
   </ItemGroup>
   <ItemGroup>
+    <PackageReference Include="JetBrains.Annotations" Version="2024.3.0">
+      <PrivateAssets>All</PrivateAssets>
+    </PackageReference>
     <PackageReference Include="Microsoft.Build.Tasks.Core" Version="17.14.8" />
     <PackageReference Include="Microsoft.Build.Utilities.Core" Version="17.14.8" />
     <PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.14.0" />

SIL.BuildTasks/Archive/Archive.cs

@@ -1,17 +1,16 @@
-// Copyright (c) 2018 SIL Global
+// Copyright (c) 2018-2025 SIL Global
 // This software is licensed under the MIT License (http://opensource.org/licenses/MIT)
 
 using System.Collections.Generic;
 using System.Diagnostics;
-using System.Diagnostics.CodeAnalysis;
 using System.Text;
+using JetBrains.Annotations;
 using Microsoft.Build.Framework;
 using Microsoft.Build.Utilities;
 
 namespace SIL.BuildTasks.Archive
 {
-	[SuppressMessage("ReSharper", "MemberCanBePrivate.Global")]
-	[SuppressMessage("ReSharper", "UnusedAutoPropertyAccessor.Global")]
+	[PublicAPI]
 	public class Archive : Task
 	{
 		[Required]

SIL.BuildTasks/CpuArchitecture.cs

@@ -1,8 +1,8 @@
-// Copyright (c) 2018 SIL Global
+// Copyright (c) 2018-2025 SIL Global
 // This software is licensed under the MIT License (http://opensource.org/licenses/MIT)
 using System;
 using System.Diagnostics;
-using System.Diagnostics.CodeAnalysis;
+using JetBrains.Annotations;
 using Microsoft.Build.Framework;
 using Microsoft.Build.Utilities;
 
@@ -11,7 +11,7 @@ namespace SIL.BuildTasks
 	/// <summary>
 	/// Return the CPU architecture of the current system.
 	/// </summary>
-	[SuppressMessage("ReSharper", "MemberCanBePrivate.Global")]
+	[PublicAPI]
 	public class CpuArchitecture : Task
 	{
 		public override bool Execute()

SIL.BuildTasks/DownloadFile.cs

@@ -1,9 +1,9 @@
-// Copyright (c) 2018 SIL Global
+// Copyright (c) 2018-2025 SIL Global
 // This software is licensed under the MIT License (http://opensource.org/licenses/MIT)
 using System;
-using System.Diagnostics.CodeAnalysis;
 using System.IO;
 using System.Net;
+using JetBrains.Annotations;
 using Microsoft.Build.Framework;
 using Microsoft.Build.Utilities;
 
@@ -16,9 +16,7 @@ namespace SIL.BuildTasks
 	/// may be sent in clear.
 	/// Adapted from http://stackoverflow.com/questions/1089452/how-can-i-use-msbuild-to-download-a-file
 	/// </summary>
-	[SuppressMessage("ReSharper", "MemberCanBePrivate.Global")]
-	[SuppressMessage("ReSharper", "UnusedMember.Global")]
-	[SuppressMessage("ReSharper", "UnusedAutoPropertyAccessor.Global")]
+	[PublicAPI]
 	public class DownloadFile : Task
 	{
 		/// <summary>
@@ -45,9 +43,9 @@ public class DownloadFile : Task
 
 		public override bool Execute()
 		{
-			// This doesn't seem to work reliably..can return true even when only network cable is unplugged.
-			// Left in in case it works in some cases. But the main way of dealing with disconnect is the
-			// same algorithm in the WebException handler.
+			// This doesn't seem to work reliably. It can return true even when only network cable
+			// is unplugged. Left it in just in case it works in some cases. But the main way of
+			// dealing with disconnect is the same algorithm in the WebException handler.
 			if (!System.Net.NetworkInformation.NetworkInterface.GetIsNetworkAvailable())
 			{
 				if (File.Exists(LocalFilename))
@@ -60,8 +58,7 @@ public override bool Execute()
 				return false; // Presumably can't continue
 			}
 
-			bool success;
-			var read = DoDownloadFile(Address, LocalFilename, Username, Password, out success);
+			var read = DoDownloadFile(Address, LocalFilename, Username, Password, out var success);
 
 			if (success)
 				Log.LogMessage(MessageImportance.Low, "{0} bytes written", read);

SIL.BuildTasks/FileUpdate.cs

@@ -1,13 +1,15 @@
-// Copyright (c) 2023 SIL Global
+// Copyright (c) 2023-2025 SIL Global
 // This software is licensed under the MIT License (http://opensource.org/licenses/MIT)
 using System;
 using System.Diagnostics;
 using System.Text.RegularExpressions;
+using JetBrains.Annotations;
 using Microsoft.Build.Framework;
 using Microsoft.Build.Utilities;
 
 namespace SIL.BuildTasks
 {
+	[PublicAPI]
 	public class FileUpdate : Task
 	{
 		private string _dateFormat;

SIL.BuildTasks/MakePot/MakePot.cs

@@ -1,18 +1,17 @@
-// Copyright (c) 2018 SIL Global
+// Copyright (c) 2018-2025 SIL Global
 // This software is licensed under the MIT License (http://opensource.org/licenses/MIT)
 using System;
 using System.Collections.Generic;
-using System.Diagnostics.CodeAnalysis;
 using System.IO;
 using System.Text.RegularExpressions;
 using System.Xml;
+using JetBrains.Annotations;
 using Microsoft.Build.Framework;
 using Microsoft.Build.Utilities;
 
 namespace SIL.BuildTasks.MakePot
 {
-	[SuppressMessage("ReSharper", "MemberCanBePrivate.Global")]
-	[SuppressMessage("ReSharper", "UnusedAutoPropertyAccessor.Global")]
+	[PublicAPI]
 	public class MakePot: Task
 	{
 		private readonly Dictionary<string, List<string>> _entries = new Dictionary<string, List<string>>();
@@ -182,7 +181,7 @@ internal void ProcessSrcFile(string filePath)
 				}
 				var comments = "#: " + filePath;
 
-				//catch the second parameter from calls like this:
+				// Catch the second parameter from calls like this:
 				//            StringCataGet("~Note", "The label for the field showing a note.");
 
 				if (!string.IsNullOrEmpty(match.Groups["note"].Value))
@@ -214,16 +213,16 @@ private static void WriteEntry(string key, IEnumerable<string> comments, TextWri
 
 		public static string EscapeString(string s)
 		{
-			var result = s.Replace("\\", "\\\\"); // This must be first
+			var result = s.Replace(@"\", @"\\"); // This must be first
 			result = result.Replace("\"", "\\\"");
 			return result;
 		}
 
 		public static string UnescapeString(string s)
 		{
-			var result = s.Replace("\\'", "'");
-			result = result.Replace("\\\"", "\"");
-			result = result.Replace("\\\\", "\\");
+			var result = s.Replace(@"\'", "'");
+			result = result.Replace(@"\""", "\"");
+			result = result.Replace(@"\\", @"\");
 			return result;
 		}
 	}