Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
"type": "string",
"editPresentation": "multilineText",
"default": "",
"markdownDescription": "`%module%` will be replaced with the module name. \n\n **Do not add comment symbols like `/*` or `*/`, they will be added automatically.** \n\n Separate lines with the newline character `\\n`"
"markdownDescription": "`%module%` will be replaced with the module name. \n\n **Do not add comment symbols like `/*` or `*/`, they will be added automatically.**"
},
"magento-toolbox.xmlFileHeaderComment": {
"type": "string",
Expand Down
18 changes: 18 additions & 0 deletions src/common/php/FileHeader.ts
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,22 @@ export default class FileHeader {

return header.replace('%module%', module);
}

public static getHeaderAsComment(module: string): string {
const header = this.getHeader(module);

if (!header) {
return '';
}

let comment = `/**\n`;

header.split(/[\r\n]+/).forEach(line => {
comment += ` * ${line}\n`;
});

comment += ` */\n`;

return comment;
}
}
8 changes: 6 additions & 2 deletions src/generator/TemplateGenerator.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,13 +7,17 @@ export default class TemplateGenerator extends FileGenerator {
public constructor(
protected fileName: string,
protected templateName: string,
protected data: any
protected data: Record<string, any>
) {
super();
}

public getTemplateData(): Record<string, any> {
return this.data;
}

public async generate(workspaceUri: Uri): Promise<GeneratedFile> {
const content = await GenerateFromTemplate.generate(this.templateName, this.data);
const content = await GenerateFromTemplate.generate(this.templateName, this.getTemplateData());

const path = Uri.joinPath(workspaceUri, this.fileName);
return new GeneratedFile(path, content);
Expand Down
38 changes: 15 additions & 23 deletions src/generator/module/ModuleRegistrationGenerator.ts
Original file line number Diff line number Diff line change
@@ -1,38 +1,30 @@
import { ModuleWizardComposerData, ModuleWizardData } from 'wizard/ModuleWizard';
import { PhpFile, PsrPrinter } from 'node-php-generator';
import { Uri } from 'vscode';
import GeneratedFile from 'generator/GeneratedFile';
import Magento from 'util/Magento';
import FileGenerator from 'generator/FileGenerator';
import TemplateGenerator from 'generator/TemplateGenerator';
import FileHeader from 'common/php/FileHeader';

export default class ModuleRegistrationGenerator extends FileGenerator {
export default class ModuleRegistrationGenerator extends TemplateGenerator {
public constructor(protected data: ModuleWizardData | ModuleWizardComposerData) {
super();
super('registration.php', 'php/registration', data);
}

public getTemplateData(): any {
const data = super.getTemplateData();

data.fileHeader = FileHeader.getHeaderAsComment(`${this.data.vendor}_${this.data.module}`);

return data;
}

public async generate(workspaceUri: Uri): Promise<GeneratedFile> {
const registrationContent = this.getRegistrationContent();
const registrationFileUri = Magento.getModuleDirectory(
const moduleDirectory = Magento.getModuleDirectory(
this.data.vendor,
this.data.module,
workspaceUri,
'registration.php'
workspaceUri
);
return new GeneratedFile(registrationFileUri, registrationContent);
}

protected getRegistrationContent(): string {
const printer = new PsrPrinter();
const file = new PhpFile();
file.setStrictTypes(true);
file.addUse('Magento\\Framework\\Component\\ComponentRegistrar');

const moduleName = Magento.getModuleName(this.data.vendor, this.data.module);

let content = printer.printFile(file);

content += `ComponentRegistrar::register(ComponentRegistrar::MODULE, '${moduleName}', __DIR__);\n`;

return content;
return super.generate(moduleDirectory);
}
}
9 changes: 9 additions & 0 deletions templates/php/registration.ejs
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<?php
<% if (fileHeader) { -%>
<%- fileHeader -%>
<% } -%>
declare(strict_types=1);

use Magento\Framework\Component\ComponentRegistrar;

ComponentRegistrar::register(ComponentRegistrar::MODULE, '<%= vendor %>_<%= module %>', __DIR__);