fix: missing file header

Author: raideer

src/generator/module/ModuleXmlGenerator.ts

@@ -6,6 +6,7 @@ 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) {
@@ -28,10 +29,12 @@ export default class ModuleXmlGenerator extends FileGenerator {
   protected async getXmlContent(): Promise<string> {
     const renderer = new HandlebarsTemplateRenderer();
     const moduleName = Magento.getModuleName(this.data.vendor, this.data.module);
+    const fileHeader = FileHeader.getHeader(moduleName);
 
     const moduleConfigXml = await renderer.render(TemplatePath.XmlModuleConfig, {
       moduleName,
       sequence: this.data.sequence,
+      fileHeader,
     });
 
     return moduleConfigXml;

src/test/generator/module/ModuleXmlGenerator.test.ts

@@ -6,6 +6,7 @@ import ModuleXmlGenerator from 'generator/module/ModuleXmlGenerator';
 import { describe, it, before, afterEach } from 'mocha';
 import { setup } from 'test/setup';
 import { getReferenceFile, getTestWorkspaceUri } from 'test/util';
+import FileHeader from 'common/xml/FileHeader';
 import sinon from 'sinon';
 
 describe('ModuleXmlGenerator Tests', () => {
@@ -82,4 +83,28 @@ describe('ModuleXmlGenerator Tests', () => {
     // Compare the generated content with reference
     assert.strictEqual(generatedFile.content, referenceContent);
   });
+
+  it('should generate module.xml with comment', async () => {
+    sinon.stub(FileHeader, 'getHeader').returns('<!--\nFoo_Bar\n-->');
+
+    // Create test data with sequence
+    const dataWithSequence: ModuleWizardData = {
+      ...moduleWizardData,
+    };
+
+    // Create the generator with sequence data
+    const generator = new ModuleXmlGenerator(dataWithSequence);
+
+    // Use a test workspace URI
+    const workspaceUri = getTestWorkspaceUri();
+
+    // Generate the file
+    const generatedFile = await generator.generate(workspaceUri);
+
+    // Get the reference file content
+    const referenceContent = getReferenceFile('generator/module/module-with-comment.xml');
+
+    // Compare the generated content with reference
+    assert.strictEqual(generatedFile.content, referenceContent);
+  });
 });

templates/handlebars/xml/module-config.hbs

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

test-resources/reference/generator/module/module-with-comment.xml

@@ -1,7 +1,8 @@
 <?xml version="1.0"?>
 <!--
- * Foo_Bar
- -->
-<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Module/etc/module.xsd">
+Foo_Bar
+-->
+<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:noNamespaceSchemaLocation="urn:magento:framework:Module/etc/module.xsd">
     <module name="Foo_Bar"/>
 </config>

test-resources/reference/generator/module/module-with-sequence.xml

@@ -1,5 +1,6 @@
 <?xml version="1.0"?>
-<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Module/etc/module.xsd">
+<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:noNamespaceSchemaLocation="urn:magento:framework:Module/etc/module.xsd">
     <module name="Foo_Bar">
         <sequence>
             <module name="Magento_Catalog"/>

test-resources/reference/generator/module/module.xml

@@ -1,4 +1,5 @@
 <?xml version="1.0"?>
-<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Module/etc/module.xsd">
+<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+        xsi:noNamespaceSchemaLocation="urn:magento:framework:Module/etc/module.xsd">
     <module name="Foo_Bar"/>
 </config>