Merge pull request #4302 from JoeRobich/add-organize-imports

Add option to organize imports during document formatting.
dotnet · Dec 18, 2020 · 687fe0e · 687fe0e
2 parents b04c301 + 151b11d
commit 687fe0e
Show file tree

Hide file tree

Showing 5 changed files with 15 additions and 2 deletions.
diff --git a/package.json b/package.json
@@ -820,6 +820,11 @@
           "default": false,
           "description": "Enables support for showing unimported types and unimported extension methods in completion lists. When committed, the appropriate using directive will be added at the top of the current file. This option can have a negative impact on initial completion responsiveness, particularly for the first few completion sessions after opening a solution."
         },
+        "omnisharp.organizeImportsOnFormat": {
+          "type": "boolean",
+          "default": false,
+          "description": "Specifies whether 'using' directives should be grouped and sorted during document formatting."
+        },
         "razor.plugin.path": {
           "type": [
             "string",

diff --git a/src/observers/OptionChangeObserver.ts b/src/observers/OptionChangeObserver.ts
@@ -20,7 +20,8 @@ const omniSharpOptions: ReadonlyArray<OptionsKey> = [
     "loggingLevel",
     "enableEditorConfigSupport",
     "enableDecompilationSupport",
-    "enableImportCompletion"
+    "enableImportCompletion",
+    "organizeImportsOnFormat",
 ];
 
 function OmniSharpOptionChangeObservable(optionObservable: Observable<Options>): Observable<Options> {

diff --git a/src/omnisharp/options.ts b/src/omnisharp/options.ts
@@ -16,6 +16,7 @@ export class Options {
         public maxProjectResults: number,
         public useEditorFormattingSettings: boolean,
         public useFormatting: boolean,
+        public organizeImportsOnFormat: boolean,
         public showReferencesCodeLens: boolean,
         public showTestsCodeLens: boolean,
         public disableCodeActions: boolean,
@@ -74,6 +75,7 @@ export class Options {
         const enableImportCompletion = omnisharpConfig.get<boolean>('enableImportCompletion', false);
 
         const useFormatting = csharpConfig.get<boolean>('format.enable', true);
+        const organizeImportsOnFormat = omnisharpConfig.get<boolean>('organizeImportsOnFormat', false);
 
         const showReferencesCodeLens = csharpConfig.get<boolean>('referencesCodeLens.enabled', true);
         const showTestsCodeLens = csharpConfig.get<boolean>('testsCodeLens.enabled', true);
@@ -107,6 +109,7 @@ export class Options {
             maxProjectResults,
             useEditorFormattingSettings,
             useFormatting,
+            organizeImportsOnFormat,
             showReferencesCodeLens,
             showTestsCodeLens,
             disableCodeActions,

diff --git a/src/omnisharp/server.ts b/src/omnisharp/server.ts
@@ -355,6 +355,10 @@ export class OmniSharpServer {
             args.push('FormattingOptions:EnableEditorConfigSupport=true');
         }
 
+        if (options.organizeImportsOnFormat === true) {
+            args.push('FormattingOptions:OrganizeImports=true');
+        }
+
         if (this.decompilationAuthorized && options.enableDecompilationSupport === true) {
             args.push('RoslynExtensionsOptions:EnableDecompilationSupport=true');
         }

diff --git a/test/unitTests/Fakes/FakeOptions.ts b/test/unitTests/Fakes/FakeOptions.ts
@@ -6,5 +6,5 @@
 import { Options } from "../../../src/omnisharp/options";
 
 export function getEmptyOptions(): Options {
-    return new Options("", "", false, "", false, 0, 0, false, false, false, false, false, false, 0, 0, false, false, false, false, false, false, false, undefined, "", "");
+    return new Options("", "", false, "", false, 0, 0, false, false, false, false, false, false, false, 0, 0, false, false, false, false, false, false, false, undefined, "", "");
 }