Add missing NL (new line) at EOF (end of file)

[mteodor]

Summary

clang-format.exe removes trailing new lines at end of file.

However, if no NL is found at EOF one should be added.

Let me know if you prefer this to be optional. Other Visual Studio extensions have this functionality configurable.

[hans]

(Meta comment: please upload patches with more context so the rest of the files show up in the review. If you generate the patch with diff or git diff, do it by passing along -U9999.)

I don't know much about VS, but doesn't it already have an option to save files with newline at end of file?

If we want clang-format to do this, should it perhaps be part of clang-format.exe itself, rather than the plugin?

[mteodor]

In D37732#869928, @hans wrote:

I don't know much about VS, but doesn't it already have an option to save files with newline at end of file?

Unfortunately, it doesn't have this option.

If we want clang-format to do this, should it perhaps be part of clang-format.exe itself, rather than the plugin?

That would be even better. However, since this is practically a Windows only problem I don't have many hopes.

In Linux/UNIX world, the POSIX requirement for LINE termination is implemented virtually by all text editors. Some don't even have an option to do otherwise.

[hans]

In D37732#876431, @mteodor wrote:

In D37732#869928, @hans wrote:

I don't know much about VS, but doesn't it already have an option to save files with newline at end of file?

Unfortunately, it doesn't have this option.

If we want clang-format to do this, should it perhaps be part of clang-format.exe itself, rather than the plugin?

That would be even better. However, since this is practically a Windows only problem I don't have many hopes.

In Linux/UNIX world, the POSIX requirement for LINE termination is implemented virtually by all text editors. Some don't even have an option to do otherwise.

OK, I suppose that's a good case for donig this in the plugin.

I wonder if we'll need to expose this as a plugin option though, in case some users (for weird reasons, but some people seem to like it that way) don't want newline at the end of the file..

ClangFormatPackage.cs

331 ↗

(On Diff #114780)

Please upload the file with context so it's easier to review.

445 ↗

(On Diff #114780)

This lookslike an unrelated formatting change?

[mteodor]

Update patch for full context (U9999).

Also, I removed the second part of the patch.

[mteodor]

ClangFormatPackage.cs

445 ↗

(On Diff #114780)

That was not a formatting change, but an attempt to make sure the Edit is closed after each Clang Format execution.

[mteodor]

In D37732#876591, @hans wrote:

I wonder if we'll need to expose this as a plugin option though, in case some users (for weird reasons, but some people seem to like it that way) don't want newline at the end of the file..

We could add it later if requested. However, in my experience with this issue the response from other devs was: I don't care about this!.

Thus, this is only an editor problem so that we don't have to deal with it manually. No arguments against it.

[hans]

This looks good to me. Do you have commit access, or would you like me to commit for you?

In D37732#878546, @mteodor wrote:

Update patch for full context (U9999).

Also, I removed the second part of the patch.

Thanks!

In D37732#878555, @mteodor wrote:

In D37732#876591, @hans wrote:

I wonder if we'll need to expose this as a plugin option though, in case some users (for weird reasons, but some people seem to like it that way) don't want newline at the end of the file..

We could add it later if requested. However, in my experience with this issue the response from other devs was: I don't care about this!.

Thus, this is only an editor problem so that we don't have to deal with it manually. No arguments against it.

Fair enough.

[mteodor]

In D37732#878897, @hans wrote:

This looks good to me. Do you have commit access, or would you like me to commit for you?

I don't have svn commit access. Please do that.

[klimek]

For what it's worth, I think it'd also be fine to always add a newline at the end of a file in clang-format, or have an option. I think this is fine, too, though.

[danra]

In D37732#876591, @hans wrote:

In D37732#876431, @mteodor wrote:

In D37732#869928, @hans wrote:

I don't know much about VS, but doesn't it already have an option to save files with newline at end of file?

Unfortunately, it doesn't have this option.

If we want clang-format to do this, should it perhaps be part of clang-format.exe itself, rather than the plugin?

That would be even better. However, since this is practically a Windows only problem I don't have many hopes.

In Linux/UNIX world, the POSIX requirement for LINE termination is implemented virtually by all text editors. Some don't even have an option to do otherwise.

OK, I suppose that's a good case for donig this in the plugin.

FWIW, I would be happy to have this in clang-format itself. With a few coders working on a few editors on different platforms, missing lines at EOF are likely to sneak in occasionally, requiring cleanup commits.

cfe/trunk/tools/clang-format-vs/ClangFormat/ClangFormatPackage.cs

public sealed class ClangFormatPackage : Package
         private void FormatView(IWpfTextView view, OptionPageGrid options)
         {
             if (view == null)
                 // We're not in a text view.
                 return;
 
             string filePath = Vsix.GetDocumentPath(view);
             var path = Path.GetDirectoryName(filePath);
+
             string text = view.TextBuffer.CurrentSnapshot.GetText();
+            if (!text.EndsWith(Environment.NewLine))
+            {
+                view.TextBuffer.Insert(view.TextBuffer.CurrentSnapshot.Length, Environment.NewLine);
+                text += Environment.NewLine;
+            }
 
             RunClangFormatAndApplyReplacements(text, 0, text.Length, path, filePath, options, view);
         }
 
         private void RunClangFormatAndApplyReplacements(string text, int offset, int length, string path, string filePath, OptionPageGrid options, IWpfTextView view)
         {
             try
             {