feat: copy magento path command

Author: raideer

package.json

@@ -38,13 +38,21 @@
       {
         "command": "magento-toolbox.generateContextPlugin",
         "title": "Magento Toolbox: Generate Plugin"
+      },
+      {
+        "command": "magento-toolbox.copyMagentoPath",
+        "title": "Magento Toolbox: Copy Magento Path"
       }
     ],
     "menus": {
       "commandPalette": [
         {
           "command": "magento-toolbox.generateContextPlugin",
           "when": "false"
+        },
+        {
+          "command": "magento-toolbox.copyMagentoPath",
+          "when": "false"
         }
       ],
       "editor/context": [
@@ -64,6 +72,13 @@
           "command": "magento-toolbox.generateContextPlugin",
           "when": "magento-toolbox.canGeneratePlugin"
         }
+      ],
+      "magento-toolbox.explorer-submenu": [
+        {
+          "command": "magento-toolbox.copyMagentoPath",
+          "title": "Magento Toolbox: Copy Magento Path",
+          "when": "resourceExtname in magento-toolbox.supportedMagentoPathExtensions && resourcePath =~ /view/"
+        }
       ]
     }
   },

src/command/CopyMagentoPathCommand.ts

@@ -0,0 +1,85 @@
+import { Command } from 'command/Command';
+import IndexManager from 'indexer/IndexManager';
+import { ModuleIndexData } from 'indexer/module/ModuleIndexData';
+import ModuleIndexer from 'indexer/module/ModuleIndexer';
+import { Uri, window, env } from 'vscode';
+
+export default class CopyMagentoPathCommand extends Command {
+  public static readonly TEMPLATE_EXTENSIONS = ['.phtml'];
+  public static readonly WEB_EXTENSIONS = ['.css', '.js'];
+  public static readonly IMAGE_EXTENSIONS = ['.png', '.jpg', '.jpeg', '.gif', '.svg'];
+
+  private static readonly TEMPLATE_PATHS = [
+    'view/frontend/templates/',
+    'view/adminhtml/templates/',
+    'view/base/templates/',
+    'templates/',
+  ];
+
+  private static readonly WEB_PATHS = [
+    'view/frontend/web/',
+    'view/adminhtml/web/',
+    'view/base/web/',
+    'web/',
+  ];
+
+  constructor() {
+    super('magento-toolbox.copyMagentoPath');
+  }
+
+  public async execute(file: Uri): Promise<void> {
+    if (!file) {
+      return;
+    }
+
+    const moduleIndex = IndexManager.getIndexData(ModuleIndexer.KEY);
+
+    if (!moduleIndex) {
+      return;
+    }
+
+    const moduleIndexData = new ModuleIndexData(moduleIndex);
+
+    const module = moduleIndexData.getModuleByUri(file);
+
+    if (!module) {
+      return;
+    }
+
+    const paths = this.getPaths(file);
+
+    if (!paths) {
+      return;
+    }
+
+    const pathIndex = paths.findIndex(p => file.fsPath.lastIndexOf(p) !== -1);
+
+    if (pathIndex === -1) {
+      return;
+    }
+
+    const endIndex = file.fsPath.lastIndexOf(paths[pathIndex]);
+    const offset = paths[pathIndex].length;
+    const relativePath = file.fsPath.slice(offset + endIndex);
+
+    const magentoPath = `${module.name}::${relativePath}`;
+
+    await env.clipboard.writeText(magentoPath);
+    window.showInformationMessage(`Copied: ${magentoPath}`);
+  }
+
+  private getPaths(file: Uri): string[] | undefined {
+    if (CopyMagentoPathCommand.TEMPLATE_EXTENSIONS.some(ext => file.fsPath.endsWith(ext))) {
+      return CopyMagentoPathCommand.TEMPLATE_PATHS;
+    }
+
+    if (
+      CopyMagentoPathCommand.WEB_EXTENSIONS.some(ext => file.fsPath.endsWith(ext)) ||
+      CopyMagentoPathCommand.IMAGE_EXTENSIONS.some(ext => file.fsPath.endsWith(ext))
+    ) {
+      return CopyMagentoPathCommand.WEB_PATHS;
+    }
+
+    return undefined;
+  }
+}

src/common/Context.ts

@@ -1,26 +1,29 @@
 import { commands, TextEditor } from 'vscode';
 import PhpDocumentParser from './php/PhpDocumentParser';
+import CopyMagentoPathCommand from 'command/CopyMagentoPathCommand';
 
 export interface EditorContext {
   canGeneratePlugin: boolean;
+  supportedMagentoPathExtensions: string[];
 }
 
 class Context {
-  public editorContext: EditorContext = {
-    canGeneratePlugin: false,
-  };
+  private editorContext: EditorContext;
+
+  constructor() {
+    this.editorContext = this.getDefaultContext();
+  }
 
   public async updateContext(type: 'editor' | 'selection', editor?: TextEditor) {
     if (!editor) {
-      await this.setContext({
-        canGeneratePlugin: false,
-      });
+      await this.setContext(this.getDefaultContext());
 
       return;
     }
 
     if (type === 'editor') {
       await this.setContext({
+        ...this.editorContext,
         canGeneratePlugin: await this.canGeneratePlugin(editor),
       });
     }
@@ -37,6 +40,17 @@ class Context {
     await Promise.all(promises);
   }
 
+  public getDefaultContext(): EditorContext {
+    return {
+      canGeneratePlugin: false,
+      supportedMagentoPathExtensions: [
+        ...CopyMagentoPathCommand.TEMPLATE_EXTENSIONS,
+        ...CopyMagentoPathCommand.WEB_EXTENSIONS,
+        ...CopyMagentoPathCommand.IMAGE_EXTENSIONS,
+      ],
+    };
+  }
+
   private async canGeneratePlugin(editor: TextEditor): Promise<boolean> {
     if (editor.document.languageId !== 'php') {
       return false;

src/extension.ts

@@ -11,11 +11,18 @@ import ChangeTextEditorSelectionObserver from 'observer/ChangeTextEditorSelectio
 import DocumentCache from 'cache/DocumentCache';
 import GenerateContextPluginCommand from 'command/GenerateContextPluginCommand';
 import { XmlClasslikeDefinitionProvider } from 'definition/XmlClasslikeDefinitionProvider';
+import CopyMagentoPathCommand from 'command/CopyMagentoPathCommand';
+
 // This method is called when your extension is activated
 // Your extension is activated the very first time the command is executed
 export async function activate(context: vscode.ExtensionContext) {
   console.log('[Magento Toolbox] Activating extension');
-  const commands = [IndexWorkspaceCommand, GenerateModuleCommand, GenerateContextPluginCommand];
+  const commands = [
+    IndexWorkspaceCommand,
+    GenerateModuleCommand,
+    GenerateContextPluginCommand,
+    CopyMagentoPathCommand,
+  ];
 
   ExtensionState.init(context);
 

src/indexer/module/ModuleIndexData.ts

@@ -1,6 +1,7 @@
 import { WizardSelectOption } from 'webview/types';
 import { Module } from './types';
 import { IndexData } from 'indexer/IndexData';
+import { Uri } from 'vscode';
 
 export class ModuleIndexData extends IndexData<Module> {
   public getModuleOptions(filter?: (module: Module) => boolean): WizardSelectOption[] {
@@ -15,4 +16,12 @@ export class ModuleIndexData extends IndexData<Module> {
   public getModule(name: string): Module | undefined {
     return this.getValues().find(module => module.name === name);
   }
+
+  public getModuleByUri(uri: Uri): Module | undefined {
+    const module = this.getValues().find(module => {
+      return uri.fsPath.startsWith(module.path);
+    });
+
+    return module;
+  }
 }

src/indexer/module/ModuleIndexer.ts

@@ -54,7 +54,7 @@ export default class ModuleIndexer extends Indexer<Module> {
       name: moduleName,
       version: setupVersion,
       sequence: sequence.map((module: any) => module['@_name']),
-      path: uri.fsPath,
+      path: Uri.joinPath(uri, '..', '..').fsPath,
       location: uri.fsPath.includes('vendor') ? 'vendor' : 'app',
     };
   }