Fix indent after Hotkey:: and optimize #Directive code (#304)

Closes #303
mark-wiemer · Jan 18, 2023 · 80d66ba · 80d66ba
1 parent 664dd75
commit 80d66ba
Show file tree

Hide file tree

Showing 12 changed files with 95 additions and 69 deletions.
diff --git a/src/providers/formattingProvider.ts b/src/providers/formattingProvider.ts
@@ -235,21 +235,6 @@ export const internalFormat = (
      */
     let openBraceObjectDepth = -1;
 
-    // OTHER
-    /**
-     * This line is `#Directive`, that will create context-sensitive hotkeys
-     * and hotstrings.
-     * Example of `#Directives`:
-     * ```ahk
-     * #IfWinActive WinTitle
-     * #IfWinNotActive WinTitle
-     * #IfWinExist WinTitle
-     * #IfWinNotExist WinTitle
-     * #If Expression
-     * ```
-     */
-    let sharpDirectiveLine = false;
-
     // BLOCK COMMENT
     /** This line is block comment */
     let blockComment = false;
@@ -306,6 +291,12 @@ export const internalFormat = (
      * Example: `Label:`
      */
     const label = /^[^\s\t,`]+:$/;
+    /**
+     * Hotkey and hotstring without code after it.
+     *
+     * Example: `F1 & F2 Up::` (hotkey), `::btw::` (hotstring)
+     */
+    const hotkey = /^.*::$/;
     /**
      * `#Directive`, that will create context-sensitive hotkeys and hotstrings.
      * Example of `#Directives`:
@@ -340,7 +331,6 @@ export const internalFormat = (
         const emptyLine = purifiedLine === '';
 
         detectOneCommandCode = true;
-        sharpDirectiveLine = false;
 
         const openBraceNum = braceNumber(purifiedLine, '{');
         const closeBraceNum = braceNumber(purifiedLine, '}');
@@ -695,33 +685,17 @@ export const internalFormat = (
             }
         }
 
-        // #DIRECTIVE without parameters
-        // #IfWinActive WinTitle
-        //     Hotkey::
-        // #If <-- de-indent #Directive without parameters
-        if (purifiedLine.match('^' + sharpDirective + '$')) {
-            if (indentCodeAfterSharpDirective) {
-                if (tagDepth > 0) {
-                    depth -= tagDepth;
-                } else {
-                    depth--;
-                }
-            }
-        }
-
-        // #DIRECTIVE with parameters
+        // #DIRECTIVE
         // #IfWinActive WinTitle1
         //     Hotkey::
         // #IfWinActive WinTitle2 <-- fall-through scenario for #Directive with
         //     Hotkey::                                               parameters
-        if (purifiedLine.match('^' + sharpDirective + '\\b.+')) {
-            if (indentCodeAfterSharpDirective) {
-                if (tagDepth > 0) {
-                    depth -= tagDepth;
-                } else {
-                    depth--;
-                }
-                sharpDirectiveLine = true;
+        // #If                    <-- de-indent #Directive without parameters
+        if (purifiedLine.match('^' + sharpDirective + '\\b')) {
+            if (tagDepth > 0) {
+                depth -= tagDepth;
+            } else {
+                depth--;
             }
         }
 
@@ -737,13 +711,13 @@ export const internalFormat = (
             depth--;
         }
 
-        // SWITCH-CASE-DEFAULT or LABEL:
+        // SWITCH-CASE-DEFAULT or LABEL: or HOTKEY::
         if (purifiedLine.match(switchCaseDefault)) {
             // Case: or Default:
             depth--;
-        } else if (purifiedLine.match(label)) {
-            // Label:
+        } else if (purifiedLine.match(label) || purifiedLine.match(hotkey)) {
             if (indentCodeAfterLabel) {
+                // Label: or Hotkey::
                 // De-indent label or hotkey, if they not end with 'return'
                 // command.
                 // This is fall-through scenario. Example:
@@ -864,22 +838,27 @@ export const internalFormat = (
         // #DIRECTIVE with parameters
         // #If Expression <-- indent next line after '#Directive'
         //     F1:: MsgBox Help
-        if (sharpDirectiveLine && indentCodeAfterSharpDirective) {
+        if (
+            purifiedLine.match('^' + sharpDirective + '\\b.+') &&
+            indentCodeAfterSharpDirective
+        ) {
             depth++;
         }
 
-        // SWITCH-CASE-DEFAULT or LABEL:
+        // SWITCH-CASE-DEFAULT or LABEL: or HOTKEY::
         if (purifiedLine.match(switchCaseDefault)) {
             // Case: or Default: <-- indent next line
             //     code
             depth++;
             // Do not sync here 'tagDepth' with 'depth' to prevent 'Return' and
             // 'ExitApp' to de-indent inside 'Switch-Case-Default' construction!
-        } else if (purifiedLine.match(label) && indentCodeAfterLabel) {
-            // Label: <-- indent next line
-            //     code
-            depth++;
-            tagDepth = depth;
+        } else if (purifiedLine.match(label) || purifiedLine.match(hotkey)) {
+            if (indentCodeAfterLabel) {
+                // Label: or Hotkey:: <-- indent next line
+                //     code
+                depth++;
+                tagDepth = depth;
+            }
         }
 
         // CONTINUATION SECTION: Expression, Object

diff --git a/src/test/suite/format/format.test.ts b/src/test/suite/format/format.test.ts
@@ -90,6 +90,7 @@ const formatTests: FormatTest[] = [
         options: { insertSpaces: false },
     },
     { filenameRoot: 'legacy-text-sharp-directive' },
+    { filenameRoot: 'label-combination' },
     { filenameRoot: 'label-fall-through' },
     { filenameRoot: 'label-specific-name' },
     { filenameRoot: 'return-exit-exitapp' },

diff --git a/src/test/suite/format/samples/hotstring.in.ahk b/src/test/suite/format/samples/hotstring.in.ahk
@@ -0,0 +1,10 @@
+::btw::by the way
+code
+
+::btw::
+code
+return
+
+:*b0:<em>::
+code
+return
diff --git a/src/test/suite/format/samples/hotstring.out.ahk b/src/test/suite/format/samples/hotstring.out.ahk
@@ -0,0 +1,10 @@
+::btw::by the way
+code
+
+::btw::
+    code
+return
+
+:*b0:<em>::
+    code
+return
diff --git a/src/test/suite/format/samples/indent-code-after-label-false.in.ahk b/src/test/suite/format/samples/indent-code-after-label-false.in.ahk
@@ -1,5 +1,3 @@
-Label1:
+Label:
 MsgBox
-Label2:
-SoundBeep
 return
diff --git a/src/test/suite/format/samples/indent-code-after-label-false.out.ahk b/src/test/suite/format/samples/indent-code-after-label-false.out.ahk
@@ -1,5 +1,3 @@
-Label1:
+Label:
 MsgBox
-Label2:
-SoundBeep
 return
diff --git a/src/test/suite/format/samples/indent-code-after-label-true.in.ahk b/src/test/suite/format/samples/indent-code-after-label-true.in.ahk
@@ -1,5 +1,3 @@
-Label1:
+Label:
 MsgBox
-Label2:
-SoundBeep
 return
diff --git a/src/test/suite/format/samples/indent-code-after-label-true.out.ahk b/src/test/suite/format/samples/indent-code-after-label-true.out.ahk
@@ -1,5 +1,3 @@
-Label1:
+Label:
     MsgBox
-Label2:
-    SoundBeep
 return
diff --git a/src/test/suite/format/samples/label-combination.in.ahk b/src/test/suite/format/samples/label-combination.in.ahk
@@ -0,0 +1,18 @@
+F1::code
+code
+
+!^+F1::
+code
+return
+
+F1 Up::
+code
+return
+
+F1 & F2::
+code
+return
+
+F1 & F2 Up::
+code
+return
diff --git a/src/test/suite/format/samples/label-combination.out.ahk b/src/test/suite/format/samples/label-combination.out.ahk
@@ -0,0 +1,18 @@
+F1::code
+code
+
+!^+F1::
+    code
+return
+
+F1 Up::
+    code
+return
+
+F1 & F2::
+    code
+return
+
+F1 & F2 Up::
+    code
+return
diff --git a/src/test/suite/format/samples/label-specific-name.in.ahk b/src/test/suite/format/samples/label-specific-name.in.ahk
@@ -1,10 +1,9 @@
-GoTo, If
-ExitApp
+If:
+GoTo Loop
+return
 
 Else:
 GoTo Loop
-If:
-GoTo Loop
 return
 
 Loop:

diff --git a/src/test/suite/format/samples/label-specific-name.out.ahk b/src/test/suite/format/samples/label-specific-name.out.ahk
@@ -1,10 +1,9 @@
-GoTo, If
-ExitApp
+If:
+    GoTo Loop
+return
 
 Else:
     GoTo Loop
-If:
-    GoTo Loop
 return
 
 Loop: