chore: moving things around

Author: raideer

src/common/xml/XmlSuggestionProvider.ts

@@ -24,15 +24,15 @@ export abstract class XmlSuggestionProvider<T> {
     attribute?: XMLAttribute
   ): T[];
 
-  public getConfigKey(): string | undefined {
+  protected getConfigKey(): string | undefined {
     return undefined;
   }
 
-  public getAttributeValueConditions(): CombinedCondition[] {
+  protected getAttributeValueConditions(): CombinedCondition[] {
     return [];
   }
 
-  public getElementContentMatches(): CombinedCondition[] {
+  protected getElementContentMatches(): CombinedCondition[] {
     return [];
   }
 
@@ -48,22 +48,18 @@ export abstract class XmlSuggestionProvider<T> {
     return this.processSuggestions(document, position, tokenData);
   }
 
-  public getSuggestionProviders(document: TextDocument): SuggestionProviders<T> {
+  protected getSuggestionProviders(document: TextDocument): SuggestionProviders<T> {
     return {
       attributeValue: [options => this.getAttributeValueSuggestionProviders(document, options)],
       elementContent: [options => this.getElementContentSuggestionProviders(document, options)],
     };
   }
 
-  public getAttributeValueSuggestionProviders(
+  protected getAttributeValueSuggestionProviders(
     document: TextDocument,
     { element, attribute }: AttributeValueCompletionOptions<undefined>
   ): T[] {
-    const match = this.getAttributeValueConditions().find(matchElement => {
-      return this.matchesConditions(matchElement, element, attribute);
-    });
-
-    if (!match) {
+    if (!this.hasMatchingCondition(this.getAttributeValueConditions(), element, attribute)) {
       return [];
     }
 
@@ -81,15 +77,11 @@ export abstract class XmlSuggestionProvider<T> {
     return this.getSuggestionItems(value, range, document, element, attribute);
   }
 
-  public getElementContentSuggestionProviders(
+  protected getElementContentSuggestionProviders(
     document: TextDocument,
     { element }: ElementContentCompletionOptions<undefined>
   ): T[] {
-    const match = this.getElementContentMatches().find(matchElement => {
-      return this.matchesConditions(matchElement, element);
-    });
-
-    if (!match) {
+    if (!this.hasMatchingCondition(this.getElementContentMatches(), element)) {
       return [];
     }
 
@@ -108,6 +100,16 @@ export abstract class XmlSuggestionProvider<T> {
     return this.getSuggestionItems(elementValue, range, document, element);
   }
 
+  protected hasMatchingCondition(
+    conditions: CombinedCondition[],
+    element: XMLElement,
+    attribute?: XMLAttribute
+  ): boolean {
+    return conditions.some(condition => {
+      return this.matchesConditions(condition, element, attribute);
+    });
+  }
+
   protected matchesConditions(
     conditions: CombinedCondition,
     element: XMLElement,
@@ -139,8 +141,10 @@ export abstract class XmlSuggestionProvider<T> {
       }
     }
 
-    return this.getFilePatterns().some(pattern =>
-      minimatch(document.uri.fsPath, pattern, { matchBase: true })
-    );
+    return this.isMatchingFile(document, this.getFilePatterns());
+  }
+
+  protected isMatchingFile(document: TextDocument, patterns: string[]): boolean {
+    return patterns.some(pattern => minimatch(document.uri.fsPath, pattern, { matchBase: true }));
   }
 }

src/completion/XmlCompletionProviderProcessor.ts

@@ -14,6 +14,9 @@ export class XmlCompletionProviderProcessor
   extends XmlSuggestionProviderProcessor<CompletionItem>
   implements CompletionItemProvider
 {
+  public static readonly TRIGGER_CHARACTERS =
+    '\\"abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ';
+
   public constructor() {
     super([
       new ModuleCompletionProvider(),

src/completion/XmlSnippetProvider.ts

@@ -18,7 +18,7 @@ export class XmlSnippetProvider implements vscode.CompletionItemProvider {
   private readonly snippetProviders: SnippetProvider[] = [
     {
       pattern: '**/di.xml',
-      snippets: require('./snippets/di-xml.json'),
+      snippets: require('./xml/snippet/di-xml.json'),
     },
   ];
 
@@ -28,8 +28,6 @@ export class XmlSnippetProvider implements vscode.CompletionItemProvider {
     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) {
@@ -41,15 +39,17 @@ export class XmlSnippetProvider implements vscode.CompletionItemProvider {
     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'));
+      const completionItem = new vscode.CompletionItem(
+        {
+          label: name,
+          detail: ' magento-toolbox',
+        },
+        vscode.CompletionItemKind.Snippet
+      );
 
+      const snippetString = new vscode.SnippetString(snippet.body.join('\n'));
+      completionItem.insertText = snippetString;
       completionItem.documentation = new vscode.MarkdownString(snippet.description);
-
       completionItem.additionalTextEdits = [
         vscode.TextEdit.delete(
           new vscode.Range(position.line, position.character - 1, position.line, position.character)

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

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

src/extension.ts

@@ -108,7 +108,7 @@ export async function activate(context: vscode.ExtensionContext) {
     vscode.languages.registerCompletionItemProvider(
       'xml',
       new XmlCompletionProviderProcessor(),
-      ...'\\"abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'
+      ...XmlCompletionProviderProcessor.TRIGGER_CHARACTERS
     ),
     vscode.languages.registerCompletionItemProvider(
       'xml',