Fix: Indent after oneCommandCode on comment, block comment, empty line. Formatting inside block comment.

README.md

@@ -27,6 +27,7 @@ AHK++ is a fork of [AutoHotkey Plus by cweijan](https://github.com/AutoHotkey-Pl
     -   [Find References](#find-symbol-references)
     -   [Hover Tip](#hover-tip)
     -   [Code Format](#code-format)
+    -   [Formatter Directives](#formatter-directives)
 -   [Credits](#credits)
 
 ## Why AutoHotkey Plus Plus?
@@ -111,6 +112,16 @@ Supports standard VS Code formatting.
 
 ![Code Format](image/codeFormat.jpg)
 
+### Formatter Directives
+
+```autohotkey
+;@AHK++FormatBlockCommentOn
+/*
+;All text inside block comment will be formatted like regular code.
+*/
+;@AHK++FormatBlockCommentOff
+```
+
 ## Credits
 
 Previous extensions:

package.json

@@ -279,6 +279,10 @@
             {
                 "language": "ahk",
                 "path": "./snippets/ahk.json"
+            },
+            {
+                "language": "ahk",
+                "path": "./snippets/ahk++.json"
             }
         ]
     },

snippets/ahk++.json

@@ -0,0 +1,10 @@
+{
+    "FormatBlockCommentOn": {
+        "prefix": "@AHK++FormatBlockCommentOn",
+        "body": ";@AHK++FormatBlockCommentOn"
+    },
+    "FormatBlockCommentOff": {
+        "prefix": "@AHK++FormatBlockCommentOff",
+        "body": ";@AHK++FormatBlockCommentOff"
+    }
+}

src/providers/formattingProvider.ts

@@ -2,6 +2,7 @@ import * as vscode from 'vscode';
 import { CodeUtil } from '../common/codeUtil';
 import { ConfigKey, Global } from '../common/global';
 import {
+    buildIndentedLine,
     hasMoreCloseParens,
     hasMoreOpenParens,
     removeEmptyLines,
@@ -59,7 +60,21 @@ export class FormatProvider implements vscode.DocumentFormattingEditProvider {
          */
         let oneCommandCode = false;
         let blockComment = false;
+        /** Base indent, that block comment had in original code */
+        let blockCommentIndent = '';
         let atTopLevel = true;
+        /** Formatter's directive:
+         * ```ahk
+         * ;@AHK++FormatBlockCommentOn
+         * ;@AHK++FormatBlockCommentOff
+         * ```
+         * Format text inside block comment like regular code */
+        let formatBlockComment = false;
+        // Save important values to this variables on block comment enter, restore them on exit
+        let preBlockCommentDepth = 0;
+        let preBlockCommentTagDepth = 0;
+        let preBlockCommentAtTopLevel = true;
+        let preBlockCommentOneCommandCode = false;
 
         const trimSpaces = Global.getConfig<boolean>(ConfigKey.trimExtraSpaces);
 
@@ -72,6 +87,8 @@ export class FormatProvider implements vscode.DocumentFormattingEditProvider {
             formattedLine = trimExtraSpaces(formattedLine, trimSpaces) // Remove extra spaces between words
                 .concat(comment) // Add removed single line comment back
                 .trim();
+            /** Line is empty or this is single comment line */
+            const emptyLine = purifiedLine === '';
 
             atTopLevel = true;
 
@@ -80,19 +97,71 @@ export class FormatProvider implements vscode.DocumentFormattingEditProvider {
 
             // This line
 
+            // Stop directives for formatter
+            if (emptyLine) {
+                if (comment.match(/;\s*@AHK\+\+FormatBlockCommentOff/i)) {
+                    formatBlockComment = false;
+                }
+            }
+
             // Block comments
-            if (originalLine.match(/ *\/\*/)) {
+            // The /* and */ symbols can be used to comment out an entire section,
+            // but only if the symbols appear at the beginning of a line (excluding whitespace),
+            // as in this example:
+            // /*
+            // MsgBox, This line is commented out (disabled).
+            // MsgBox, Common mistake: */ this does not end the comment.
+            // MsgBox, This line is commented out.
+            // */
+            if (!blockComment && originalLine.match(/^\s*\/\*/)) {
+                // found start '/*' pattern
                 blockComment = true;
+                // Save first capture group (original indent)
+                blockCommentIndent = originalLine.match(/(^\s*)\/\*/)?.[1];
+                if (formatBlockComment) {
+                    // save indent values on block comment enter
+                    preBlockCommentDepth = depth;
+                    preBlockCommentTagDepth = tagDepth;
+                    preBlockCommentAtTopLevel = atTopLevel;
+                    preBlockCommentOneCommandCode = oneCommandCode;
+                    // reset indent values to default values with added current 'depth' indent
+                    oneCommandCode = false;
+                }
             }
-            if (originalLine.match(/ *\*\//)) {
-                blockComment = false;
-            }
+
             if (blockComment) {
-                formattedDocument += originalLine;
-                if (lineIndex !== document.lineCount - 1) {
-                    formattedDocument += '\n';
+                // Save block comment line only if user don't want format it content
+                if (!formatBlockComment) {
+                    let blockCommentLine = '';
+                    if (originalLine.startsWith(blockCommentIndent)) {
+                        blockCommentLine = originalLine.substring(
+                            blockCommentIndent.length,
+                        );
+                    } else {
+                        blockCommentLine = originalLine;
+                    }
+                    formattedDocument += buildIndentedLine(
+                        lineIndex,
+                        document.lineCount,
+                        blockCommentLine,
+                        depth,
+                        options,
+                    );
+                }
+                if (originalLine.match(/^\s*\*\//)) {
+                    // found end '*/' pattern
+                    blockComment = false;
+                    if (formatBlockComment) {
+                        // restore indent values on block comment exit
+                        depth = preBlockCommentDepth;
+                        tagDepth = preBlockCommentTagDepth;
+                        atTopLevel = preBlockCommentAtTopLevel;
+                        oneCommandCode = preBlockCommentOneCommandCode;
+                    }
+                }
+                if (!formatBlockComment) {
+                    continue;
                 }
-                continue;
             }
 
             // #IfWinActive, #IfWinNotActive
@@ -162,28 +231,48 @@ export class FormatProvider implements vscode.DocumentFormattingEditProvider {
             if (depth < 0) {
                 depth = 0;
             }
-
-            // Add the indented line to the file
-            const indentationChars = options.insertSpaces
-                ? ' '.repeat(depth * options.tabSize)
-                : '\t'.repeat(depth);
-            formattedDocument += !formattedLine?.trim()
-                ? formattedLine
-                : indentationChars + formattedLine;
-
-            // If not last line, add newline
-            if (lineIndex !== document.lineCount - 1) {
-                formattedDocument += '\n';
+            if (preBlockCommentDepth < 0) {
+                preBlockCommentDepth = 0;
             }
 
+            // Save indented line
+            formattedDocument += buildIndentedLine(
+                lineIndex,
+                document.lineCount,
+                formattedLine,
+                depth,
+                options,
+            );
+
             // Next line
 
+            // Start directives for formatter
+            if (emptyLine) {
+                if (comment.match(/;\s*@AHK\+\+FormatBlockCommentOn/i)) {
+                    formatBlockComment = true;
+                }
+            }
+
             // One command code
-            if (oneCommandCode) {
+            if (
+                oneCommandCode &&
+                // Don't change indentation on empty lines (single line comment is equal to empty line) after one command code.
+                !emptyLine &&
+                // Don't change indentation on block comment after one command code.
+                // Change indentation inside block comment, if user wants to format block comment.
+                (!blockComment || formatBlockComment)
+            ) {
                 oneCommandCode = false;
                 depth--;
             }
 
+            // Block comments
+            // Must be after 'One command code' check, because it reset flag 'blockComment' that tests there!
+            // if (blockComment && originalLine.match(/^\s*\*\//)) {
+            //     // found end '*/' pattern
+            //     blockComment = false;
+            // }
+
             // #IfWinActive, #IfWinNotActive
             if (
                 purifiedLine.match(/#ifwinactive.*?\s/) ||

src/providers/formattingProvider.utils.ts

@@ -1,3 +1,57 @@
+import * as vscode from 'vscode';
+
+/**
+ * Build indentation chars
+ * @param depth Depth of indent
+ * @param options VS Code formatting options
+ */
+export function buildIndentationChars(
+    depth: number,
+    options: Pick<vscode.FormattingOptions, 'insertSpaces' | 'tabSize'>,
+): string {
+    return options.insertSpaces
+        ? ' '.repeat(depth * options.tabSize)
+        : '\t'.repeat(depth);
+}
+
+/**
+ * Build indented line of code (not ready for saving)
+ * @param indentationChars Indentation chars
+ * @param formattedLine Formatted line of code
+ */
+export function buildIndentedString(
+    indentationChars: string,
+    formattedLine: string,
+): string {
+    return !formattedLine?.trim()
+        ? formattedLine
+        : indentationChars + formattedLine;
+}
+
+/**
+ * Build indented line of code (ready for saving)
+ * @param lineIndex Line index of passed formattedLine
+ * @param lastLineIndex Index of last line of document
+ * @param formattedLine Formatted line of code
+ * @param depth Depth of indent
+ * @param options VS Code formatting options
+ */
+export function buildIndentedLine(
+    lineIndex: number,
+    lastLineIndex: number,
+    formattedLine: string,
+    depth: number,
+    options: Pick<vscode.FormattingOptions, 'insertSpaces' | 'tabSize'>,
+) {
+    const indentationChars = buildIndentationChars(depth, options);
+    let indentedLine = buildIndentedString(indentationChars, formattedLine);
+    // If not last line, add newline
+    if (lineIndex !== lastLineIndex - 1) {
+        indentedLine += '\n';
+    }
+    return indentedLine;
+}
+
 /** @return true iff this line has more closing parens than opening parens (round brackets) */
 export function hasMoreCloseParens(line: string): boolean {
     if (!line.includes(')')) {

src/test/suite/format/format.test.ts

@@ -22,9 +22,11 @@ const formatTests: FormatTest[] = [
     { filenameRoot: '40-command-inside-text' },
     { filenameRoot: '56-return-command-after-label' },
     { filenameRoot: '58-parentheses-indentation' },
+    { filenameRoot: '59-one-command-indentation' },
     { filenameRoot: '72-paren-hotkey' },
     { filenameRoot: '119-semicolon-inside-string' },
     { filenameRoot: '180-if-else-braces' },
+    { filenameRoot: '185-block-comment' },
     { filenameRoot: '188-one-command-code-in-text' },
     { filenameRoot: '189-space-at-end-of-line' },
     { filenameRoot: 'ahk-explorer' },

src/test/suite/format/samples/185-block-comment.in.ahk

@@ -0,0 +1,39 @@
+; [Issue #185](https://github.com/mark-wiemer/vscode-autohotkey-plus-plus/issues/185)
+foo () {
+;@AHK++FormatBlockCommentOn
+/*
+typedef struct TEST {
+DWORD cbSize ; 0
+} CMINVOKECOMMANDINFOEX;
+*/
+/*
+MsgBox, This line is commented out (disabled).
+MsgBox, Common mistake: */ this does not end the comment.
+MsgBox, This line is commented out.
+*/
+/*
+bar() {
+Loop, 4 {
+MsgBox % A_Index
+}
+if (true) {
+SoundBeep
+} else {
+MsgBox
+}
+}
+if (true)
+ToolTip
+MsgBox
+*/
+;@AHK++FormatBlockCommentOff
+MsgBox
+/*
+    All text in this block comment must save original indent
+bar() {
+        Loop, 4 {
+                MsgBox % A_Index
+        }
+}
+*/
+}

src/test/suite/format/samples/185-block-comment.out.ahk

@@ -0,0 +1,39 @@
+; [Issue #185](https://github.com/mark-wiemer/vscode-autohotkey-plus-plus/issues/185)
+foo () {
+    ;@AHK++FormatBlockCommentOn
+    /*
+    typedef struct TEST {
+        DWORD cbSize ; 0
+    } CMINVOKECOMMANDINFOEX;
+    */
+    /*
+    MsgBox, This line is commented out (disabled).
+    MsgBox, Common mistake: */ this does not end the comment.
+    MsgBox, This line is commented out.
+    */
+    /*
+    bar() {
+        Loop, 4 {
+            MsgBox % A_Index
+        }
+        if (true) {
+            SoundBeep
+        } else {
+            MsgBox
+        }
+    }
+    if (true)
+        ToolTip
+    MsgBox
+    */
+    ;@AHK++FormatBlockCommentOff
+    MsgBox
+    /*
+        All text in this block comment must save original indent
+    bar() {
+            Loop, 4 {
+                    MsgBox % A_Index
+            }
+    }
+    */
+}

src/test/suite/format/samples/59-one-command-indentation.in.ahk

@@ -0,0 +1,11 @@
+; [Issue #59](https://github.com/mark-wiemer/vscode-autohotkey-plus-plus/issues/59)
+if (true)
+
+; comment
+/*
+comment
+*/
+success = 1
+else
+success = 1
+failure = 0