Began adding black formatter

Author: jarshwah

package.json

@@ -1415,7 +1415,8 @@
                     "enum": [
                         "autopep8",
                         "yapf",
-                        "none"
+                        "none",
+                        "black"
                     ],
                     "scope": "resource"
                 },
@@ -1431,6 +1432,12 @@
                     "description": "Path to yapf, you can use a custom version of yapf by modifying this setting to include the full path.",
                     "scope": "resource"
                 },
+                "python.formatting.blackPath": {
+                    "type": "string",
+                    "default": "black",
+                    "description": "Path to black, you can use a custom version of black by modifying this setting to include the full path.",
+                    "scope": "resource"
+                },
                 "python.formatting.autopep8Args": {
                     "type": "array",
                     "description": "Arguments passed in. Each argument is a separate item in the array.",
@@ -1449,6 +1456,15 @@
                     },
                     "scope": "resource"
                 },
+                "python.formatting.blackArgs": {
+                    "type": "array",
+                    "description": "Arguments passed in. Each argument is a separate item in the array.",
+                    "default": [],
+                    "items": {
+                        "type": "string"
+                    },
+                    "scope": "resource"
+                },
                 "python.autoComplete.preloadModules": {
                     "type": "array",
                     "items": {

src/client/common/types.ts

@@ -62,7 +62,8 @@ export enum Product {
     unittest = 12,
     ctags = 13,
     rope = 14,
-    isort = 15
+    isort = 15,
+    black = 16
 }
 
 export enum ModuleNamePurpose {
@@ -192,6 +193,8 @@ export interface IFormattingSettings {
     readonly autopep8Args: string[];
     yapfPath: string;
     readonly yapfArgs: string[];
+    blackPath: string;
+    readonly blackArgs: string[];
 }
 export interface IAutoCompeteSettings {
     readonly addBrackets: boolean;

src/client/formatters/blackFormatter.ts

@@ -0,0 +1,37 @@
+// Copyright (c) Microsoft Corporation. All rights reserved.
+// Licensed under the MIT License.
+
+'use strict';
+
+import * as vscode from 'vscode';
+import { StopWatch } from '../common/stopWatch';
+import { IConfigurationService, Product } from '../common/types';
+import { IServiceContainer } from '../ioc/types';
+import { sendTelemetryWhenDone } from '../telemetry';
+import { FORMAT } from '../telemetry/constants';
+import { BaseFormatter } from './baseFormatter';
+
+export class BlackFormatter extends BaseFormatter {
+    constructor(serviceContainer: IServiceContainer) {
+        super('black', Product.black, serviceContainer);
+    }
+
+    public formatDocument(document: vscode.TextDocument, options: vscode.FormattingOptions, token: vscode.CancellationToken, range?: vscode.Range): Thenable<vscode.TextEdit[]> {
+        const stopWatch = new StopWatch();
+        const settings = this.serviceContainer.get<IConfigurationService>(IConfigurationService).getSettings(document.uri);
+        const hasCustomArgs = Array.isArray(settings.formatting.blackArgs) && settings.formatting.blackArgs.length > 0;
+        const formatSelection = false; // range ? !range.isEmpty : false;
+
+        const args = [];
+        // if (formatSelection) {
+        //     // tslint:disable-next-line:no-non-null-assertion
+        //     args.push(...['--lines', `${range!.start.line + 1}-${range!.end.line + 1}`]);
+        // }
+        // Yapf starts looking for config file starting from the file path.
+        const fallbarFolder = this.getWorkspaceUri(document).fsPath;
+        const cwd = this.getDocumentPath(document, fallbarFolder);
+        const promise = super.provideDocumentFormattingEdits(document, options, token, args, cwd);
+        sendTelemetryWhenDone(FORMAT, promise, stopWatch, { tool: 'black', hasCustomArgs, formatSelection });
+        return promise;
+    }
+}

src/client/formatters/types.ts

@@ -6,7 +6,7 @@ import { ExecutionInfo, IFormattingSettings, Product } from '../common/types';
 
 export const IFormatterHelper = Symbol('IFormatterHelper');
 
-export type FormatterId = 'autopep8' | 'yapf';
+export type FormatterId = 'autopep8' | 'yapf' | 'black';
 
 export type FormatterSettingsPropertyNames = {
     argsName: keyof IFormattingSettings;

src/client/providers/formatProvider.ts

@@ -8,6 +8,7 @@ import { IConfigurationService } from '../common/types';
 import { IServiceContainer } from '../ioc/types';
 import { AutoPep8Formatter } from './../formatters/autoPep8Formatter';
 import { BaseFormatter } from './../formatters/baseFormatter';
+import { BlackFormatter } from './../formatters/blackFormatter';
 import { DummyFormatter } from './../formatters/dummyFormatter';
 import { YapfFormatter } from './../formatters/yapfFormatter';
 
@@ -27,16 +28,18 @@ export class PythonFormattingEditProvider implements vscode.DocumentFormattingEd
     public constructor(context: vscode.ExtensionContext, serviceContainer: IServiceContainer) {
         const yapfFormatter = new YapfFormatter(serviceContainer);
         const autoPep8 = new AutoPep8Formatter(serviceContainer);
+        const blackFormatter = new BlackFormatter(serviceContainer);
         const dummy = new DummyFormatter(serviceContainer);
         this.formatters.set(yapfFormatter.Id, yapfFormatter);
         this.formatters.set(autoPep8.Id, autoPep8);
+        this.formatters.set(blackFormatter.Id, blackFormatter);
         this.formatters.set(dummy.Id, dummy);
 
         this.commands = serviceContainer.get<ICommandManager>(ICommandManager);
         this.workspace = serviceContainer.get<IWorkspaceService>(IWorkspaceService);
         this.documentManager = serviceContainer.get<IDocumentManager>(IDocumentManager);
         this.config = serviceContainer.get<IConfigurationService>(IConfigurationService);
-        this.disposables.push(this.documentManager.onDidSaveTextDocument(async document => await this.onSaveDocument(document)));
+        this.disposables.push(this.documentManager.onDidSaveTextDocument(async document => this.onSaveDocument(document)));
     }
 
     public dispose() {

src/client/telemetry/types.ts

@@ -7,7 +7,7 @@ export type EditorLoadTelemetry = {
     condaVersion: string;
 };
 export type FormatTelemetry = {
-    tool: 'autopep8' | 'yapf';
+    tool: 'autopep8' | 'yapf' | 'black';
     hasCustomArgs: boolean;
     formatSelection: boolean;
 };

yarn.lock

@@ -1826,7 +1826,7 @@ gulp-untar@^0.0.6:
     tar "^2.2.1"
     through2 "~2.0.3"
 
-gulp-util@^3.0.0, gulp-util@^3.0.7, gulp-util@~3.0.0, gulp-util@~3.0.7, gulp-util@~3.0.8:
+gulp-util@^3.0.0, gulp-util@^3.0.7, gulp-util@~3.0.8:
   version "3.0.8"
   resolved "https://registry.yarnpkg.com/gulp-util/-/gulp-util-3.0.8.tgz#0054e1e744502e27c04c187c3ecc505dd54bbb4f"
   dependencies:
@@ -3904,7 +3904,7 @@ ret@~0.1.10:
   version "0.1.15"
   resolved "https://registry.yarnpkg.com/ret/-/ret-0.1.15.tgz#b8a4825d5bdb1fc3f6f53c2bc33f81388681c7bc"
 
-retyped-diff-match-patch-tsd-ambient@^1.0.0-1:
+retyped-diff-match-patch-tsd-ambient@^1.0.0-0:
   version "1.0.0-1"
   resolved "https://registry.yarnpkg.com/retyped-diff-match-patch-tsd-ambient/-/retyped-diff-match-patch-tsd-ambient-1.0.0-1.tgz#26482bf4915c7ed9f8300bb5cbec48fd4ff5bc62"