To improve compatibility of SftpClient with System.IO.File, the following methods now use UTF-8 encoding without a Byte-Order Mark (BOM):

void AppendAllLines(string path, IEnumerable<string> contents)
void AppendAllText(string path, string contents)
StreamWriter AppendText(string path)
StreamWriter CreateText(string path)
void WriteAllLines(string path, IEnumerable<string> contents)
void WriteAllLines(string path, string[] contents)
void WriteAllText(string path, string contents)

Author: drieseng

src/Renci.SshNet/SftpClient.cs

@@ -18,6 +18,8 @@ namespace Renci.SshNet
     /// </summary>
     public class SftpClient : BaseClient
     {
+        private static readonly Encoding Utf8NoBOM = new UTF8Encoding(false, true);
+
         /// <summary>
         /// Holds the <see cref="ISftpSession"/> instance that is used to communicate to the
         /// SFTP server.
@@ -1006,6 +1008,9 @@ public SftpFileSytemInformation GetStatus(string path)
         /// <exception cref="SshConnectionException">Client is not connected.</exception>
         /// <exception cref="SftpPathNotFoundException"><paramref name="path"/> was not found on the remote host.</exception>
         /// <exception cref="ObjectDisposedException">The method was called after the client was disposed.</exception>
+        /// <remarks>
+        /// The characters are written to the file using UTF-8 encoding without a Byte-Order Mark (BOM)
+        /// </remarks>
         public void AppendAllLines(string path, IEnumerable<string> contents)
         {
             CheckDisposed();
@@ -1057,6 +1062,9 @@ public void AppendAllLines(string path, IEnumerable<string> contents, Encoding e
         /// <exception cref="SshConnectionException">Client is not connected.</exception>
         /// <exception cref="SftpPathNotFoundException"><paramref name="path"/> was not found on the remote host.</exception>
         /// <exception cref="ObjectDisposedException">The method was called after the client was disposed.</exception>
+        /// <remarks>
+        /// The characters are written to the file using UTF-8 encoding without a Byte-Order Mark (BOM).
+        /// </remarks>
         public void AppendAllText(string path, string contents)
         {
             using (var stream = AppendText(path))
@@ -1088,15 +1096,16 @@ public void AppendAllText(string path, string contents, Encoding encoding)
         /// </summary>
         /// <param name="path">The path to the file to append to.</param>
         /// <returns>
-        /// A <see cref="StreamWriter"/> that appends UTF-8 encoded text to an existing file.
+        /// A <see cref="StreamWriter"/> that appends text to a file using UTF-8 encoding without a
+        /// Byte-Order Mark (BOM).
         /// </returns>
         /// <exception cref="ArgumentNullException"><paramref name="path"/> is <b>null</b>.</exception>
         /// <exception cref="SshConnectionException">Client is not connected.</exception>
         /// <exception cref="SftpPathNotFoundException"><paramref name="path"/> was not found on the remote host.</exception>
         /// <exception cref="ObjectDisposedException">The method was called after the client was disposed.</exception>
         public StreamWriter AppendText(string path)
         {
-            return AppendText(path, Encoding.UTF8);
+            return AppendText(path, Utf8NoBOM);
         }
 
         /// <summary>
@@ -1167,10 +1176,12 @@ public SftpFileStream Create(string path, int bufferSize)
         /// </summary>
         /// <param name="path">The file to be opened for writing.</param>
         /// <returns>
-        /// A <see cref="StreamWriter"/> that writes to the specified file using UTF-8 encoding.
+        /// A <see cref="StreamWriter"/> that writes text to a file using UTF-8 encoding without
+        /// a Byte-Order Mark (BOM).
         /// </returns>
         /// <exception cref="ArgumentNullException"><paramref name="path"/> is <b>null</b>.</exception>
         /// <exception cref="SshConnectionException">Client is not connected.</exception>
+        /// <exception cref="SftpPathNotFoundException">The specified path is invalid, or its directory was not found on the remote host.</exception>
         /// <exception cref="ObjectDisposedException">The method was called after the client was disposed.</exception>
         /// <remarks>
         /// <para>
@@ -1182,7 +1193,7 @@ public SftpFileStream Create(string path, int bufferSize)
         /// </remarks>
         public StreamWriter CreateText(string path)
         {
-            return CreateText(path, Encoding.UTF8);
+            return CreateText(path, Utf8NoBOM);
         }
 
         /// <summary>
@@ -1586,6 +1597,9 @@ public void WriteAllBytes(string path, byte[] bytes)
         /// <exception cref="ObjectDisposedException">The method was called after the client was disposed.</exception>
         /// <remarks>
         /// <para>
+        /// The characters are written to the file using UTF-8 encoding without a Byte-Order Mark (BOM).
+        /// </para>
+        /// <para>
         /// If the target file already exists, it is overwritten. It is not first truncated to zero bytes.
         /// </para>
         /// <para>
@@ -1594,7 +1608,7 @@ public void WriteAllBytes(string path, byte[] bytes)
         /// </remarks>
         public void WriteAllLines(string path, IEnumerable<string> contents)
         {
-            WriteAllLines(path, contents, Encoding.UTF8);
+            WriteAllLines(path, contents, Utf8NoBOM);
         }
 
         /// <summary>
@@ -1607,6 +1621,9 @@ public void WriteAllLines(string path, IEnumerable<string> contents)
         /// <exception cref="ObjectDisposedException">The method was called after the client was disposed.</exception>
         /// <remarks>
         /// <para>
+        /// The characters are written to the file using UTF-8 encoding without a Byte-Order Mark (BOM).
+        /// </para>
+        /// <para>
         /// If the target file already exists, it is overwritten. It is not first truncated to zero bytes.
         /// </para>
         /// <para>
@@ -1615,7 +1632,7 @@ public void WriteAllLines(string path, IEnumerable<string> contents)
         /// </remarks>
         public void WriteAllLines(string path, string[] contents)
         {
-            WriteAllLines(path, contents, Encoding.UTF8);
+            WriteAllLines(path, contents, Utf8NoBOM);
         }
 
         /// <summary>
@@ -1682,10 +1699,10 @@ public void WriteAllLines(string path, string[] contents, Encoding encoding)
         /// <exception cref="ArgumentNullException"><paramref name="path"/> is <b>null</b>.</exception>
         /// <exception cref="SshConnectionException">Client is not connected.</exception>
         /// <exception cref="ObjectDisposedException">The method was called after the client was disposed.</exception>
+        /// <remarks>
         /// <para>
-        /// If the target file already exists, it is overwritten. It is not first truncated to zero bytes.
+        /// The characters are written to the file using UTF-8 encoding without a Byte-Order Mark (BOM).
         /// </para>
-        /// <remarks>
         /// <para>
         /// If the target file already exists, it is overwritten. It is not first truncated to zero bytes.
         /// </para>