Add StringFormatMethod attributes for better intellisense

sufyannisar · Oct 1, 2018 · b7836ae · b7836ae
1 parent 08f0e8c
commit b7836ae
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 2 deletions.
diff --git a/appveyor.yml b/appveyor.yml
@@ -1,4 +1,4 @@
-version: 1.4.1-{build}
+version: 1.4.2-{build}
 
 os: Visual Studio 2017
 

diff --git a/src/Hangfire.Console/ConsoleExtensions.cs b/src/Hangfire.Console/ConsoleExtensions.cs
@@ -2,6 +2,7 @@
 using Hangfire.Console.Server;
 using Hangfire.Server;
 using System;
+using JetBrains.Annotations;
 
 namespace Hangfire.Console
 {
@@ -103,6 +104,7 @@ public static void WriteLine(this PerformContext context, object value)
         /// <param name="context">Context</param>
         /// <param name="format">Format string</param>
         /// <param name="arg0">Argument</param>
+        [StringFormatMethod("format")]
         public static void WriteLine(this PerformContext context, string format, object arg0)
             => WriteLine(context, string.Format(format, arg0));
 
@@ -113,6 +115,7 @@ public static void WriteLine(this PerformContext context, string format, object
         /// <param name="format">Format string</param>
         /// <param name="arg0">Argument</param>
         /// <param name="arg1">Argument</param>
+        [StringFormatMethod("format")]
         public static void WriteLine(this PerformContext context, string format, object arg0, object arg1)
             => WriteLine(context, string.Format(format, arg0, arg1));
 
@@ -124,6 +127,7 @@ public static void WriteLine(this PerformContext context, string format, object
         /// <param name="arg0">Argument</param>
         /// <param name="arg1">Argument</param>
         /// <param name="arg2">Argument</param>
+        [StringFormatMethod("format")]
         public static void WriteLine(this PerformContext context, string format, object arg0, object arg1, object arg2)
             => WriteLine(context, string.Format(format, arg0, arg1, arg2));
 
@@ -133,6 +137,7 @@ public static void WriteLine(this PerformContext context, string format, object
         /// <param name="context">Context</param>
         /// <param name="format">Format string</param>
         /// <param name="args">Arguments</param>
+        [StringFormatMethod("format")]
         public static void WriteLine(this PerformContext context, string format, params object[] args)
             => WriteLine(context, string.Format(format, args));
 
@@ -152,6 +157,7 @@ public static void WriteLine(this PerformContext context, ConsoleTextColor color
         /// <param name="color">Text color</param>
         /// <param name="format">Format string</param>
         /// <param name="arg0">Argument</param>
+        [StringFormatMethod("format")]
         public static void WriteLine(this PerformContext context, ConsoleTextColor color, string format, object arg0)
             => WriteLine(context, color, string.Format(format, arg0));
 
@@ -163,6 +169,7 @@ public static void WriteLine(this PerformContext context, ConsoleTextColor color
         /// <param name="format">Format string</param>
         /// <param name="arg0">Argument</param>
         /// <param name="arg1">Argument</param>
+        [StringFormatMethod("format")]
         public static void WriteLine(this PerformContext context, ConsoleTextColor color, string format, object arg0, object arg1)
             => WriteLine(context, color, string.Format(format, arg0, arg1));
 
@@ -175,6 +182,7 @@ public static void WriteLine(this PerformContext context, ConsoleTextColor color
         /// <param name="arg0">Argument</param>
         /// <param name="arg1">Argument</param>
         /// <param name="arg2">Argument</param>
+        [StringFormatMethod("format")]
         public static void WriteLine(this PerformContext context, ConsoleTextColor color, string format, object arg0, object arg1, object arg2)
             => WriteLine(context, color, string.Format(format, arg0, arg1, arg2));
 
@@ -185,6 +193,7 @@ public static void WriteLine(this PerformContext context, ConsoleTextColor color
         /// <param name="color">Text color</param>
         /// <param name="format">Format string</param>
         /// <param name="args">Arguments</param>
+        [StringFormatMethod("format")]
         public static void WriteLine(this PerformContext context, ConsoleTextColor color, string format, params object[] args)
             => WriteLine(context, color, string.Format(format, args));
     }

diff --git a/src/Hangfire.Console/Hangfire.Console.csproj b/src/Hangfire.Console/Hangfire.Console.csproj
@@ -2,7 +2,7 @@
   <PropertyGroup>
     <Description>Job console for Hangfire</Description>
     <AssemblyTitle>Hangfire.Console</AssemblyTitle>
-    <VersionPrefix>1.4.1</VersionPrefix>
+    <VersionPrefix>1.4.2</VersionPrefix>
     <Authors>Alexey Skalozub</Authors>
     <TargetFrameworks>netstandard1.3;net45</TargetFrameworks>
     <TreatWarningsAsErrors>true</TreatWarningsAsErrors>
@@ -11,6 +11,9 @@
     <PackageId>Hangfire.Console</PackageId>
     <PackageTags>hangfire;console;logging</PackageTags>
     <PackageReleaseNotes>History:
+      v1.4.2:
+      • Added StringFormatMethod attributes on WriteLine methods (for better intellisense)
+
       v1.4.1:
       • Fix job progress style
       • Use explicit json serializer settings
@@ -113,6 +116,7 @@
   </ItemGroup>
   <ItemGroup>
     <PackageReference Include="Hangfire.Core" Version="1.6.0" />
+    <PackageReference Include="JetBrains.Annotations" Version="11.0.0" PrivateAssets="All" />
   </ItemGroup>
   <ItemGroup Condition=" '$(TargetFramework)' == 'net45' ">
     <Reference Include="System" />