Merge pull request #1686 from OmniSharp/feature/organize-imports-format

Added support for organizing imports in formatting
OmniSharp · Jan 24, 2020 · f19bb41 · f19bb41
2 parents 210a28d + 5887c8e
commit f19bb41
Show file tree

Hide file tree

Showing 3 changed files with 87 additions and 12 deletions.
diff --git a/src/OmniSharp.Roslyn.CSharp/Workers/Formatting/FormattingWorker.cs b/src/OmniSharp.Roslyn.CSharp/Workers/Formatting/FormattingWorker.cs
@@ -84,33 +84,36 @@ public static SyntaxNode FindFormatTarget(SyntaxNode root, int position)
 
         public static async Task<IEnumerable<LinePositionSpanTextChange>> GetFormattingChanges(Document document, int start, int end, OmniSharpOptions omnisharpOptions, ILoggerFactory loggerFactory)
         {
-            var optionSet = omnisharpOptions.FormattingOptions.EnableEditorConfigSupport
-                ? await document.Project.Solution.Workspace.Options.WithEditorConfigOptions(document.FilePath, loggerFactory)
-                : document.Project.Solution.Workspace.Options;
-            var newDocument = await Formatter.FormatAsync(document, TextSpan.FromBounds(start, end), optionSet);
-
+            var newDocument = await FormatDocument(document, omnisharpOptions, loggerFactory, TextSpan.FromBounds(start, end));
             return await TextChanges.GetAsync(newDocument, document);
         }
 
         public static async Task<string> GetFormattedText(Document document, OmniSharpOptions omnisharpOptions, ILoggerFactory loggerFactory)
         {
-            var optionSet = omnisharpOptions.FormattingOptions.EnableEditorConfigSupport
-                ? await document.Project.Solution.Workspace.Options.WithEditorConfigOptions(document.FilePath, loggerFactory)
-                : document.Project.Solution.Workspace.Options;
-            var newDocument = await Formatter.FormatAsync(document, optionSet);
+            var newDocument = await FormatDocument(document, omnisharpOptions, loggerFactory);
             var text = await newDocument.GetTextAsync();
-
             return text.ToString();
         }
 
         public static async Task<IEnumerable<LinePositionSpanTextChange>> GetFormattedTextChanges(Document document, OmniSharpOptions omnisharpOptions, ILoggerFactory loggerFactory)
+        {
+            var newDocument = await FormatDocument(document, omnisharpOptions, loggerFactory);
+            return await TextChanges.GetAsync(newDocument, document);
+        }
+
+        private static async Task<Document> FormatDocument(Document document, OmniSharpOptions omnisharpOptions, ILoggerFactory loggerFactory, TextSpan? textSpan = null)
         {
             var optionSet = omnisharpOptions.FormattingOptions.EnableEditorConfigSupport
                 ? await document.Project.Solution.Workspace.Options.WithEditorConfigOptions(document.FilePath, loggerFactory)
                 : document.Project.Solution.Workspace.Options;
-            var newDocument = await Formatter.FormatAsync(document, optionSet);
 
-            return await TextChanges.GetAsync(newDocument, document);
+            var newDocument = textSpan != null ? await Formatter.FormatAsync(document, textSpan.Value, optionSet) : await Formatter.FormatAsync(document, optionSet);
+            if (omnisharpOptions.FormattingOptions.OrganizeImports)
+            {
+                newDocument = await Formatter.OrganizeImportsAsync(document);
+            }
+
+            return newDocument;
         }
     }
 }
diff --git a/src/OmniSharp.Shared/Options/FormattingOptions.cs b/src/OmniSharp.Shared/Options/FormattingOptions.cs
@@ -59,6 +59,8 @@ public FormattingOptions()
             NewLineForClausesInQuery = true;
         }
 
+        public bool OrganizeImports { get; set; }
+
         public bool EnableEditorConfigSupport { get; set; }
 
         public string NewLine { get; set; }

diff --git a/tests/OmniSharp.Roslyn.CSharp.Tests/FormattingFacts.cs b/tests/OmniSharp.Roslyn.CSharp.Tests/FormattingFacts.cs
@@ -254,6 +254,76 @@ public async Task FormatRespectsIndentationSize()
             }
         }
 
+        [Fact]
+        public async Task OrganizesImports()
+        {
+            var testFile = new TestFile("dummy.cs", @"
+using System.IO;
+using Dummy;
+using System;
+
+namespace Bar
+{
+    class Foo { }
+}");
+
+            using (var host = CreateOmniSharpHost(new[] { testFile }, configurationData: new Dictionary<string, string>
+            {
+                ["FormattingOptions:OrganizeImports"] = "true"
+            }))
+            {
+                var requestHandler = host.GetRequestHandler<CodeFormatService>(OmniSharpEndpoints.CodeFormat);
+
+                var request = new CodeFormatRequest { FileName = testFile.FileName };
+                var response = await requestHandler.Handle(request);
+
+                Assert.Equal(@"
+using System;
+using System.IO;
+using Dummy;
+
+namespace Bar
+{
+    class Foo { }
+}", response.Buffer);
+            }
+        }
+
+        [Fact]
+        public async Task DoesntOrganizeImportsWhenDisabled()
+        {
+            var testFile = new TestFile("dummy.cs", @"
+using System.IO;
+using Dummy;
+using System;
+
+namespace Bar
+{
+    class Foo { }
+}");
+
+            using (var host = CreateOmniSharpHost(new[] { testFile }, configurationData: new Dictionary<string, string>
+            {
+                ["FormattingOptions:OrganizeImports"] = "false"
+            }))
+            {
+                var requestHandler = host.GetRequestHandler<CodeFormatService>(OmniSharpEndpoints.CodeFormat);
+
+                var request = new CodeFormatRequest { FileName = testFile.FileName };
+                var response = await requestHandler.Handle(request);
+
+                Assert.Equal(@"
+using System.IO;
+using Dummy;
+using System;
+
+namespace Bar
+{
+    class Foo { }
+}", response.Buffer);
+            }
+        }
+
         private static void AssertFormatTargetKind(SyntaxKind kind, string input)
         {
             var content = TestContent.Parse(input);