fix: Missing file header #95

Author: raideer

src/generator/module/ModuleXmlGenerator.ts

@@ -4,14 +4,16 @@ 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';
 
 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 +25,15 @@ 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,
-        },
-      },
-    };
 
-    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,
     });
+
+    return moduleConfigXml;
   }
 }

src/types/handlebars.ts

@@ -28,6 +28,7 @@ export enum TemplatePath {
   XmlBlankWidget = 'xml/blank-widget',
   XmlEventsObserver = 'xml/events/observer',
   XmlEventsEvent = 'xml/events/event',
+  XmlModuleConfig = 'xml/module-config',
   XmlCronJob = 'xml/cron/job',
   XmlCronGroup = 'xml/cron/group',
 }
@@ -120,6 +121,14 @@ export interface CronGroupParams extends BaseTemplateParams {
   groupId: string;
 }
 
+/**
+ * Parameters for module config templates
+ */
+export interface ModuleConfigParams extends BaseTemplateParams {
+  moduleName: string;
+  sequence: string[];
+}
+
 /**
  * Template parameters mapped by template path
  */
@@ -137,6 +146,7 @@ export interface TemplateParams {
   [TemplatePath.XmlDiPreference]: PreferenceParams;
   [TemplatePath.XmlCronJob]: CronJobParams;
   [TemplatePath.XmlCronGroup]: CronGroupParams;
+  [TemplatePath.XmlModuleConfig]: ModuleConfigParams;
   [key: string]: BaseTemplateParams;
 }
 

templates/handlebars/xml/module-config.hbs

@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8"?>
+{{> fileHeader}}
+<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:noNamespaceSchemaLocation="urn:magento:framework:ObjectManager/etc/config.xsd">
+{{#if sequence}}
+    <module name="{{ moduleName }}">
+        <sequence>
+        {{#each sequence}}
+            <module name="{{ this }}" />
+        {{/each}}
+        </sequence>
+    </module>
+{{else}}
+    <module name="{{ moduleName }}" />
+{{/if}}
+</config>