feat: snippet provider

Author: raideer

src/completion/XmlSnippetProvider.ts

@@ -0,0 +1,74 @@
+import { minimatch } from 'minimatch';
+import * as vscode from 'vscode';
+
+interface Snippet {
+  prefix: string;
+  body: string[];
+  description: string;
+}
+
+interface SnippetProvider {
+  pattern: string;
+  snippets: Record<string, Snippet>;
+}
+
+export class XmlSnippetProvider implements vscode.CompletionItemProvider {
+  public static readonly TRIGGER_CHARACTERS = ['<'];
+
+  private readonly snippetProviders: SnippetProvider[] = [
+    {
+      pattern: '**/di.xml',
+      snippets: require('./snippets/di-xml.json'),
+    },
+  ];
+
+  public provideCompletionItems(
+    document: vscode.TextDocument,
+    position: vscode.Position,
+    token: vscode.CancellationToken,
+    context: vscode.CompletionContext
+  ): vscode.ProviderResult<vscode.CompletionItem[]> {
+    const wordRange = document.getWordRangeAtPosition(position);
+    const word = document.getText(wordRange);
+    const snippets = this.getSnippets(document);
+
+    if (!snippets) {
+      return null;
+    }
+
+    const completionItems: vscode.CompletionItem[] = [];
+
+    for (const name in snippets) {
+      const snippet = snippets[name];
+
+      // if (snippet.prefix.indexOf(word) !== 0) {
+      //   continue;
+      // }
+
+      const completionItem = new vscode.CompletionItem(name, vscode.CompletionItemKind.Snippet);
+      completionItem.insertText = new vscode.SnippetString(snippet.body.join('\n'));
+
+      completionItem.documentation = new vscode.MarkdownString(snippet.description);
+
+      completionItem.additionalTextEdits = [
+        vscode.TextEdit.delete(
+          new vscode.Range(position.line, position.character - 1, position.line, position.character)
+        ),
+      ];
+
+      completionItems.push(completionItem);
+    }
+
+    return completionItems;
+  }
+
+  public getSnippets(document: vscode.TextDocument): Record<string, Snippet> | undefined {
+    for (const snippetProvider of this.snippetProviders) {
+      if (minimatch(document.uri.fsPath, snippetProvider.pattern, { matchBase: true })) {
+        return snippetProvider.snippets;
+      }
+    }
+
+    return undefined;
+  }
+}

src/completion/snippets/di-xml.json

@@ -0,0 +1,30 @@
+{
+  "Insert a preference element": {
+    "prefix": "preference",
+    "body": [
+      "<preference for=\"${1:ClassName}\" type=\"${2:ClassName}\" />"
+    ],
+    "description": "Insert a preference element to the current file"
+  },
+  "Insert a type element": {
+    "prefix": "type",
+    "body": [
+      "<type name=\"${1:ClassName}\">\n</type>"
+    ],
+    "description": "Insert a type element to the current file"
+  },
+  "Insert a arguments element": {
+    "prefix": "arguments",
+    "body": [
+      "<arguments>\n</arguments>"
+    ],
+    "description": "Insert an arguments element to the current file"
+  },
+  "Insert a argument element": {
+    "prefix": "argument",
+    "body": [
+      "<argument name=\"${1:Name}\" xsi:type=\"${2:Type}\">${3:Value}</argument>"
+    ],
+    "description": "Insert an argument element to the current file"
+  }
+}

src/extension.ts

@@ -13,6 +13,7 @@ import Magento from 'util/Magento';
 import { WorkspaceFolder } from 'vscode';
 import Logger from 'util/Logger';
 import { Command } from 'command/Command';
+import { XmlSnippetProvider } from 'completion/XmlSnippetProvider';
 
 // This method is called when your extension is activated
 // Your extension is activated the very first time the command is executed
@@ -103,6 +104,14 @@ export async function activate(context: vscode.ExtensionContext) {
     vscode.languages.registerHoverProvider('xml', new XmlClasslikeHoverProvider())
   );
 
+  context.subscriptions.push(
+    vscode.languages.registerCompletionItemProvider(
+      'xml',
+      new XmlSnippetProvider(),
+      ...XmlSnippetProvider.TRIGGER_CHARACTERS
+    )
+  );
+
   await activeTextEditorChangeObserver.execute(vscode.window.activeTextEditor);
 
   if (vscode.window.activeTextEditor) {