Add commands to create new Ada files

These commands are displayed under VS Code's 'File->New File...' toplevel
menu, providing file templates based on snippets for main and package
units.

For eng/ide/ada_language_server#1515

Author: AnthonyLeonardoGracio

integration/vscode/ada/package.json

@@ -768,6 +768,16 @@
             }
         ],
         "commands": [
+            {
+                "command": "ada.createNewAdaMainUnit",
+                "title": "Ada: Create Main Unit",
+                "shortTitle": "Ada Main Unit"
+            },
+            {
+                "command": "ada.createNewAdaPackage",
+                "title": "Ada: Create Package",
+                "shortTitle": "Ada Package"
+            },
             {
                 "command": "ada.otherFile",
                 "title": "Ada: Go to other file"
@@ -908,6 +918,16 @@
                     "when": "editorLangId == ada",
                     "group": "navigation@1"
                 }
+            ],
+            "file/newFile": [
+                {
+                    "command": "ada.createNewAdaMainUnit",
+                    "group": "ada"
+                },
+                {
+                    "command": "ada.createNewAdaPackage",
+                    "group": "ada"
+                }
             ]
         },
         "configurationDefaults": {

integration/vscode/ada/src/ExtensionState.ts

@@ -393,7 +393,7 @@ export class ExtensionState {
 
     /**
      *
-     * @returns the list of source directorues defined in the project loaded by the ALS
+     * @returns the list of source directories defined in the project loaded by the ALS
      */
     public async getSourceDirs(): Promise<ALSSourceDirDescription[]> {
         if (this.cachedSourceDirs === undefined) {

integration/vscode/ada/src/commands.ts

@@ -80,6 +80,16 @@ export function registerCommands(context: vscode.ExtensionContext, clients: Exte
         vscode.commands.registerCommand('ada.walkthroughStartDebugging', walkthroughStartDebugging),
     );
     context.subscriptions.push(vscode.commands.registerCommand('ada.otherFile', otherFileHandler));
+    context.subscriptions.push(
+        vscode.commands.registerCommand('ada.createNewAdaMainUnit', () =>
+            createNewAdaFile('Main Procedure'),
+        ),
+    );
+    context.subscriptions.push(
+        vscode.commands.registerCommand('ada.createNewAdaPackage', () =>
+            createNewAdaFile('Package Declaration or Body'),
+        ),
+    );
     context.subscriptions.push(
         vscode.commands.registerCommand('ada.subprogramBox', addSubprogramBoxCommand),
     );
@@ -429,6 +439,22 @@ async function buildAndRunMainAsk() {
     }
 }
 
+/**
+ * Handler for commands that create new Ada files.
+ * This function creates a new Ada editor, focus it, and insert the specified snippet.
+ * Used to proivide Ada file templates.
+ *
+ * @param snippetName - the name of the snippet to insert in the newly created editor.
+ */
+async function createNewAdaFile(snippetName: string) {
+    const doc = await vscode.workspace.openTextDocument({ language: 'ada' });
+    await vscode.window.showTextDocument(doc);
+    await vscode.commands.executeCommand('editor.action.insertSnippet', {
+        langId: 'ada',
+        name: snippetName,
+    });
+}
+
 //  Take active editor URI and call execute 'als-other-file' command in LSP
 const otherFileHandler = () => {
     const activeEditor = vscode.window.activeTextEditor;
@@ -458,11 +484,6 @@ const otherFileHandler = () => {
  * when missing directories
  */
 export async function checkSrcDirectories(atStartup = false, displayYesNoPopup = true) {
-    type ALSSourceDirDescription = {
-        name: string;
-        uri: string;
-    };
-
     const foldersInSettings = vscode.workspace.getConfiguration().get('folders');
     const doNotShowAgainKey = 'ada.addMissingDirsToWorkspace.doNotShowAgain';
     const doNotShowAgain = adaExtState.context.workspaceState.get(doNotShowAgainKey);

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

@@ -68,6 +68,45 @@ suite('Extensions Test Suite', function () {
             throw new Error('No workspace folder found for the specified URI');
         }
     });
+
+    test('New File - Ada Main', async () => {
+        if (vscode.workspace.workspaceFolders !== undefined) {
+            await vscode.commands.executeCommand('ada.createNewAdaMainUnit');
+            const activeEditor = vscode.window.activeTextEditor;
+            assert.strictEqual(
+                activeEditor?.document.languageId,
+                'ada',
+                'We should have a newly created Ada editor',
+            );
+            const text = activeEditor.document.getText() ?? '';
+            assert.strictEqual(
+                text.startsWith('procedure'),
+                true,
+                `We should have a main procedure snippet at the beginning ` +
+                    `of the new editor, but instead we have:\n\n${text}`,
+            );
+        }
+    });
+
+    test('New File - Ada Package', async () => {
+        if (vscode.workspace.workspaceFolders !== undefined) {
+            await vscode.commands.executeCommand('ada.createNewAdaPackage');
+            const activeEditor = vscode.window.activeTextEditor;
+            assert.strictEqual(
+                activeEditor?.document.languageId,
+                'ada',
+                'We should have a newly created Ada editor',
+            );
+            const text = activeEditor.document.getText() ?? '';
+            assert.strictEqual(
+                text.startsWith('package'),
+                true,
+                `We should have a package declaration snippet at the beginning ` +
+                    `of the new editor, but instead we have:\n\n${text}`,
+            );
+        }
+    });
+
     test('Clear Cache On Project Reload', async () => {
         if (vscode.workspace.workspaceFolders !== undefined) {
             // Get the workspace root folder