Skip to content

Commit ab8359b

Browse files
raideerraideer
committed
feat: simple xml generators; xml file headers
1 parent aaea690 commit ab8359b

29 files changed

+565
-93
lines changed

‎package-lock.json‎

Lines changed: 11 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎package.json‎

Lines changed: 54 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,12 @@
3030
"editPresentation": "multilineText",
3131
"default": "",
3232
"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`"
33+
},
34+
"magento-toolbox.xmlFileHeaderComment": {
35+
"type": "string",
36+
"editPresentation": "multilineText",
37+
"default": "",
38+
"markdownDescription": "`%module%` will be replaced with the module name. \n\n **Do not add comment symbols like `<!--` or `-->`, they will be added automatically.**"
3339
}
3440
}
3541
},
@@ -73,8 +79,24 @@
7379
"title": "Magento Toolbox: Generate Observer"
7480
},
7581
{
76-
"command": "magento-toolbox.dynamicRowExample",
77-
"title": "Magento Toolbox: Dynamic Row Example"
82+
"command": "magento-toolbox.generateEventsXml",
83+
"title": "Magento Toolbox: Generate Events XML"
84+
},
85+
{
86+
"command": "magento-toolbox.generateGraphqlSchemaFile",
87+
"title": "Magento Toolbox: Generate GraphQL Schema File"
88+
},
89+
{
90+
"command": "magento-toolbox.generateRoutesXmlFile",
91+
"title": "Magento Toolbox: Generate Routes XML"
92+
},
93+
{
94+
"command": "magento-toolbox.generateAclXmlFile",
95+
"title": "Magento Toolbox: Generate ACL XML"
96+
},
97+
{
98+
"command": "magento-toolbox.generateDiXmlFile",
99+
"title": "Magento Toolbox: Generate DI XML"
78100
}
79101
],
80102
"menus": {
@@ -111,6 +133,35 @@
111133
"command": "magento-toolbox.copyMagentoPath",
112134
"title": "Magento Toolbox: Copy Magento Path",
113135
"when": "resourceExtname in magento-toolbox.supportedMagentoPathExtensions && resourcePath =~ /view/"
136+
},
137+
{
138+
"command": "magento-toolbox.generateObserver",
139+
"when": "resourcePath =~ /app\\/code\\/.+\\/.+/i",
140+
"arguments": []
141+
},
142+
{
143+
"command": "magento-toolbox.generateBlock",
144+
"when": "resourcePath =~ /app\\/code\\/.+\\/.+/i"
145+
},
146+
{
147+
"command": "magento-toolbox.generateEventsXml",
148+
"when": "resourcePath =~ /app\\/code\\/.+\\/.+/i"
149+
},
150+
{
151+
"command": "magento-toolbox.generateGraphqlSchemaFile",
152+
"when": "resourcePath =~ /app\\/code\\/.+\\/.+/i"
153+
},
154+
{
155+
"command": "magento-toolbox.generateRoutesXmlFile",
156+
"when": "resourcePath =~ /app\\/code\\/.+\\/.+/i"
157+
},
158+
{
159+
"command": "magento-toolbox.generateAclXmlFile",
160+
"when": "resourcePath =~ /app\\/code\\/.+\\/.+/i"
161+
},
162+
{
163+
"command": "magento-toolbox.generateDiXmlFile",
164+
"when": "resourcePath =~ /app\\/code\\/.+\\/.+/i"
114165
}
115166
]
116167
}
@@ -171,6 +222,7 @@
171222
"php-parser": "^3.2.2",
172223
"react": "^19.0.0",
173224
"react-dom": "^19.0.0",
225+
"slugify": "^1.6.6",
174226
"typescript-json-serializer": "^6.0.1",
175227
"typescript-memoize": "^1.1.1",
176228
"validatorjs": "^3.22.1"

‎src/codelens/ObserverCodelensProvider.ts‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@ export default class ObserverCodelensProvider implements CodeLensProvider {
6161
const codelens = new CodeLens(range, {
6262
title: 'Create an Observer',
6363
command: 'magento-toolbox.generateObserver',
64-
arguments: [event.name],
64+
arguments: [undefined, event.name],
6565
});
6666

6767
codelenses.push(codelens);

‎src/command/DynamicRowExampleCommand.ts‎

Lines changed: 0 additions & 30 deletions
This file was deleted.

‎src/command/GenerateAclXmlFileCommand.ts‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
import { SimpleTemplateGeneratorCommand } from './SimpleTemplateGeneratorCommand';
2+
import { TemplateWizardData } from 'wizard/SimpleTemplateWizard';
3+
4+
export default class GenerateAclXmlFileCommand extends SimpleTemplateGeneratorCommand {
5+
constructor() {
6+
super('magento-toolbox.generateAclXmlFile');
7+
}
8+
9+
getWizardTitle(): string {
10+
return 'ACL XML File';
11+
}
12+
13+
getTemplatePath(data: TemplateWizardData): string {
14+
const [vendor, module] = data.module.split('_');
15+
16+
return `app/code/${vendor}/${module}/etc/acl.xml`;
17+
}
18+
19+
getTemplateName(data: TemplateWizardData): string {
20+
return 'xml/blank-acl';
21+
}
22+
}

‎src/command/GenerateBlockCommand.ts‎

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -2,22 +2,37 @@ import { Command } from 'command/Command';
22
import BlockClassGenerator from 'generator/block/BlockClassGenerator';
33
import BlockWizard, { BlockWizardData } from 'wizard/BlockWizard';
44
import FileGeneratorManager from 'generator/FileGeneratorManager';
5-
import { window } from 'vscode';
5+
import { Uri, window } from 'vscode';
66
import Common from 'util/Common';
77
import WizzardClosedError from 'webview/error/WizzardClosedError';
8+
import IndexManager from 'indexer/IndexManager';
9+
import ModuleIndexer from 'indexer/module/ModuleIndexer';
810

911
export default class GenerateBlockCommand extends Command {
1012
constructor() {
1113
super('magento-toolbox.generateBlock');
1214
}
1315

14-
public async execute(...args: any[]): Promise<void> {
16+
public async execute(uri?: Uri): Promise<void> {
17+
const moduleIndex = IndexManager.getIndexData(ModuleIndexer.KEY);
18+
let contextModule: string | undefined;
19+
20+
const contextUri = uri || window.activeTextEditor?.document.uri;
21+
22+
if (moduleIndex && contextUri) {
23+
const module = moduleIndex.getModuleByUri(contextUri);
24+
25+
if (module) {
26+
contextModule = module.name;
27+
}
28+
}
29+
1530
const blockWizard = new BlockWizard();
1631

1732
let data: BlockWizardData;
1833

1934
try {
20-
data = await blockWizard.show();
35+
data = await blockWizard.show(contextModule);
2136
} catch (error) {
2237
if (error instanceof WizzardClosedError) {
2338
return;

‎src/command/GenerateDiXmlFileCommand.ts‎

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
import { MagentoScope } from 'types';
2+
import { SimpleTemplateGeneratorCommand } from './SimpleTemplateGeneratorCommand';
3+
import { TemplateWizardData } from 'wizard/SimpleTemplateWizard';
4+
5+
export default class GenerateDiXmlFileCommand extends SimpleTemplateGeneratorCommand {
6+
constructor() {
7+
super('magento-toolbox.generateDiXmlFile');
8+
}
9+
10+
getAreas(): MagentoScope[] {
11+
return [
12+
MagentoScope.Global,
13+
MagentoScope.Adminhtml,
14+
MagentoScope.Frontend,
15+
MagentoScope.Cron,
16+
MagentoScope.WebapiRest,
17+
MagentoScope.WebapiSoap,
18+
MagentoScope.Graphql,
19+
];
20+
}
21+
22+
getWizardTitle(): string {
23+
return 'DI XML File';
24+
}
25+
26+
getTemplatePath(data: TemplateWizardData): string {
27+
const [vendor, module] = data.module.split('_');
28+
29+
if (data.area && data.area !== MagentoScope.Global) {
30+
return `app/code/${vendor}/${module}/etc/${data.area}/di.xml`;
31+
}
32+
33+
return `app/code/${vendor}/${module}/etc/di.xml`;
34+
}
35+
36+
getTemplateName(data: TemplateWizardData): string {
37+
return 'xml/blank-di';
38+
}
39+
}

‎src/command/GenerateEventsXmlCommand.ts‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
import { SimpleTemplateGeneratorCommand } from './SimpleTemplateGeneratorCommand';
2+
import { TemplateWizardData } from 'wizard/SimpleTemplateWizard';
3+
import { MagentoScope } from 'types';
4+
import FileHeader from 'common/xml/FileHeader';
5+
6+
export default class GenerateEventsXmlCommand extends SimpleTemplateGeneratorCommand {
7+
constructor() {
8+
super('magento-toolbox.generateEventsXml');
9+
}
10+
11+
getWizardTitle(): string {
12+
return 'Events XML File';
13+
}
14+
15+
getAreas(): MagentoScope[] {
16+
return [
17+
MagentoScope.Global,
18+
MagentoScope.Adminhtml,
19+
MagentoScope.Frontend,
20+
MagentoScope.Cron,
21+
MagentoScope.WebapiRest,
22+
MagentoScope.WebapiSoap,
23+
MagentoScope.Graphql,
24+
];
25+
}
26+
27+
getFileHeader(data: TemplateWizardData): string | undefined {
28+
return FileHeader.getHeader(data.module);
29+
}
30+
31+
getTemplatePath(data: TemplateWizardData): string {
32+
const [vendor, module] = data.module.split('_');
33+
34+
if (data.area && data.area !== MagentoScope.Global) {
35+
return `app/code/${vendor}/${module}/etc/${data.area}/events.xml`;
36+
}
37+
38+
return `app/code/${vendor}/${module}/etc/events.xml`;
39+
}
40+
41+
getTemplateName(data: TemplateWizardData): string {
42+
return 'xml/blank-events';
43+
}
44+
}

‎src/command/GenerateGraphqlSchemaFile.ts‎

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
import { SimpleTemplateGeneratorCommand } from './SimpleTemplateGeneratorCommand';
2+
import { TemplateWizardData } from 'wizard/SimpleTemplateWizard';
3+
4+
export default class GenerateGraphqlSchemaFileCommand extends SimpleTemplateGeneratorCommand {
5+
constructor() {
6+
super('magento-toolbox.generateGraphqlSchemaFile');
7+
}
8+
9+
getWizardTitle(): string {
10+
return 'GraphQL Schema File';
11+
}
12+
13+
getTemplatePath(data: TemplateWizardData): string {
14+
const [vendor, module] = data.module.split('_');
15+
16+
return `app/code/${vendor}/${module}/etc/schema.graphqls`;
17+
}
18+
19+
getTemplateName(data: TemplateWizardData): string {
20+
return 'graphql/blank-schema';
21+
}
22+
}

‎src/command/GenerateObserverCommand.ts‎

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,22 +3,39 @@ import ObserverWizard, { ObserverWizardData } from 'wizard/ObserverWizard';
33
import WizzardClosedError from 'webview/error/WizzardClosedError';
44
import FileGeneratorManager from 'generator/FileGeneratorManager';
55
import Common from 'util/Common';
6-
import { window } from 'vscode';
6+
import { Uri, window } from 'vscode';
77
import ObserverClassGenerator from 'generator/observer/ObserverClassGenerator';
88
import ObserverEventsGenerator from 'generator/observer/ObserverEventsGenerator';
9+
import IndexManager from 'indexer/IndexManager';
10+
import ModuleIndexer from 'indexer/module/ModuleIndexer';
911

1012
export default class GenerateObserverCommand extends Command {
1113
constructor() {
1214
super('magento-toolbox.generateObserver');
1315
}
1416

15-
public async execute(eventName?: string): Promise<void> {
17+
public async execute(uri?: Uri, eventName?: string): Promise<void> {
18+
eventName = typeof eventName === 'string' ? eventName : undefined;
19+
20+
const moduleIndex = IndexManager.getIndexData(ModuleIndexer.KEY);
21+
let contextModule: string | undefined;
22+
23+
const contextUri = uri || window.activeTextEditor?.document.uri;
24+
25+
if (moduleIndex && contextUri) {
26+
const module = moduleIndex.getModuleByUri(contextUri);
27+
28+
if (module) {
29+
contextModule = module.name;
30+
}
31+
}
32+
1633
const observerWizard = new ObserverWizard();
1734

1835
let data: ObserverWizardData;
1936

2037
try {
21-
data = await observerWizard.show(eventName);
38+
data = await observerWizard.show(eventName, contextModule);
2239
} catch (error) {
2340
if (error instanceof WizzardClosedError) {
2441
return;

0 commit comments

Comments
 (0)