chore: moved types to a separate directory

raideer · raideer · commit 48e6affbc318 · 2025-03-23T13:50:16.000+02:00
diff --git a/src/command/GenerateDiXmlFileCommand.ts b/src/command/GenerateDiXmlFileCommand.ts
@@ -1,4 +1,4 @@
-import { MagentoScope } from 'types';
+import { MagentoScope } from 'types/global';
 import { SimpleTemplateGeneratorCommand } from './SimpleTemplateGeneratorCommand';
 import { TemplateWizardData } from 'wizard/SimpleTemplateWizard';
 
diff --git a/src/command/GenerateEventsXmlCommand.ts b/src/command/GenerateEventsXmlCommand.ts
@@ -1,6 +1,6 @@
 import { SimpleTemplateGeneratorCommand } from './SimpleTemplateGeneratorCommand';
 import { TemplateWizardData } from 'wizard/SimpleTemplateWizard';
-import { MagentoScope } from 'types';
+import { MagentoScope } from 'types/global';
 import FileHeader from 'common/xml/FileHeader';
 
 export default class GenerateEventsXmlCommand extends SimpleTemplateGeneratorCommand {
diff --git a/src/command/GenerateLayoutXmlCommand.ts b/src/command/GenerateLayoutXmlCommand.ts
@@ -1,7 +1,7 @@
-import { MagentoScope } from 'types';
+import { MagentoScope } from 'types/global';
 import { SimpleTemplateGeneratorCommand } from './SimpleTemplateGeneratorCommand';
 import { TemplateWizardData } from 'wizard/SimpleTemplateWizard';
-import { WizardField, WizardValidationRule } from 'webview/types';
+import { WizardField, WizardValidationRule } from 'types/webview';
 import { WizardFieldBuilder } from 'webview/WizardFieldBuilder';
 import FileHeader from 'common/xml/FileHeader';
 
diff --git a/src/command/GenerateRoutesXmlFileCommand.ts b/src/command/GenerateRoutesXmlFileCommand.ts
@@ -1,9 +1,9 @@
 import { SimpleTemplateGeneratorCommand } from './SimpleTemplateGeneratorCommand';
 import { TemplateWizardData } from 'wizard/SimpleTemplateWizard';
-import { MagentoScope } from 'types';
+import { MagentoScope } from 'types/global';
 import FileHeader from 'common/xml/FileHeader';
 import { WizardFieldBuilder } from 'webview/WizardFieldBuilder';
-import { WizardField, WizardValidationRule } from 'webview/types';
+import { WizardField, WizardValidationRule } from 'types/webview';
 
 export default class GenerateRoutesXmlFileCommand extends SimpleTemplateGeneratorCommand {
   constructor() {
diff --git a/src/command/SimpleTemplateGeneratorCommand.ts b/src/command/SimpleTemplateGeneratorCommand.ts
@@ -6,8 +6,8 @@ import FileGeneratorManager from 'generator/FileGeneratorManager';
 import TemplateGenerator from 'generator/TemplateGenerator';
 import Common from 'util/Common';
 import SimpleTemplateWizard, { TemplateWizardData } from 'wizard/SimpleTemplateWizard';
-import { MagentoScope } from 'types';
-import { WizardField, WizardValidationRule } from 'webview/types';
+import { MagentoScope } from 'types/global';
+import { WizardField, WizardValidationRule } from 'types/webview';
 
 export abstract class SimpleTemplateGeneratorCommand extends Command {
   abstract getWizardTitle(): string;
diff --git a/src/generator/HandlebarsTemplateRenderer.ts b/src/generator/HandlebarsTemplateRenderer.ts
@@ -10,13 +10,24 @@ export default class HandlebarsTemplateRenderer {
   public constructor() {
     this.handlebars = create();
     this.registerHelpers();
-    this.registerPartials();
+    this.registerGlobalPartials();
   }
 
-  public async render(template: string, data?: Record<string, any>): Promise<string> {
+  public async render(
+    template: string,
+    data?: Record<string, any>,
+    partials?: Record<string, string>
+  ): Promise<string> {
     try {
       const templatePath = this.getTemplatePath(template);
       const templateContent = await FileSystem.readFile(Uri.file(templatePath));
+
+      if (partials) {
+        for (const [name, content] of Object.entries(partials)) {
+          this.handlebars.registerPartial(name, content + '\n');
+        }
+      }
+
       const compiledTemplate = this.handlebars.compile(templateContent);
       const content = compiledTemplate(data);
       return content;
@@ -39,7 +50,7 @@ export default class HandlebarsTemplateRenderer {
     });
   }
 
-  protected registerPartials(): void {
+  protected registerGlobalPartials(): void {
     this.handlebars.registerPartial('fileHeader', '{{#if fileHeader}}\n{{{fileHeader}}}\n{{/if}}');
   }
 }
diff --git a/src/generator/plugin/PluginDiGenerator.ts b/src/generator/plugin/PluginDiGenerator.ts
@@ -33,17 +33,26 @@ export default class PluginDiGenerator extends FileGenerator {
 
     const renderer = new HandlebarsTemplateRenderer();
 
-    const pluginXml = await renderer.render('xml/plugin', {
+    const pluginXml = await renderer.render('xml/di/plugin', {
       pluginName: this.data.name,
       pluginType: pluginType.toString(),
       sortOrder: this.data.sortOrder,
-      subjectNamespace,
     });
 
+    const diType = await renderer.render(
+      'xml/di/type',
+      {
+        subjectNamespace,
+      },
+      {
+        typeContent: pluginXml,
+      }
+    );
+
     const newDiXml =
       diXml.slice(0, insertPosition) +
       '\n' +
-      indentString(pluginXml, 4) +
+      indentString(diType, 4) +
       '\n' +
       diXml.slice(insertPosition);
 
diff --git a/src/generator/util/FindOrCreateDiXml.ts b/src/generator/util/FindOrCreateDiXml.ts
@@ -1,7 +1,7 @@
 import { Uri } from 'vscode';
 import FileSystem from 'util/FileSystem';
 import FileHeader from 'common/xml/FileHeader';
-import { MagentoScope } from 'types';
+import { MagentoScope } from 'types/global';
 import Magento from 'util/Magento';
 import HandlebarsTemplateRenderer from '../HandlebarsTemplateRenderer';
 
diff --git a/src/generator/util/FindOrCreateEventsXml.ts b/src/generator/util/FindOrCreateEventsXml.ts
@@ -1,6 +1,6 @@
 import { Uri } from 'vscode';
 import FileSystem from 'util/FileSystem';
-import { MagentoScope } from 'types';
+import { MagentoScope } from 'types/global';
 import FileHeader from 'common/xml/FileHeader';
 import HandlebarsTemplateRenderer from '../HandlebarsTemplateRenderer';
 
diff --git a/src/indexer/module/ModuleIndexData.ts b/src/indexer/module/ModuleIndexData.ts
@@ -1,4 +1,4 @@
-import { WizardSelectOption } from 'webview/types';
+import { WizardSelectOption } from 'types/webview';
 import { Module } from './types';
 import { Uri } from 'vscode';
 import { AbstractIndexData } from 'indexer/AbstractIndexData';
diff --git a/src/test/generator/module/ModuleComposerGenerator.test.ts b/src/test/generator/module/ModuleComposerGenerator.test.ts
@@ -1,5 +1,5 @@
 import { ModuleWizardComposerData } from 'wizard/ModuleWizard';
-import { License } from 'types';
+import { License } from 'types/global';
 import * as assert from 'assert';
 import ModuleComposerGenerator from 'generator/module/ModuleComposerGenerator';
 import { describe, it, before } from 'mocha';
diff --git a/src/test/generator/module/ModuleRegistrationGenerator.test.ts b/src/test/generator/module/ModuleRegistrationGenerator.test.ts
@@ -1,5 +1,5 @@
 import { ModuleWizardData } from 'wizard/ModuleWizard';
-import { License } from 'types';
+import { License } from 'types/global';
 import * as assert from 'assert';
 import ModuleRegistrationGenerator from 'generator/module/ModuleRegistrationGenerator';
 import FileHeader from 'common/php/FileHeader';
diff --git a/src/test/generator/module/ModuleXmlGenerator.test.ts b/src/test/generator/module/ModuleXmlGenerator.test.ts
@@ -1,5 +1,5 @@
 import { ModuleWizardData } from 'wizard/ModuleWizard';
-import { License } from 'types';
+import { License } from 'types/global';
 import * as assert from 'assert';
 import { Uri } from 'vscode';
 import ModuleXmlGenerator from 'generator/module/ModuleXmlGenerator';
diff --git a/src/test/generator/observer/ObserverClassGenerator.test.ts b/src/test/generator/observer/ObserverClassGenerator.test.ts
@@ -7,7 +7,7 @@ import { setup } from 'test/setup';
 import { getReferenceFile, getTestWorkspaceUri } from 'test/util';
 import FileHeader from 'common/php/FileHeader';
 import sinon from 'sinon';
-import { MagentoScope } from 'types';
+import { MagentoScope } from 'types/global';
 
 describe('ObserverClassGenerator Tests', () => {
   const observerWizardData: ObserverWizardData = {
diff --git a/src/test/generator/observer/ObserverEventsGenerator.test.ts b/src/test/generator/observer/ObserverEventsGenerator.test.ts
@@ -5,7 +5,7 @@ import ObserverEventsGenerator from 'generator/observer/ObserverEventsGenerator'
 import { describe, it, before, afterEach } from 'mocha';
 import { setup } from 'test/setup';
 import { getReferenceFile, getTestWorkspaceUri } from 'test/util';
-import { MagentoScope } from 'types';
+import { MagentoScope } from 'types/global';
 import FileHeader from 'common/xml/FileHeader';
 import sinon from 'sinon';
 
diff --git a/src/test/generator/plugin/PluginClassGenerator.test.ts b/src/test/generator/plugin/PluginClassGenerator.test.ts
@@ -9,7 +9,7 @@ import FileHeader from 'common/php/FileHeader';
 import sinon from 'sinon';
 import { PhpClass } from 'parser/php/PhpClass';
 import { PhpMethod } from 'parser/php/PhpMethod';
-import { MagentoScope } from 'types';
+import { MagentoScope } from 'types/global';
 import PhpParser from 'parser/php/Parser';
 
 describe('PluginClassGenerator Tests', () => {
diff --git a/src/test/generator/plugin/PluginDiGenerator.test.ts b/src/test/generator/plugin/PluginDiGenerator.test.ts
@@ -5,7 +5,7 @@ import PluginDiGenerator from 'generator/plugin/PluginDiGenerator';
 import { describe, it, before } from 'mocha';
 import { setup } from 'test/setup';
 import { getReferenceFile, getReferenceFilePath, getTestWorkspaceUri } from 'test/util';
-import { MagentoScope } from 'types';
+import { MagentoScope } from 'types/global';
 import { PhpClass } from 'parser/php/PhpClass';
 import PhpParser from 'parser/php/Parser';
 import { PhpMethod } from 'parser/php/PhpMethod';
diff --git a/src/test/generator/preference/PreferenceClassGenerator.test.ts b/src/test/generator/preference/PreferenceClassGenerator.test.ts
@@ -7,7 +7,7 @@ import { setup } from 'test/setup';
 import { getReferenceFile, getTestWorkspaceUri } from 'test/util';
 import FileHeader from 'common/php/FileHeader';
 import sinon from 'sinon';
-import { MagentoScope } from 'types';
+import { MagentoScope } from 'types/global';
 
 describe('PreferenceClassGenerator Tests', () => {
   const preferenceWizardData: PreferenceWizardData = {
diff --git a/src/test/generator/preference/PreferenceDiGenerator.test.ts b/src/test/generator/preference/PreferenceDiGenerator.test.ts
@@ -6,7 +6,7 @@ import { describe, it, before, afterEach } from 'mocha';
 import { setup } from 'test/setup';
 import { getReferenceFile, getTestWorkspaceUri } from 'test/util';
 import sinon from 'sinon';
-import { MagentoScope } from 'types';
+import { MagentoScope } from 'types/global';
 
 describe('PreferenceDiGenerator Tests', () => {
   const preferenceWizardData: PreferenceWizardData = {
diff --git a/src/types/global.ts b/src/types/global.ts
diff --git a/src/types/vscode-elements.d.ts b/src/types/vscode-elements.d.ts
diff --git a/src/types/webview.ts b/src/types/webview.ts
diff --git a/src/util/Magento.ts b/src/util/Magento.ts
@@ -1,6 +1,6 @@
 import PhpNamespace from 'common/PhpNamespace';
 import lowerFirst from 'lodash-es/lowerFirst';
-import { MagentoScope } from 'types';
+import { MagentoScope } from 'types/global';
 import { Uri, WorkspaceFolder } from 'vscode';
 import FileSystem from './FileSystem';
 
diff --git a/src/webview/GeneratorWizard.ts b/src/webview/GeneratorWizard.ts
@@ -1,7 +1,7 @@
 import { Webview } from './Webview';
 import * as vscode from 'vscode';
 import * as path from 'path';
-import { Command, Message, Wizard } from './types';
+import { Command, Message, Wizard } from 'types/webview';
 import ExtensionState from 'common/ExtensionState';
 import WizzardClosedError from './error/WizzardClosedError';
 
diff --git a/src/webview/WizardFieldBuilder.ts b/src/webview/WizardFieldBuilder.ts
@@ -4,7 +4,7 @@ import {
   WizardField,
   WizardInput,
   WizardSelectOption,
-} from 'webview/types';
+} from 'types/webview';
 
 export class WizardFieldBuilder {
   private placeholder: string | undefined = undefined;
diff --git a/src/webview/WizardFormBuilder.ts b/src/webview/WizardFormBuilder.ts
@@ -1,5 +1,5 @@
 import { ErrorMessages, Rules, TypeCheckingRule } from 'validatorjs';
-import { Wizard, WizardTab } from './types';
+import { Wizard, WizardTab } from 'types/webview';
 
 export class WizardFormBuilder {
   private title?: string;
diff --git a/src/webview/WizardTabBuilder.ts b/src/webview/WizardTabBuilder.ts
@@ -1,4 +1,4 @@
-import { WizardField, WizardTab } from './types';
+import { WizardField, WizardTab } from 'types/webview';
 
 export class WizardTabBuilder {
   private id?: string;
diff --git a/src/webview/components/App.tsx b/src/webview/components/App.tsx
@@ -2,7 +2,7 @@ import '@vscode-elements/elements';
 import './app.css';
 import { useEffect, useState } from 'react';
 import Wizard from './Wizard';
-import { Command, Page, Wizard as WizardType } from '../types';
+import { Command, Page, Wizard as WizardType } from 'types/webview';
 
 const vscode = (window as any).acquireVsCodeApi();
 
diff --git a/src/webview/components/Wizard.tsx b/src/webview/components/Wizard.tsx
@@ -1,5 +1,5 @@
 import { WebviewApi } from 'vscode-webview';
-import { Wizard as WizardType } from '../types';
+import { Wizard as WizardType } from 'types/webview';
 import { Renderer } from './Wizard/Renderer';
 
 interface WizardProps {
diff --git a/src/webview/components/Wizard/DynamicRowInput.tsx b/src/webview/components/Wizard/DynamicRowInput.tsx
@@ -1,5 +1,5 @@
 import React, { useEffect, useState } from 'react';
-import { WizardDynamicRowField, WizardField } from 'webview/types';
+import { WizardDynamicRowField, WizardField } from 'types/webview';
 import { FieldRenderer } from './FieldRenderer';
 import { FieldArray, useFormikContext } from 'formik';
 
diff --git a/src/webview/components/Wizard/FieldRenderer.tsx b/src/webview/components/Wizard/FieldRenderer.tsx
@@ -1,7 +1,7 @@
 import { Option } from '@vscode-elements/elements/dist/includes/vscode-select/types';
 import { useField, useFormikContext } from 'formik';
 import { useEffect, useMemo, useRef } from 'react';
-import { WizardField, WizardInput, WizardSelectOption } from 'webview/types';
+import { WizardField, WizardInput, WizardSelectOption } from 'types/webview';
 import { DynamicRowInput } from './DynamicRowInput';
 import { FieldErrorMessage } from './FieldErrorMessage';
 
diff --git a/src/webview/components/Wizard/Renderer.tsx b/src/webview/components/Wizard/Renderer.tsx
@@ -2,7 +2,7 @@ import { Formik, FormikProps, FormikValues } from 'formik';
 import { useCallback } from 'react';
 import { WebviewApi } from 'vscode-webview';
 import Validator from 'validatorjs';
-import { Wizard, WizardInput } from 'webview/types';
+import { Wizard, WizardInput } from 'types/webview';
 import { FieldRenderer } from './FieldRenderer';
 
 interface Props {
diff --git a/src/wizard/ModuleWizard.ts b/src/wizard/ModuleWizard.ts
@@ -1,6 +1,6 @@
 import IndexManager from 'indexer/IndexManager';
 import ModuleIndexer from 'indexer/module/ModuleIndexer';
-import { License } from 'types';
+import { License } from 'types/global';
 import { GeneratorWizard } from 'webview/GeneratorWizard';
 import { WizardFieldBuilder } from 'webview/WizardFieldBuilder';
 import { WizardFormBuilder } from 'webview/WizardFormBuilder';
diff --git a/src/wizard/ObserverWizard.ts b/src/wizard/ObserverWizard.ts
@@ -1,7 +1,7 @@
 import Validation from 'common/Validation';
 import IndexManager from 'indexer/IndexManager';
 import ModuleIndexer from 'indexer/module/ModuleIndexer';
-import { MagentoScope } from 'types';
+import { MagentoScope } from 'types/global';
 import { GeneratorWizard } from 'webview/GeneratorWizard';
 import { WizardFieldBuilder } from 'webview/WizardFieldBuilder';
 import { WizardFormBuilder } from 'webview/WizardFormBuilder';
diff --git a/src/wizard/PluginContextWizard.ts b/src/wizard/PluginContextWizard.ts
@@ -1,6 +1,6 @@
 import IndexManager from 'indexer/IndexManager';
 import ModuleIndexer from 'indexer/module/ModuleIndexer';
-import { MagentoScope } from 'types';
+import { MagentoScope } from 'types/global';
 import { GeneratorWizard } from 'webview/GeneratorWizard';
 import { WizardFieldBuilder } from 'webview/WizardFieldBuilder';
 import { WizardFormBuilder } from 'webview/WizardFormBuilder';
diff --git a/src/wizard/PreferenceWizard.ts b/src/wizard/PreferenceWizard.ts
@@ -1,6 +1,6 @@
 import IndexManager from 'indexer/IndexManager';
 import ModuleIndexer from 'indexer/module/ModuleIndexer';
-import { MagentoScope } from 'types';
+import { MagentoScope } from 'types/global';
 import { GeneratorWizard } from 'webview/GeneratorWizard';
 import { WizardFieldBuilder } from 'webview/WizardFieldBuilder';
 import { WizardFormBuilder } from 'webview/WizardFormBuilder';
diff --git a/src/wizard/SimpleTemplateWizard.ts b/src/wizard/SimpleTemplateWizard.ts
@@ -1,12 +1,12 @@
 import IndexManager from 'indexer/IndexManager';
 import ModuleIndexer from 'indexer/module/ModuleIndexer';
-import { MagentoScope } from 'types';
+import { MagentoScope } from 'types/global';
 import { GeneratorWizard } from 'webview/GeneratorWizard';
 import { WizardFieldBuilder } from 'webview/WizardFieldBuilder';
 import { WizardFormBuilder } from 'webview/WizardFormBuilder';
 import { WizardTabBuilder } from 'webview/WizardTabBuilder';
 import slugify from 'slugify';
-import { WizardField, WizardValidationRule } from 'webview/types';
+import { WizardField, WizardValidationRule } from 'types/webview';
 
 export type TemplateWizardData = {
   module: string;
diff --git a/templates/handlebars/xml/di/plugin.hbs b/templates/handlebars/xml/di/plugin.hbs
@@ -0,0 +1,2 @@
+<plugin name="{{ pluginName }}"
+        type="{{ pluginType }}"{{#if sortOrder}} sortOrder="{{ sortOrder }}"{{/if}} />
diff --git a/templates/handlebars/xml/di/type.hbs b/templates/handlebars/xml/di/type.hbs
@@ -0,0 +1,3 @@
+<type name="{{ subjectNamespace }}">
+  {{> typeContent }}
+</type>

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { MagentoScope } from 'types';`
	`1`	`+import { MagentoScope } from 'types/global';`
`2`	`2`	`import { SimpleTemplateGeneratorCommand } from './SimpleTemplateGeneratorCommand';`
`3`	`3`	`import { TemplateWizardData } from 'wizard/SimpleTemplateWizard';`
`4`	`4`
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { WizardSelectOption } from 'webview/types';`
	`1`	`+import { WizardSelectOption } from 'types/webview';`
`2`	`2`	`import { Module } from './types';`
`3`	`3`	`import { Uri } from 'vscode';`
`4`	`4`	`import { AbstractIndexData } from 'indexer/AbstractIndexData';`