Feature/random improvements

.vscode/tasks.json

@@ -5,22 +5,14 @@
   "tasks": [
     {
       "label": "watch",
-      "dependsOn": ["npm: watch:esbuild"],
-      "presentation": {
-        "reveal": "never"
-      },
+      "type": "npm",
+      "script": "watch:esbuild",
       "group": {
         "kind": "build",
         "isDefault": true
-      }
-    },
-    {
-      "type": "npm",
-      "script": "watch:esbuild",
-      "group": "build",
+      },
       "problemMatcher": "$esbuild-watch",
       "isBackground": true,
-      "label": "npm: watch:esbuild",
       "presentation": {
         "group": "watch",
         "reveal": "never"

package.json

@@ -67,6 +67,11 @@
           "type": "boolean",
           "default": true,
           "description": "Enable hover decorations for Magento 2 XML files."
+        },
+        "magento-toolbox.provideThemeDefinitions": {
+          "type": "boolean",
+          "default": true,
+          "description": "Enable definitions for Magento 2 theme files."
         }
       }
     },

src/definition/XmlDefinitionProviderProcessor.ts

@@ -9,6 +9,7 @@ import { XmlSuggestionProviderProcessor } from 'common/xml/XmlSuggestionProvider
 import { AclDefinitionProvider } from './xml/AclDefinitionProvider';
 import { ModuleDefinitionProvider } from './xml/ModuleDefinitionProvider';
 import { TemplateDefinitionProvider } from './xml/TemplateDefinitionProvider';
+import { ThemeDefinitionProvider } from './xml/ThemeDefinitionProvider';
 
 export class XmlDefinitionProviderProcessor
   extends XmlSuggestionProviderProcessor<LocationLink>
@@ -19,6 +20,7 @@ export class XmlDefinitionProviderProcessor
       new AclDefinitionProvider(),
       new ModuleDefinitionProvider(),
       new TemplateDefinitionProvider(),
+      new ThemeDefinitionProvider(),
     ]);
   }
 

src/definition/xml/TemplateDefinitionProvider.ts

@@ -8,7 +8,7 @@ import { ElementAttributeMatches } from 'common/xml/suggestion/condition/Element
 
 export class TemplateDefinitionProvider extends XmlSuggestionProvider<LocationLink> {
   public getFilePatterns(): string[] {
-    return ['**/view/**/layout/*.xml', '**/etc/**/di.xml'];
+    return ['**/layout/*.xml', '**/etc/**/di.xml'];
   }
 
   public getAttributeValueConditions(): CombinedCondition[] {

src/definition/xml/ThemeDefinitionProvider.ts

@@ -0,0 +1,48 @@
+import { LocationLink, Uri, Range, TextDocument } from 'vscode';
+import IndexManager from 'indexer/IndexManager';
+import { XmlSuggestionProvider, CombinedCondition } from 'common/xml/XmlSuggestionProvider';
+import { XMLElement, XMLAttribute } from '@xml-tools/ast';
+import { ElementNameMatches } from 'common/xml/suggestion/condition/ElementNameMatches';
+import ThemeIndexer from 'indexer/theme/ThemeIndexer';
+
+export class ThemeDefinitionProvider extends XmlSuggestionProvider<LocationLink> {
+  public getFilePatterns(): string[] {
+    return ['**/theme.xml'];
+  }
+
+  public getElementContentMatches(): CombinedCondition[] {
+    return [[new ElementNameMatches('parent')]];
+  }
+
+  public getConfigKey(): string | undefined {
+    return 'provideThemeDefinitions';
+  }
+
+  public getSuggestionItems(
+    value: string,
+    range: Range,
+    document: TextDocument,
+    element: XMLElement,
+    attribute?: XMLAttribute
+  ): LocationLink[] {
+    const themeIndexData = IndexManager.getIndexData(ThemeIndexer.KEY);
+
+    if (!themeIndexData) {
+      return [];
+    }
+
+    const theme = themeIndexData.getThemeById(value);
+
+    if (!theme) {
+      return [];
+    }
+
+    return [
+      {
+        targetUri: Uri.file(theme.path),
+        targetRange: new Range(0, 0, 0, 0),
+        originSelectionRange: range,
+      },
+    ];
+  }
+}

src/extension.ts

@@ -81,12 +81,6 @@ export async function activate(context: vscode.ExtensionContext) {
       DocumentCache.clear(event);
     }),
     vscode.workspace.onDidSaveTextDocument(textDocument => {
-      const workspaceFolder = vscode.workspace.getWorkspaceFolder(textDocument.uri);
-
-      if (workspaceFolder) {
-        IndexRunner.indexFile(workspaceFolder, textDocument.uri);
-      }
-
       DocumentCache.clear(textDocument);
     })
   );

src/generator/module/ModuleXmlGenerator.ts

@@ -4,14 +4,17 @@ import { Uri } from 'vscode';
 import { ModuleWizardComposerData, ModuleWizardData } from 'wizard/ModuleWizard';
 import FileGenerator from '../FileGenerator';
 import Magento from 'util/Magento';
+import HandlebarsTemplateRenderer from 'generator/HandlebarsTemplateRenderer';
+import { TemplatePath } from 'types/handlebars';
+import FileHeader from 'common/xml/FileHeader';
 
 export default class ModuleXmlGenerator extends FileGenerator {
   public constructor(protected data: ModuleWizardData | ModuleWizardComposerData) {
     super();
   }
 
   public async generate(workspaceUri: Uri): Promise<GeneratedFile> {
-    const xmlContent = this.getXmlContent();
+    const xmlContent = await this.getXmlContent();
 
     const moduleFile = Magento.getModuleDirectory(
       this.data.vendor,
@@ -23,33 +26,17 @@ export default class ModuleXmlGenerator extends FileGenerator {
     return new GeneratedFile(moduleFile, xmlContent);
   }
 
-  protected getXmlContent(): string {
+  protected async getXmlContent(): Promise<string> {
+    const renderer = new HandlebarsTemplateRenderer();
     const moduleName = Magento.getModuleName(this.data.vendor, this.data.module);
-    const xml: any = {
-      '?xml': {
-        '@_version': '1.0',
-      },
-      config: {
-        '@_xmlns:xsi': 'http://www.w3.org/2001/XMLSchema-instance',
-        '@_xsi:noNamespaceSchemaLocation': 'urn:magento:framework:Module/etc/module.xsd',
-        module: {
-          '@_name': moduleName,
-        },
-      },
-    };
+    const fileHeader = FileHeader.getHeader(moduleName);
 
-    if (this.data.sequence.length > 0) {
-      xml.config.module.sequence = this.data.sequence.map(module => ({
-        module: {
-          '@_name': module,
-        },
-      }));
-    }
-
-    const xmlGenerator = new XmlGenerator(xml);
-    return xmlGenerator.toString({
-      unpairedTags: ['module'],
-      suppressUnpairedNode: false,
+    const moduleConfigXml = await renderer.render(TemplatePath.XmlModuleConfig, {
+      moduleName,
+      sequence: this.data.sequence,
+      fileHeader,
     });
+
+    return moduleConfigXml;
   }
 }

src/hover/XmlHoverProviderProcessor.ts

@@ -3,10 +3,16 @@ import { XmlSuggestionProviderProcessor } from 'common/xml/XmlSuggestionProvider
 import { AclHoverProvider } from 'hover/xml/AclHoverProvider';
 import { ModuleHoverProvider } from 'hover/xml/ModuleHoverProvider';
 import { CronHoverProvider } from 'hover/xml/CronHoverProvider';
+import { ThemeHoverProvider } from 'hover/xml/ThemeHoverProvider';
 
 export class XmlHoverProviderProcessor extends XmlSuggestionProviderProcessor<Hover> {
   public constructor() {
-    super([new AclHoverProvider(), new ModuleHoverProvider(), new CronHoverProvider()]);
+    super([
+      new AclHoverProvider(),
+      new ModuleHoverProvider(),
+      new CronHoverProvider(),
+      new ThemeHoverProvider(),
+    ]);
   }
 
   public async provideHover(

src/hover/xml/ThemeHoverProvider.ts

@@ -0,0 +1,63 @@
+import { Hover, MarkdownString, Uri, Range, workspace, TextDocument } from 'vscode';
+import IndexManager from 'indexer/IndexManager';
+import { CombinedCondition, XmlSuggestionProvider } from 'common/xml/XmlSuggestionProvider';
+import { ElementNameMatches } from 'common/xml/suggestion/condition/ElementNameMatches';
+import { XMLElement, XMLAttribute } from '@xml-tools/ast';
+import ThemeIndexer from 'indexer/theme/ThemeIndexer';
+import path from 'path';
+
+export class ThemeHoverProvider extends XmlSuggestionProvider<Hover> {
+  public getElementContentMatches(): CombinedCondition[] {
+    return [[new ElementNameMatches('parent')]];
+  }
+
+  public getConfigKey(): string | undefined {
+    return 'provideXmlHovers';
+  }
+
+  public getFilePatterns(): string[] {
+    return ['**/theme.xml'];
+  }
+
+  public getSuggestionItems(
+    value: string,
+    range: Range,
+    document: TextDocument,
+    element: XMLElement,
+    attribute?: XMLAttribute
+  ): Hover[] {
+    const workspaceFolder = workspace.getWorkspaceFolder(document.uri);
+
+    if (!workspaceFolder) {
+      return [];
+    }
+
+    const themeIndexData = IndexManager.getIndexData(ThemeIndexer.KEY);
+
+    if (!themeIndexData) {
+      return [];
+    }
+
+    const theme = themeIndexData.getThemeById(value);
+
+    if (!theme) {
+      return [];
+    }
+
+    const markdown = new MarkdownString();
+    markdown.appendMarkdown(`**Theme**: ${theme.title}\n\n`);
+    markdown.appendMarkdown(`- ID: \`${theme.id}\`\n\n`);
+
+    const relativePath = path.relative(workspaceFolder.uri.fsPath, theme.path);
+
+    markdown.appendMarkdown(`- Path: \`${relativePath}\`\n\n`);
+
+    if (theme.parent) {
+      markdown.appendMarkdown(`- Parent: \n\n    - ${theme.parent}\n\n`);
+    }
+
+    markdown.appendMarkdown(`[theme.xml](${Uri.file(theme.path)})`);
+
+    return [new Hover(markdown, range)];
+  }
+}