use vscode formatOnSave instead of old hack

DonJayamanne · DonJayamanne · commit 1f4a384216c8 · 2016-10-17T21:25:59.000+11:00
diff --git a/package.json b/package.json
@@ -684,11 +684,6 @@
             "type": "string"
           }
         },
-        "python.formatting.formatOnSave": {
-          "type": "boolean",
-          "default": false,
-          "description": "Format the document upon saving."
-        },
         "python.formatting.outputWindow": {
           "type": "string",
           "default": "Python",
diff --git a/src/client/common/configSettings.ts b/src/client/common/configSettings.ts
@@ -65,7 +65,6 @@ export interface IFormattingSettings {
     autopep8Args: string[];
     yapfPath: string;
     yapfArgs: string[];
-    formatOnSave: boolean;
     outputWindow: string;
 }
 export interface IAutoCompeteSettings {
diff --git a/src/client/common/constants.ts b/src/client/common/constants.ts
@@ -78,6 +78,9 @@ export namespace Documentation {
         export const GettingStarted = '/docs/jupyter_getting-started/';
         export const Examples = '/docs/jupyter_examples/';
         export const Setup = '/docs/jupyter_prerequisites/';
-        export const VersionIncompatiblity = '/docs/troubleshooting_jupyter/#Incompatible-dependencies'
+        export const VersionIncompatiblity = '/docs/troubleshooting_jupyter/#Incompatible-dependencies';
+    }
+    export namespace Formatting {
+        export const FormatOnSave = '/docs/formatting/';
     }
 }
diff --git a/src/client/extension.ts b/src/client/extension.ts
@@ -1,27 +1,27 @@
 'use strict';
 
 import * as vscode from 'vscode';
-import {PythonCompletionItemProvider} from './providers/completionProvider';
-import {PythonHoverProvider} from './providers/hoverProvider';
-import {PythonDefinitionProvider} from './providers/definitionProvider';
-import {PythonReferenceProvider} from './providers/referenceProvider';
-import {PythonRenameProvider} from './providers/renameProvider';
-import {PythonFormattingEditProvider} from './providers/formatProvider';
+import { PythonCompletionItemProvider } from './providers/completionProvider';
+import { PythonHoverProvider } from './providers/hoverProvider';
+import { PythonDefinitionProvider } from './providers/definitionProvider';
+import { PythonReferenceProvider } from './providers/referenceProvider';
+import { PythonRenameProvider } from './providers/renameProvider';
+import { PythonFormattingEditProvider } from './providers/formatProvider';
 import * as sortImports from './sortImports';
-import {LintProvider} from './providers/lintProvider';
-import {PythonSymbolProvider} from './providers/symbolProvider';
-import {PythonSignatureProvider} from './providers/signatureProvider';
-import {activateFormatOnSaveProvider} from './providers/formatOnSaveProvider';
+import { LintProvider } from './providers/lintProvider';
+import { PythonSymbolProvider } from './providers/symbolProvider';
+import { PythonSignatureProvider } from './providers/signatureProvider';
 import * as settings from './common/configSettings';
 import * as telemetryHelper from './common/telemetry';
 import * as telemetryContracts from './common/telemetryContracts';
-import {PythonCodeActionsProvider} from './providers/codeActionProvider';
-import {activateSimplePythonRefactorProvider} from './providers/simpleRefactorProvider';
-import {activateSetInterpreterProvider} from './providers/setInterpreterProvider';
-import {activateExecInTerminalProvider} from './providers/execInTerminalProvider';
+import { PythonCodeActionsProvider } from './providers/codeActionProvider';
+import { activateSimplePythonRefactorProvider } from './providers/simpleRefactorProvider';
+import { activateSetInterpreterProvider } from './providers/setInterpreterProvider';
+import { activateExecInTerminalProvider } from './providers/execInTerminalProvider';
 import * as tests from './unittests/main';
 import * as jup from './jupyter/main';
-import {HelpProvider} from './helpProvider';
+import { HelpProvider } from './helpProvider';
+import { Documentation } from './common/constants';
 
 const PYTHON: vscode.DocumentFilter = { language: 'python', scheme: 'file' };
 let unitTestOutChannel: vscode.OutputChannel;
@@ -50,7 +50,6 @@ export function activate(context: vscode.ExtensionContext) {
     context.subscriptions.push(activateSetInterpreterProvider());
     context.subscriptions.push(...activateExecInTerminalProvider());
     activateSimplePythonRefactorProvider(context, formatOutChannel);
-    context.subscriptions.push(activateFormatOnSaveProvider(PYTHON, pythonSettings, formatOutChannel, vscode.workspace.rootPath));
 
     // Enable indentAction
     vscode.languages.setLanguageConfiguration(PYTHON.language, {
@@ -93,6 +92,16 @@ export function activate(context: vscode.ExtensionContext) {
 
     const hepProvider = new HelpProvider();
     context.subscriptions.push(hepProvider);
+
+    // Check for old outdated settings
+    const pySettings = vscode.workspace.getConfiguration('python');
+    if (pySettings.get('formatting.formatOnSave') === true) {
+        vscode.window.showInformationMessage(`'python.formatting.formatOnSave' has been deprecated. Please use 'editor.formatOnSave' instead`, 'Help').then(item => {
+            if (item === 'Help') {
+                vscode.commands.executeCommand('python.displayHelp', Documentation.Formatting.FormatOnSave);
+            }
+        });
+    }
 }
 
 function disableOtherDocumentSymbolsProvider() {
diff --git a/src/client/providers/formatOnSaveProvider.ts b/src/client/providers/formatOnSaveProvider.ts
diff --git a/src/test/extension.format.test.ts b/src/test/extension.format.test.ts
@@ -88,7 +88,7 @@ suite('Formatting', () => {
 
     function testAutoFormatting(formatter: string, formattedContents: string, fileToFormat: string): PromiseLike<void> {
         let textDocument: vscode.TextDocument;
-        pythonSettings.formatting.formatOnSave = true;
+        vscode.workspace.getConfiguration('editor').update('formatOnSave', true);
         pythonSettings.formatting.provider = formatter;
         return vscode.workspace.openTextDocument(fileToFormat).then(document => {
             textDocument = document;
@@ -103,7 +103,7 @@ suite('Formatting', () => {
             return new Promise<any>((resolve, reject) => {
                 setTimeout(() => {
                     resolve();
-                }, 2000);
+                }, 4000);
             });
         }).then(() => {
             assert.equal(textDocument.getText(), formattedContents, 'Formatted contents are not the same');

Original file line number	Diff line number	Diff line change
`@@ -65,7 +65,6 @@ export interface IFormattingSettings {`
`65`	`65`	`autopep8Args: string[];`
`66`	`66`	`yapfPath: string;`
`67`	`67`	`yapfArgs: string[];`
`68`		`- formatOnSave: boolean;`
`69`	`68`	`outputWindow: string;`
`70`	`69`	`}`
`71`	`70`	`export interface IAutoCompeteSettings {`
Original file line number	Diff line number	Diff line change
`@@ -78,6 +78,9 @@ export namespace Documentation {`
`78`	`78`	`export const GettingStarted = '/docs/jupyter_getting-started/';`
`79`	`79`	`export const Examples = '/docs/jupyter_examples/';`
`80`	`80`	`export const Setup = '/docs/jupyter_prerequisites/';`
`81`		`- export const VersionIncompatiblity = '/docs/troubleshooting_jupyter/#Incompatible-dependencies'`
	`81`	`+ export const VersionIncompatiblity = '/docs/troubleshooting_jupyter/#Incompatible-dependencies';`
	`82`	`+ }`
	`83`	`+ export namespace Formatting {`
	`84`	`+ export const FormatOnSave = '/docs/formatting/';`
`82`	`85`	`}`
`83`	`86`	`}`