Add onEnterRule to split long comments

When pressing ENTER in the middle of an Ada comment, a comment tag
will now automatically be added to the next line.

This is useful to split comments that exceeds the line characters'
limit.

For eng/ide/ada_language_server#1662

Author: AnthonyLeonardoGracio

CHANGELOG.md

@@ -5,6 +5,8 @@ section below it for the last release. -->
 
 ## \<next>
 
+* Added `onEnterRules` for Ada/GPR files to split long comments by adding automatically a comment tag to the next line
+
 ## 26.0.202504171
 
 * Various improvements and bug fixes related to the GNATcoverage integration

integration/vscode/ada/gpr-language-configuration.json

@@ -4,9 +4,7 @@
         "lineComment": "--"
     },
     // symbols used as brackets
-    "brackets": [
-        ["(", ")"]
-    ],
+    "brackets": [["(", ")"]],
     // symbols that are auto closed when typing
     "autoClosingPairs": [
         ["(", ")"],
@@ -16,5 +14,22 @@
     "surroundingPairs": [
         ["(", ")"],
         ["\"", "\""]
+    ],
+    // Used to split long comments easily: when a user presses ENTER
+    // in the middle of a GPR comment, '--  ' will automatically be added
+    // to the next line.
+    "onEnterRules": [
+        {
+            "beforeText": {
+                "pattern": "--\\s+"
+            },
+            "afterText": {
+                "pattern": "\\S+"
+            },
+            "action": {
+                "indent": "none",
+                "appendText": "--  "
+            }
+        }
     ]
-}
+}

integration/vscode/ada/language-configuration.json

@@ -4,9 +4,7 @@
         "lineComment": "-- "
     },
     // symbols used as brackets
-    "brackets": [
-        ["(", ")"]
-    ],
+    "brackets": [["(", ")"]],
     // symbols that are auto closed when typing
     "autoClosingPairs": [
         ["<<", ">>"],
@@ -23,5 +21,22 @@
         ["(", ")"],
         ["\"", "\""],
         ["'", "'"]
+    ],
+    // Used to split long comments easily: when a user presses ENTER
+    // in the middle of an Ada comment, '--  ' will automatically be added
+    // to the next line.
+    "onEnterRules": [
+        {
+            "beforeText": {
+                "pattern": "--\\s+"
+            },
+            "afterText": {
+                "pattern": "\\S+"
+            },
+            "action": {
+                "indent": "none",
+                "appendText": "--  "
+            }
+        }
     ]
 }

integration/vscode/ada/test/general/extension.test.ts

@@ -1,7 +1,7 @@
 import * as assert from 'assert';
 import { adaExtState } from '../../src/extension';
 import { getObjectDir, TERMINAL_ENV_SETTING_NAME } from '../../src/helpers';
-import { activate, assertEqualToFileContent } from '../utils';
+import { activate, assertEqualToFileContent, showTextDocument } from '../utils';
 
 import { readFileSync, writeFileSync } from 'fs';
 import * as vscode from 'vscode';
@@ -212,4 +212,30 @@ suite('Extensions Test Suite', function () {
             throw new Error('No workspace folder found for the specified URI');
         }
     });
+
+    test('Split long comments on ENTER', async () => {
+        if (vscode.workspace.workspaceFolders !== undefined) {
+            // Get a file with a long comment (>80 chars)
+            const srcRelPath = ['src', 'split_comment.ads'];
+            const textEditor = await showTextDocument(...srcRelPath);
+
+            // Set the cursor in the middle of the long comment
+            const insertPos = new vscode.Position(0, 69);
+            textEditor.selection = new vscode.Selection(insertPos, insertPos);
+
+            // Simulate a keypress on the ENTER key
+            const inputText = '\n';
+            await vscode.commands.executeCommand('type', { text: inputText });
+
+            // Check that we now have two lines, and that the second line
+            // starts with the '--  ' comment tag
+            const text = textEditor.document.getText() ?? '';
+            assert.strictEqual(
+                text,
+                "--  Used to test the VS Code extension 'onEnterRule' that splits long\n" +
+                    '--   comments when pressing ENTER\n',
+                `Wrong text in the editor after pressing ENTER in the middle of a comment`,
+            );
+        }
+    });
 });

integration/vscode/ada/test/general/ws/src/split_comment.ads

@@ -0,0 +1 @@
+--  Used to test the VS Code extension 'onEnterRule' that splits long comments when pressing ENTER