chore: refactoring; adjusted cursorrules

Author: raideer

.cursor/rules/commands.mdc

@@ -1,9 +1,10 @@
 ---
 description: Describes how to create and register new commands
-globs: 
+globs: src/command/*.ts
 alwaysApply: false
 ---
-- Commands are located in src/command directory
+- Commands are located in `src/command` directory
 - Commands must extend the [Command.ts](mdc:src/command/Command.ts) abstract class or any other class that inherits it
+- Command name must be defined in format: `magentoToolbox.commandName`
 - New commands must be added to [index.ts](mdc:src/command/index.ts) file so that they are loaded. Commands also need to be added to [package.json](mdc:package.json) under contributes -> commands
 - Commands that only generate files based on a pre-defined template can extend the [SimpleTemplateGeneratorCommand.ts](mdc:src/command/SimpleTemplateGeneratorCommand.ts) class

.cursor/rules/tests.mdc

@@ -0,0 +1,11 @@
+---
+description: Describes how to write tests
+globs: *.test.ts
+alwaysApply: false
+---
+- Tests are located in the src/test directory
+- Utilities for tests can be found in this file [util.ts](mdc:src/test/util.ts)
+- Some parts of the extension require the ExtensionContext to be present. To make sure it's set, tests should run the setup function from [setup.ts](mdc:src/test/setup.ts)
+- Tests are written using Mocha framework (`mocha` package) in Typescript and must end with .test.ts file extension. Do NOT use `chai`
+- Test spies, stubs and mocks can be written using the Sinon.js library
+- Reference files for tests are stored in the test-resources directory

src/command/SimpleTemplateGeneratorCommand.ts

@@ -1,6 +1,6 @@
 import IndexManager from 'indexer/IndexManager';
 import { Command } from './Command';
-import { Uri, window } from 'vscode';
+import { Uri, WorkspaceFolder } from 'vscode';
 import ModuleIndexer from 'indexer/module/ModuleIndexer';
 import FileGeneratorManager from 'generator/FileGeneratorManager';
 import TemplateGenerator from 'generator/TemplateGenerator';
@@ -36,28 +36,50 @@ export abstract class SimpleTemplateGeneratorCommand extends Command {
     return data;
   }
 
-  public async execute(uri?: Uri): Promise<void> {
-    const moduleIndex = IndexManager.getIndexData(ModuleIndexer.KEY);
-    let contextModule: string | undefined;
+  public async getWizardData(contextModule: string | undefined): Promise<TemplateWizardData> {
+    const wizard = new SimpleTemplateWizard();
+    const data = await wizard.show(
+      this.getWizardTitle(),
+      contextModule,
+      this.getAreas(),
+      this.getWizardFields(),
+      this.getWizardValidation()
+    );
 
-    const contextUri = uri || window.activeTextEditor?.document.uri;
+    return data;
+  }
+
+  public getContextModule(contextUri: Uri | undefined): string | undefined {
+    if (!contextUri) {
+      return undefined;
+    }
+
+    const moduleIndex = IndexManager.getIndexData(ModuleIndexer.KEY);
 
     if (moduleIndex && contextUri) {
       const module = moduleIndex.getModuleByUri(contextUri);
 
       if (module) {
-        contextModule = module.name;
+        return module.name;
       }
     }
 
-    const wizard = new SimpleTemplateWizard();
-    const data = await wizard.show(
-      this.getWizardTitle(),
-      contextModule,
-      this.getAreas(),
-      this.getWizardFields(),
-      this.getWizardValidation()
-    );
+    return undefined;
+  }
+
+  protected getWorkspaceFolder(): WorkspaceFolder {
+    const workspaceFolder = Common.getActiveWorkspaceFolder();
+
+    if (!workspaceFolder) {
+      throw new Error('No active workspace folder');
+    }
+
+    return workspaceFolder;
+  }
+
+  public async execute(uri?: Uri): Promise<void> {
+    const contextModule = this.getContextModule(uri);
+    const data = await this.getWizardData(contextModule);
 
     const manager = new FileGeneratorManager([
       new TemplateGenerator(this.getFilePath(data), this.getTemplateName(data), {
@@ -66,12 +88,7 @@ export abstract class SimpleTemplateGeneratorCommand extends Command {
       }),
     ]);
 
-    const workspaceFolder = Common.getActiveWorkspaceFolder();
-
-    if (!workspaceFolder) {
-      window.showErrorMessage('No active workspace folder');
-      return;
-    }
+    const workspaceFolder = this.getWorkspaceFolder();
 
     await manager.generate(workspaceFolder.uri);
     await manager.writeFiles();

src/generator/util/GenerateFromTemplate.ts renamed to src/generator/HandlebarsTemplateRenderer.ts

@@ -4,15 +4,20 @@ import FileSystem from 'util/FileSystem';
 import { Uri } from 'vscode';
 import Logger from 'util/Logger';
 
-export default class GenerateFromTemplate {
-  public static async generate(template: string, data?: Record<string, any>): Promise<string> {
+export default class HandlebarsTemplateRenderer {
+  protected handlebars: typeof Handlebars;
+
+  public constructor() {
+    this.handlebars = create();
+    this.registerHelpers();
+    this.registerPartials();
+  }
+
+  public async render(template: string, data?: Record<string, any>): Promise<string> {
     try {
       const templatePath = this.getTemplatePath(template);
       const templateContent = await FileSystem.readFile(Uri.file(templatePath));
-      const handlebars = create();
-      this.registerHelpers(handlebars);
-      this.registerPartials(handlebars);
-      const compiledTemplate = handlebars.compile(templateContent);
+      const compiledTemplate = this.handlebars.compile(templateContent);
       const content = compiledTemplate(data);
       return content;
     } catch (error) {
@@ -21,20 +26,20 @@ export default class GenerateFromTemplate {
     }
   }
 
-  protected static getTemplatePath(templateName: string): string {
+  public getTemplatePath(templateName: string): string {
     return resolve(FileSystem.getExtensionPath('templates/handlebars'), templateName + '.hbs');
   }
 
-  protected static registerHelpers(handlebars: typeof Handlebars): void {
-    handlebars.registerHelper('ifeq', (a: string, b: string, options: any) => {
+  protected registerHelpers(): void {
+    this.handlebars.registerHelper('ifeq', (a: string, b: string, options: any) => {
       if (a === b) {
         return options.fn(this);
       }
       return options.inverse(this);
     });
   }
 
-  protected static registerPartials(handlebars: typeof Handlebars): void {
-    handlebars.registerPartial('fileHeader', '{{#if fileHeader}}\n{{{fileHeader}}}\n{{/if}}');
+  protected registerPartials(): void {
+    this.handlebars.registerPartial('fileHeader', '{{#if fileHeader}}\n{{{fileHeader}}}\n{{/if}}');
   }
 }

src/generator/TemplateGenerator.ts

@@ -1,9 +1,11 @@
 import { Uri } from 'vscode';
 import FileGenerator from './FileGenerator';
 import GeneratedFile from './GeneratedFile';
-import GenerateFromTemplate from './util/GenerateFromTemplate';
+import HandlebarsTemplateRenderer from './HandlebarsTemplateRenderer';
 
 export default class TemplateGenerator extends FileGenerator {
+  protected renderer: HandlebarsTemplateRenderer | undefined;
+
   public constructor(
     protected fileName: string,
     protected templateName: string,
@@ -16,8 +18,20 @@ export default class TemplateGenerator extends FileGenerator {
     return this.data;
   }
 
+  protected getTemplateRenderer(): HandlebarsTemplateRenderer {
+    if (!this.renderer) {
+      this.renderer = new HandlebarsTemplateRenderer();
+    }
+
+    return this.renderer;
+  }
+
+  protected getTemplateContent(): Promise<string> {
+    return this.getTemplateRenderer().render(this.templateName, this.getTemplateData());
+  }
+
   public async generate(workspaceUri: Uri): Promise<GeneratedFile> {
-    const content = await GenerateFromTemplate.generate(this.templateName, this.getTemplateData());
+    const content = await this.getTemplateContent();
 
     const path = Uri.joinPath(workspaceUri, this.fileName);
     return new GeneratedFile(path, content);

src/generator/observer/ObserverEventsGenerator.ts

@@ -1,15 +1,14 @@
 import GeneratedFile from 'generator/GeneratedFile';
 import FileGenerator from 'generator/FileGenerator';
-import GenerateFromTemplate from 'generator/util/GenerateFromTemplate';
 import { Uri } from 'vscode';
 import { ObserverWizardData } from 'wizard/ObserverWizard';
 import indentString from 'indent-string';
 import PhpNamespace from 'common/PhpNamespace';
 import FindOrCreateEventsXml from 'generator/util/FindOrCreateEventsXml';
 import Magento from 'util/Magento';
-import FileHeader from 'common/xml/FileHeader';
+import HandlebarsTemplateRenderer from 'generator/HandlebarsTemplateRenderer';
 
-export default class ObserverDiGenerator extends FileGenerator {
+export default class ObserverEventsGenerator extends FileGenerator {
   public constructor(protected data: ObserverWizardData) {
     super();
   }
@@ -27,7 +26,9 @@ export default class ObserverDiGenerator extends FileGenerator {
     );
     const insertPosition = this.getInsertPosition(eventsXml);
 
-    const observerXml = await GenerateFromTemplate.generate('xml/observer', {
+    const renderer = new HandlebarsTemplateRenderer();
+
+    const observerXml = await renderer.render('xml/observer', {
       name: this.data.observerName,
       className: observerNamespace.append(this.data.className).toString(),
       eventName: this.data.eventName,

src/generator/plugin/PluginDiGenerator.ts

@@ -1,14 +1,14 @@
 import GeneratedFile from 'generator/GeneratedFile';
 import FileGenerator from 'generator/FileGenerator';
 import FindOrCreateDiXml from 'generator/util/FindOrCreateDiXml';
-import GenerateFromTemplate from 'generator/util/GenerateFromTemplate';
 import { PhpClass } from 'parser/php/PhpClass';
 import { PhpMethod } from 'parser/php/PhpMethod';
 import { Uri } from 'vscode';
 import { PluginContextWizardData } from 'wizard/PluginContextWizard';
 import indentString from 'indent-string';
 import { PhpInterface } from 'parser/php/PhpInterface';
 import Magento from 'util/Magento';
+import HandlebarsTemplateRenderer from 'generator/HandlebarsTemplateRenderer';
 
 export default class PluginDiGenerator extends FileGenerator {
   public constructor(
@@ -31,7 +31,9 @@ export default class PluginDiGenerator extends FileGenerator {
     const diXml = await FindOrCreateDiXml.execute(workspaceUri, vendor, module, this.data.scope);
     const insertPosition = this.getInsertPosition(diXml);
 
-    const pluginXml = await GenerateFromTemplate.generate('xml/plugin', {
+    const renderer = new HandlebarsTemplateRenderer();
+
+    const pluginXml = await renderer.render('xml/plugin', {
       pluginName: this.data.name,
       pluginType: pluginType.toString(),
       sortOrder: this.data.sortOrder,

src/generator/preference/PreferenceDiGenerator.ts

@@ -1,11 +1,11 @@
 import GeneratedFile from 'generator/GeneratedFile';
 import FindOrCreateDiXml from 'generator/util/FindOrCreateDiXml';
-import GenerateFromTemplate from 'generator/util/GenerateFromTemplate';
 import { Uri } from 'vscode';
 import { PreferenceWizardData } from 'wizard/PreferenceWizard';
 import indentString from 'indent-string';
 import Magento from 'util/Magento';
 import FileGenerator from 'generator/FileGenerator';
+import HandlebarsTemplateRenderer from 'generator/HandlebarsTemplateRenderer';
 
 export default class PreferenceDiGenerator extends FileGenerator {
   public constructor(protected data: PreferenceWizardData) {
@@ -23,7 +23,9 @@ export default class PreferenceDiGenerator extends FileGenerator {
     const diXml = await FindOrCreateDiXml.execute(workspaceUri, vendor, module, this.data.area);
     const insertPosition = this.getInsertPosition(diXml);
 
-    const pluginXml = await GenerateFromTemplate.generate('xml/preference', {
+    const renderer = new HandlebarsTemplateRenderer();
+
+    const pluginXml = await renderer.render('xml/preference', {
       forClass: this.data.parentClass,
       typeClass: typeNamespace,
     });

src/generator/util/FindOrCreateDiXml.ts

@@ -1,9 +1,9 @@
 import { Uri } from 'vscode';
 import FileSystem from 'util/FileSystem';
-import GenerateFromTemplate from './GenerateFromTemplate';
 import FileHeader from 'common/xml/FileHeader';
 import { MagentoScope } from 'types';
 import Magento from 'util/Magento';
+import HandlebarsTemplateRenderer from '../HandlebarsTemplateRenderer';
 
 export default class FindOrCreateDiXml {
   public static async execute(
@@ -21,7 +21,9 @@ export default class FindOrCreateDiXml {
 
     const fileHeader = FileHeader.getHeader(module);
 
-    return await GenerateFromTemplate.generate('xml/blank-di', {
+    const renderer = new HandlebarsTemplateRenderer();
+
+    return await renderer.render('xml/blank-di', {
       fileHeader,
     });
   }

src/generator/util/FindOrCreateEventsXml.ts

@@ -1,8 +1,8 @@
 import { Uri } from 'vscode';
 import FileSystem from 'util/FileSystem';
-import GenerateFromTemplate from './GenerateFromTemplate';
 import { MagentoScope } from 'types';
 import FileHeader from 'common/xml/FileHeader';
+import HandlebarsTemplateRenderer from '../HandlebarsTemplateRenderer';
 
 export default class FindOrCreateEventsXml {
   public static async execute(
@@ -27,9 +27,11 @@ export default class FindOrCreateEventsXml {
       return await FileSystem.readFile(eventsFile);
     }
 
+    const renderer = new HandlebarsTemplateRenderer();
+
     const fileHeader = FileHeader.getHeader(`${vendor}_${module}`);
 
-    return await GenerateFromTemplate.generate('xml/blank-events', {
+    return await renderer.render('xml/blank-events', {
       fileHeader,
     });
   }