Merge pull request #1306 from libgit2/cmn/prettify

Expose message prettification

Author: Edward Thomson

LibGit2Sharp.Tests/CommitFixture.cs

@@ -1045,5 +1045,15 @@ public void CanNotAmendACommitInAWayThatWouldLeadTheNewCommitToBecomeEmpty()
                     new CommitOptions { AmendPreviousCommit = true }));
             }
         }
+
+        [Fact]
+        public void CanPrettifyAMessage()
+        {
+            string input = "# Comment\nA line that will remain\n# And another character\n\n\n";
+            string expected = "A line that will remain\n";
+
+            Assert.Equal(expected, Commit.PrettifyMessage(input, '#'));
+            Assert.Equal(expected, Commit.PrettifyMessage(input.Replace('#', ';'), ';'));
+        }
     }
 }

LibGit2Sharp/Commit.cs

@@ -113,6 +113,20 @@ private static string RetrieveEncodingOf(ObjectHandle obj)
             return encoding ?? "UTF-8";
         }
 
+        /// <summary>
+        /// Prettify a commit message
+        /// <para>
+        /// Remove comment lines and trailing lines
+        /// </para>
+        /// </summary>
+        /// <returns>The prettified message</returns>
+        /// <param name="message">The message to prettify.</param>
+        /// <param name="commentChar">Comment character. Lines starting with it will be removed</param>
+        public static string PrettifyMessage(string message, char commentChar)
+        {
+            return Proxy.git_message_prettify(message, commentChar);
+        }
+
         private string DebuggerDisplay
         {
             get

LibGit2Sharp/Core/Proxy.cs

@@ -1256,7 +1256,7 @@ public static string git_message_prettify(string message, char? commentChar)
 
             using (var buf = new GitBuf())
             {
-                int res = NativeMethods.git_message_prettify(buf, message, false, (sbyte)comment);
+                int res = NativeMethods.git_message_prettify(buf, message, true, (sbyte)comment);
                 Ensure.Int32Result(res);
 
                 return LaxUtf8Marshaler.FromNative(buf.ptr) ?? string.Empty;