fix #365

Author: DonJayamanne

src/client/extension.ts

@@ -16,12 +16,14 @@ import * as telemetryHelper from './common/telemetry';
 import * as telemetryContracts from './common/telemetryContracts';
 import { activateSimplePythonRefactorProvider } from './providers/simpleRefactorProvider';
 import { activateSetInterpreterProvider } from './providers/setInterpreterProvider';
+import { CommentNewLineFormatProvider } from './providers/commentNewLineFormatProvider';
 import { activateExecInTerminalProvider } from './providers/execInTerminalProvider';
 import * as tests from './unittests/main';
 import * as jup from './jupyter/main';
 import { HelpProvider } from './helpProvider';
 import { activateFormatOnSaveProvider } from './providers/formatOnSaveProvider';
 import { WorkspaceSymbols } from './workspaceSymbols/main';
+import * as os from 'os';
 
 const PYTHON: vscode.DocumentFilter = { language: 'python', scheme: 'file' };
 let unitTestOutChannel: vscode.OutputChannel;
@@ -88,7 +90,11 @@ export function activate(context: vscode.ExtensionContext) {
     tests.activate(context, unitTestOutChannel);
 
     context.subscriptions.push(new WorkspaceSymbols(lintingOutChannel));
-    
+
+    // In case we have CR LF
+    const triggerCharacters: string[] = os.EOL.split('');
+    triggerCharacters.shift();
+    context.subscriptions.push(vscode.languages.registerOnTypeFormattingEditProvider(PYTHON, new CommentNewLineFormatProvider(), os.EOL.substring(0, 1), ...triggerCharacters));
     const hepProvider = new HelpProvider();
     context.subscriptions.push(hepProvider);
 }

src/client/providers/commentNewLineFormatProvider.ts

@@ -0,0 +1,23 @@
+import { OnTypeFormattingEditProvider, TextEdit, TextDocument, FormattingOptions, CancellationToken, Position } from 'vscode';
+
+export class CommentNewLineFormatProvider implements OnTypeFormattingEditProvider {
+    provideOnTypeFormattingEdits(document: TextDocument, position: Position, ch: string,
+        options: FormattingOptions, token: CancellationToken): TextEdit[] {
+
+        if (position.line === 0) {
+            return [];
+        }
+        const previousLine = document.lineAt(position.line - 1).text;
+        const trimmedLine = previousLine.trim();
+        if (!trimmedLine.startsWith('#') || document.lineAt(position.line).text.trim().length === 0) {
+            return [];
+        }
+        const index = previousLine.indexOf('#');
+        const leftOvers = previousLine.substring(index + 1).trim();
+        const additionalSpaces = previousLine.indexOf(leftOvers) - index - 1;
+        const spaces = Array(additionalSpaces).fill(' ');
+        return [
+            TextEdit.insert(position, "#" + spaces.join(''))
+        ];
+    }
+}