Add the option for Roslyn LSP to support organize imports

Author: JoeRobich

package.json

@@ -739,6 +739,11 @@
             "default": true,
             "description": "%configuration.dotnet.autoInsert.enableAutoInsert%"
           },
+          "dotnet.formatting.organizeImportsOnFormat": {
+            "type": "boolean",
+            "default": false,
+            "description": "%configuration.dotnet.formatting.organizeImportsOnFormat%"
+          },
           "dotnet.typeMembers.memberInsertionLocation": {
             "type": "string",
             "enum": [
@@ -1696,11 +1701,6 @@
             "default": false,
             "description": "%configuration.omnisharp.enableLspDriver%"
           },
-          "omnisharp.organizeImportsOnFormat": {
-            "type": "boolean",
-            "default": false,
-            "description": "%configuration.omnisharp.organizeImportsOnFormat%"
-          },
           "omnisharp.enableAsyncCompletion": {
             "type": "boolean",
             "default": false,

package.nls.json

@@ -24,6 +24,7 @@
   "command.dotnet.test.debugTestsInContext": "Debug Tests in Context",
   "command.dotnet.restartServer": "Restart Language Server",
   "configuration.dotnet.autoInsert.enableAutoInsert": "Enable automatic insertion of documentation comments.",
+  "configuration.dotnet.formatting.organizeImportsOnFormat": "Specifies whether 'using' directives should be grouped and sorted during document formatting. (Previously `omnisharp.organizeImportsOnFormat`)",
   "configuration.dotnet.defaultSolution.description": "The path of the default solution to be opened in the workspace, or set to 'disable' to skip it. (Previously `omnisharp.defaultLaunchSolution`)",
   "configuration.dotnet.server.path": "Specifies the absolute path to the server (LSP or O#) executable. When left empty the version pinned to the C# Extension is used. (Previously `omnisharp.path`)",
   "configuration.dotnet.server.componentPaths": "Allows overriding the folder path for built in components of the language server (for example, override the .roslynDevKit path in the extension directory to use locally built components)",
@@ -116,7 +117,6 @@
   "configuration.omnisharp.enableEditorConfigSupport": "Enables support for reading code style, naming convention and analyzer settings from .editorconfig.",
   "configuration.omnisharp.enableDecompilationSupport": "Enables support for decompiling external references instead of viewing metadata.",
   "configuration.omnisharp.enableLspDriver": "Enables support for the experimental language protocol based engine (requires reload to setup bindings correctly)",
-  "configuration.omnisharp.organizeImportsOnFormat": "Specifies whether 'using' directives should be grouped and sorted during document formatting.",
   "configuration.omnisharp.enableAsyncCompletion": "(EXPERIMENTAL) Enables support for resolving completion edits asynchronously. This can speed up time to show the completion list, particularly override and partial method completion lists, at the cost of slight delays after inserting a completion item. Most completion items will have no noticeable impact with this feature, but typing immediately after inserting an override or partial method completion, before the insert is completed, can have unpredictable results.",
   "configuration.omnisharp.dotNetCliPaths": "Paths to a local download of the .NET CLI to use for running any user code.",
   "configuration.omnisharp.razor.plugin.path": "Overrides the path to the Razor plugin dll.",

src/omnisharp/server.ts

@@ -458,7 +458,7 @@ export class OmniSharpServer {
             args.push('FormattingOptions:EnableEditorConfigSupport=true');
         }
 
-        if (omnisharpOptions.organizeImportsOnFormat === true) {
+        if (commonOptions.organizeImportsOnFormat === true) {
             args.push('FormattingOptions:OrganizeImports=true');
         }
 

src/shared/migrateOptions.ts

@@ -100,6 +100,10 @@ export const migrateOptions = [
         oldName: 'dotnet.implementType.propertyGenerationBehavior',
         newName: 'dotnet.typeMembers.propertyGenerationBehavior',
     },
+    {
+        oldName: 'omnisharp.organizeImportsOnFormat',
+        newName: 'dotnet.formatting.organizeImportsOnFormat',
+    },
 ];
 
 export async function MigrateOptions(vscode: vscode): Promise<void> {

src/shared/options.ts

@@ -17,6 +17,7 @@ export interface CommonOptions {
     readonly defaultSolution: string;
     readonly unitTestDebuggingOptions: object;
     readonly runSettingsPath: string;
+    readonly organizeImportsOnFormat: boolean;
 }
 
 export interface OmnisharpServerOptions {
@@ -34,7 +35,6 @@ export interface OmnisharpServerOptions {
     readonly enableImportCompletion: boolean;
     readonly enableAsyncCompletion: boolean;
     readonly analyzeOpenDocumentsOnly: boolean;
-    readonly organizeImportsOnFormat: boolean;
     readonly disableMSBuildDiagnosticWarning: boolean;
     readonly showOmnisharpLogOnError: boolean;
     readonly minFindSymbolsFilterLength: number;
@@ -157,6 +157,9 @@ class CommonOptionsImpl implements CommonOptions {
     public get runSettingsPath() {
         return readOption<string>('dotnet.unitTests.runSettingsPath', '', 'omnisharp.testRunSettings');
     }
+    public get organizeImportsOnFormat() {
+        return readOption<boolean>('dotnet.formatting.organizeImportsOnFormat', false);
+    }
 }
 
 class OmnisharpOptionsImpl implements OmnisharpServerOptions {
@@ -227,9 +230,6 @@ class OmnisharpOptionsImpl implements OmnisharpServerOptions {
         const analyzeOpenDocumentsOnlyNewOption = diagnosticAnalysisScope == 'openFiles';
         return analyzeOpenDocumentsOnlyLegacyOption || analyzeOpenDocumentsOnlyNewOption;
     }
-    public get organizeImportsOnFormat() {
-        return readOption<boolean>('omnisharp.organizeImportsOnFormat', false);
-    }
     public get disableMSBuildDiagnosticWarning() {
         return readOption<boolean>('omnisharp.disableMSBuildDiagnosticWarning', false);
     }
@@ -483,7 +483,6 @@ export const OmnisharpOptionsThatTriggerReload: ReadonlyArray<keyof OmnisharpSer
     'enableEditorConfigSupport',
     'enableDecompilationSupport',
     'enableImportCompletion',
-    'organizeImportsOnFormat',
     'enableAsyncCompletion',
     'useModernNet',
     'enableLspDriver',

test/lsptoolshost/unitTests/configurationMiddleware.test.ts

@@ -267,6 +267,12 @@ const testData = [
         declareInPackageJson: true,
         section: editorBehaviorSection,
     },
+    {
+        serverOption: 'csharp|formatting.dotnet_formatting_sort_imports',
+        vsCodeConfiguration: 'dotnet.formatting.organizeImportsOnFormat',
+        declareInPackageJson: true,
+        section: editorBehaviorSection,
+    },
 ];
 
 describe('Server option name to vscode configuration name test', () => {