feat: more snippets

Author: raideer

src/completion/XmlSnippetProvider.ts

@@ -1,10 +1,12 @@
+import { last, uniq } from 'lodash-es';
 import { minimatch } from 'minimatch';
 import * as vscode from 'vscode';
 
 interface Snippet {
   prefix: string;
   body: string[];
   description: string;
+  parent?: string;
 }
 
 interface SnippetProvider {
@@ -18,7 +20,19 @@ export class XmlSnippetProvider implements vscode.CompletionItemProvider {
   private readonly snippetProviders: SnippetProvider[] = [
     {
       pattern: '**/di.xml',
-      snippets: require('./xml/snippet/di-xml.json'),
+      snippets: require('./xml/snippet/di.json'),
+    },
+    {
+      pattern: '**/events.xml',
+      snippets: require('./xml/snippet/events.json'),
+    },
+    {
+      pattern: '**/crontab.xml',
+      snippets: require('./xml/snippet/crontab.json'),
+    },
+    {
+      pattern: '**/webapi.xml',
+      snippets: require('./xml/snippet/webapi.json'),
     },
   ];
 
@@ -34,11 +48,17 @@ export class XmlSnippetProvider implements vscode.CompletionItemProvider {
       return null;
     }
 
+    const parentElementNames = this.getParentElementNames(document, position);
+    const directParentName = last(parentElementNames);
     const completionItems: vscode.CompletionItem[] = [];
 
     for (const name in snippets) {
       const snippet = snippets[name];
 
+      if (snippet.parent && snippet.parent !== directParentName) {
+        continue;
+      }
+
       const completionItem = new vscode.CompletionItem(
         {
           label: name,
@@ -71,4 +91,44 @@ export class XmlSnippetProvider implements vscode.CompletionItemProvider {
 
     return undefined;
   }
+
+  private getParentElementNames(
+    document: vscode.TextDocument,
+    position: vscode.Position
+  ): string[] {
+    const text = document.getText(new vscode.Range(0, 0, position.line, position.character));
+    // Match all opening elements except for self-closing ones
+    const openingElementMatches = text.matchAll(/<([:_a-zA-Z]+)[^<]*(?<!\/)>/gms);
+    // Match all closing elements
+    const closingElementMatches = text.matchAll(/<\/([:_a-zA-Z]+)>/g);
+
+    if (!openingElementMatches || !closingElementMatches) {
+      return [];
+    }
+
+    const openingElementNames = Array.from(openingElementMatches).map(match => match[1]);
+    const closingElementNames = Array.from(closingElementMatches).map(match => match[1]);
+
+    const openingElementCount = openingElementNames.reduce(
+      (acc, name) => {
+        acc[name] = (acc[name] || 0) + 1;
+        return acc;
+      },
+      {} as Record<string, number>
+    );
+
+    const closingElementCount = closingElementNames.reduce(
+      (acc, name) => {
+        acc[name] = (acc[name] || 0) + 1;
+        return acc;
+      },
+      {} as Record<string, number>
+    );
+
+    return uniq(
+      openingElementNames.filter(name => {
+        return openingElementCount[name] > (closingElementCount[name] || 0);
+      })
+    );
+  }
 }

src/completion/xml/snippet/crontab.json

@@ -0,0 +1,22 @@
+{
+  "group": {
+    "parent": "config",
+    "prefix": "group",
+    "body": [
+      "<group id=\"${1:default}\">",
+      "    ${2}",
+      "</group>"
+    ],
+    "description": "Insert a cron group element"
+  },
+  "job": {
+    "parent": "group",
+    "prefix": "job",
+    "body": [
+      "<job name=\"${1}\" instance=\"${2}\" method=\"${3:execute}\">",
+      "    <schedule>${4:* * * * *}</schedule>",
+      "</job>"
+    ],
+    "description": "Insert a cron job element"
+  }
+} 

src/completion/xml/snippet/di-xml.json renamed to src/completion/xml/snippet/di.json

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

src/completion/xml/snippet/events.json

@@ -0,0 +1,18 @@
+{
+  "event": {
+    "parent": "config",
+    "prefix": "event",
+    "body": [
+      "<event name=\"${1}\">\n    ${2}\n</event>"
+    ],
+    "description": "Insert a event element to the current file"
+  },
+  "observer": {
+    "parent": "event",
+    "prefix": "observer",
+    "body": [
+      "<observer name=\"${1}\" instance=\"${2}\" />"
+    ],
+    "description": "Insert a observer element to the current file"
+  }
+}

src/completion/xml/snippet/webapi.json

@@ -0,0 +1,15 @@
+{
+  "route": {
+    "parent": "routes",
+    "prefix": "route",
+    "body": [
+      "<route url=\"${1:/V1/endpoint}\" method=\"${2:GET}\">",
+      "    <service class=\"${3}\" method=\"${4}\" />",
+      "    <resources>",
+      "        <resource ref=\"${5:anonymous}\" />",
+      "    </resources>",
+      "</route>"
+    ],
+    "description": "Insert a route element to the current file"
+  }
+}