Merge branch 'feature/jump-to-module' into release

Author: raideer

.cursor/rules/commands.mdc

@@ -0,0 +1,10 @@
+---
+description: Describes how to create and register new commands
+globs: src/command/*.ts
+alwaysApply: false
+---
+- 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

package.json

@@ -57,111 +57,143 @@
     "commands": [
       {
         "command": "magento-toolbox.generateModule",
-        "title": "Magento Toolbox: Generate Module"
+        "title": "Generate Module",
+        "category": "Magento Toolbox"
       },
       {
         "command": "magento-toolbox.generateBlock",
-        "title": "Magento Toolbox: Generate Block"
+        "title": "Generate Block",
+        "category": "Magento Toolbox"
       },
       {
         "command": "magento-toolbox.indexWorkspace",
-        "title": "Magento Toolbox: Index Workspace"
+        "title": "Index Workspace",
+        "category": "Magento Toolbox"
       },
       {
         "command": "magento-toolbox.generateContextPlugin",
-        "title": "Magento Toolbox: Generate Plugin"
+        "title": "Generate Plugin",
+        "category": "Magento Toolbox"
       },
       {
         "command": "magento-toolbox.copyMagentoPath",
-        "title": "Magento Toolbox: Copy Magento Path"
+        "title": "Copy Magento Path",
+        "category": "Magento Toolbox"
       },
       {
         "command": "magento-toolbox.generateXmlCatalog",
-        "title": "Magento Toolbox: Generate XML URN Catalog"
+        "title": "Generate XML URN Catalog",
+        "category": "Magento Toolbox"
       },
       {
         "command": "magento-toolbox.generateObserver",
-        "title": "Magento Toolbox: Generate Observer"
+        "title": "Generate Observer",
+        "category": "Magento Toolbox"
       },
       {
         "command": "magento-toolbox.generateEventsXml",
-        "title": "Magento Toolbox: Generate Events XML"
+        "title": "Generate Sample events.xml",
+        "category": "Magento Toolbox"
       },
       {
         "command": "magento-toolbox.generateGraphqlSchemaFile",
-        "title": "Magento Toolbox: Generate GraphQL Schema File"
+        "title": "Generate Sample schema.graphqls",
+        "category": "Magento Toolbox"
       },
       {
         "command": "magento-toolbox.generateRoutesXmlFile",
-        "title": "Magento Toolbox: Generate Routes XML"
+        "title": "Generate Sample routes.xml",
+        "category": "Magento Toolbox"
       },
       {
         "command": "magento-toolbox.generateAclXmlFile",
-        "title": "Magento Toolbox: Generate ACL XML"
+        "title": "Generate Sample acl.xml",
+        "category": "Magento Toolbox"
       },
       {
         "command": "magento-toolbox.generateDiXmlFile",
-        "title": "Magento Toolbox: Generate DI XML"
+        "title": "Generate Sample di.xml",
+        "category": "Magento Toolbox"
       },
       {
         "command": "magento-toolbox.generateWebapiXmlFile",
-        "title": "Magento Toolbox: Generate Webapi XML"
+        "title": "Generate Sample webapi.xml",
+        "category": "Magento Toolbox"
       },
       {
         "command": "magento-toolbox.generatePreference",
-        "title": "Magento Toolbox: Generate Preference"
+        "title": "Generate Preference",
+        "category": "Magento Toolbox"
       },
       {
         "command": "magento-toolbox.generateLayoutXmlFile",
-        "title": "Magento Toolbox: Generate Layout XML"
+        "title": "Generate Layout XML",
+        "category": "Magento Toolbox"
       },
       {
         "command": "magento-toolbox.generatePageTypesXmlFile",
-        "title": "Magento Toolbox: Generate Page Types XML"
+        "title": "Generate Sample page_types.xml",
+        "category": "Magento Toolbox"
       },
       {
         "command": "magento-toolbox.generateCrontabXmlFile",
-        "title": "Magento Toolbox: Generate Crontab XML"
+        "title": "Generate Sample crontab.xml",
+        "category": "Magento Toolbox"
       },
       {
         "command": "magento-toolbox.generateEmailTemplatesXmlFile",
-        "title": "Magento Toolbox: Generate Email Templates XML"
+        "title": "Generate Sample email_templates.xml",
+        "category": "Magento Toolbox"
       },
       {
         "command": "magento-toolbox.generateSectionsXmlFile",
-        "title": "Magento Toolbox: Generate Sections XML"
+        "title": "Generate Sample sections.xml",
+        "category": "Magento Toolbox"
       },
       {
         "command": "magento-toolbox.generateFieldsetXmlFile",
-        "title": "Magento Toolbox: Generate Fieldset XML"
+        "title": "Generate Sample fieldset.xml",
+        "category": "Magento Toolbox"
       },
       {
         "command": "magento-toolbox.generateViewXmlFile",
-        "title": "Magento Toolbox: Generate View XML"
+        "title": "Generate Sample view.xml",
+        "category": "Magento Toolbox"
       },
       {
         "command": "magento-toolbox.generateIndexerXmlFile",
-        "title": "Magento Toolbox: Generate Indexer XML"
+        "title": "Generate Sample indexer.xml",
+        "category": "Magento Toolbox"
       },
       {
         "command": "magento-toolbox.generateMviewXmlFile",
-        "title": "Magento Toolbox: Generate MVIEW XML"
+        "title": "Generate Sample mview.xml",
+        "category": "Magento Toolbox"
       },
       {
         "command": "magento-toolbox.generateWidgetXmlFile",
-        "title": "Magento Toolbox: Generate Widget XML"
+        "title": "Generate Sample widget.xml",
+        "category": "Magento Toolbox"
       },
       {
         "command": "magento-toolbox.generateExtensionAttributesXmlFile",
-        "title": "Magento Toolbox: Generate Extension Attributes XML"
+        "title": "Generate Sample extension_attributes.xml",
+        "category": "Magento Toolbox"
       },
       {
         "command": "magento-toolbox.generateSystemXmlFile",
-        "title": "Magento Toolbox: Generate System XML"
+        "title": "Generate Sample system.xml",
+        "category": "Magento Toolbox"
       },
       {
         "command": "magento-toolbox.generateConfigXmlFile",
-        "title": "Magento Toolbox: Generate Config XML"
+        "title": "Generate Sample config.xml",
+        "category": "Magento Toolbox"
+      },
+      {
+        "command": "magento-toolbox.jumpToModule",
+        "title": "Jump to Module",
+        "category": "Magento Toolbox"
       }
     ],
     "menus": {

src/command/JumpToModuleCommand.ts

@@ -0,0 +1,39 @@
+import { Command } from 'command/Command';
+import { window } from 'vscode';
+import IndexManager from 'indexer/IndexManager';
+import ModuleIndexer from 'indexer/module/ModuleIndexer';
+import { Uri } from 'vscode';
+
+export default class JumpToModuleCommand extends Command {
+  constructor() {
+    super('magento-toolbox.jumpToModule');
+  }
+
+  public async execute(...args: any[]): Promise<void> {
+    const moduleIndexData = IndexManager.getIndexData(ModuleIndexer.KEY);
+
+    if (!moduleIndexData) {
+      window.showErrorMessage('Module index data not found');
+      return;
+    }
+
+    const moduleName = await window.showQuickPick(moduleIndexData.getModuleOptions(), {
+      placeHolder: 'Enter module name (e.g. Magento_Catalog)',
+    });
+
+    if (!moduleName) {
+      return;
+    }
+
+    const module = moduleIndexData.getModule(moduleName.label);
+
+    if (!module) {
+      window.showErrorMessage(`Module ${moduleName} not found`);
+      return;
+    }
+
+    const moduleXmlPath = Uri.file(`${module.path}/etc/module.xml`);
+
+    const document = await window.showTextDocument(moduleXmlPath);
+  }
+}

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/command/index.ts

@@ -25,3 +25,4 @@ export { default as GenerateWidgetXmlFileCommand } from './GenerateWidgetXmlFile
 export { default as GenerateExtensionAttributesXmlFileCommand } from './GenerateExtensionAttributesXmlFileCommand';
 export { default as GenerateSystemXmlFileCommand } from './GenerateSystemXmlFileCommand';
 export { default as GenerateConfigXmlFileCommand } from './GenerateConfigXmlFileCommand';
+export { default as JumpToModuleCommand } from './JumpToModuleCommand';

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}}');
   }
 }