Add isort CodeAction (sort imports on save) (#1926)

Fixes #156

Author: n6g7

news/1 Enhancements/156.md

@@ -0,0 +1 @@
+Add support for the `editor.codeActionsOnSave.source.organizeImports` setting (thanks [Nathan Gaberel](https://github.com/n6g7)).

src/client/extension.ts

@@ -40,6 +40,7 @@ import { IServiceContainer, IServiceManager } from './ioc/types';
 import { LinterCommands } from './linters/linterCommands';
 import { registerTypes as lintersRegisterTypes } from './linters/serviceRegistry';
 import { ILintingEngine } from './linters/types';
+import { PythonCodeActionProvider } from './providers/codeActionsProvider';
 import { PythonFormattingEditProvider } from './providers/formatProvider';
 import { LinterProvider } from './providers/linterProvider';
 import { PythonRenameProvider } from './providers/renameProvider';
@@ -145,6 +146,8 @@ export async function activate(context: ExtensionContext) {
     context.subscriptions.push(new TerminalProvider(serviceContainer));
     context.subscriptions.push(new WorkspaceSymbols(serviceContainer));
 
+    context.subscriptions.push(languages.registerCodeActionsProvider(PYTHON, new PythonCodeActionProvider()));
+
     type ConfigurationProvider = BaseConfigurationProvider<LaunchRequestArguments, AttachRequestArguments>;
     serviceContainer.getAll<ConfigurationProvider>(IDebugConfigurationProvider).forEach(debugConfig => {
         context.subscriptions.push(debug.registerDebugConfigurationProvider(debugConfig.debugType, debugConfig));

src/client/providers/codeActionsProvider.ts

@@ -0,0 +1,21 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+'use strict';
+
+import * as vscode from 'vscode';
+
+export class PythonCodeActionProvider implements vscode.CodeActionProvider {
+    public provideCodeActions(document: vscode.TextDocument, range: vscode.Range, context: vscode.CodeActionContext, token: vscode.CancellationToken): vscode.ProviderResult<vscode.CodeAction[]> {
+        const sortImports = new vscode.CodeAction(
+            'Sort imports on save',
+            vscode.CodeActionKind.SourceOrganizeImports
+        );
+        sortImports.command = {
+            title: 'Sort imports',
+            command: 'python.sortImports'
+        };
+
+        return [sortImports];
+    }
+}

src/test/providers/codeActionsProvider.test.ts

@@ -0,0 +1,44 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+'use strict';
+
+import { expect } from 'chai';
+import * as TypeMoq from 'typemoq';
+import { CancellationToken, CodeActionContext, CodeActionKind, Range, TextDocument } from 'vscode';
+import { PythonCodeActionProvider } from '../../client/providers/codeActionsProvider';
+
+suite('CodeAction Provider', () => {
+    let codeActionsProvider: PythonCodeActionProvider;
+    let document: TypeMoq.IMock<TextDocument>;
+    let range: TypeMoq.IMock<Range>;
+    let context: TypeMoq.IMock<CodeActionContext>;
+    let token: TypeMoq.IMock<CancellationToken>;
+
+    setup(() => {
+        codeActionsProvider = new PythonCodeActionProvider();
+        document = TypeMoq.Mock.ofType<TextDocument>();
+        range = TypeMoq.Mock.ofType<Range>();
+        context = TypeMoq.Mock.ofType<CodeActionContext>();
+        token = TypeMoq.Mock.ofType<CancellationToken>();
+    });
+
+    test('Ensure it always returns a source.organizeImports CodeAction', async () => {
+        const codeActions = await codeActionsProvider.provideCodeActions(
+            document.object,
+            range.object,
+            context.object,
+            token.object
+        );
+
+        if (!codeActions) {
+            throw Error(`codeActionsProvider.provideCodeActions did not return an array (it returned ${codeActions})`);
+        }
+
+        const organizeImportsCodeAction = codeActions.filter(
+            codeAction => codeAction.kind === CodeActionKind.SourceOrganizeImports
+        );
+        expect(organizeImportsCodeAction).to.have.length(1);
+        expect(organizeImportsCodeAction[0].kind).to.eq(CodeActionKind.SourceOrganizeImports);
+    });
+});