From bc6d4ea5154fd8c9ad7c46bc56152f0baa7d4dec Mon Sep 17 00:00:00 2001 From: Mykola Donin Date: Mon, 14 Feb 2022 15:59:29 +0200 Subject: [PATCH 1/2] 980: Added widget.xml file in context generation --- resources/META-INF/plugin.xml | 2 + .../internal/Magento Widget XML.xml.ft | 5 ++ .../internal/Magento Widget XML.xml.html | 19 +++++++ .../context/xml/NewWidgetXmlAction.java | 57 +++++++++++++++++++ .../magento/files/ModuleWidgetXmlFile.java | 30 ++++++++++ 5 files changed, 113 insertions(+) create mode 100644 resources/fileTemplates/internal/Magento Widget XML.xml.ft create mode 100644 resources/fileTemplates/internal/Magento Widget XML.xml.html create mode 100644 src/com/magento/idea/magento2plugin/actions/context/xml/NewWidgetXmlAction.java create mode 100644 src/com/magento/idea/magento2plugin/magento/files/ModuleWidgetXmlFile.java diff --git a/resources/META-INF/plugin.xml b/resources/META-INF/plugin.xml index bacddef60..9167f2b08 100644 --- a/resources/META-INF/plugin.xml +++ b/resources/META-INF/plugin.xml @@ -65,6 +65,7 @@ + @@ -569,6 +570,7 @@ + diff --git a/resources/fileTemplates/internal/Magento Widget XML.xml.ft b/resources/fileTemplates/internal/Magento Widget XML.xml.ft new file mode 100644 index 000000000..e1fd41fba --- /dev/null +++ b/resources/fileTemplates/internal/Magento Widget XML.xml.ft @@ -0,0 +1,5 @@ + +#parse("XML File Header.xml") + + diff --git a/resources/fileTemplates/internal/Magento Widget XML.xml.html b/resources/fileTemplates/internal/Magento Widget XML.xml.html new file mode 100644 index 000000000..54cd6ee64 --- /dev/null +++ b/resources/fileTemplates/internal/Magento Widget XML.xml.html @@ -0,0 +1,19 @@ + + + + +

+ Widgets provide powerful features in Magento 2, that are used to add dynamic or static content to store’s pages. +

+

+ Read more about widget.xml in the + DevDocs. +

+ + + \ No newline at end of file diff --git a/src/com/magento/idea/magento2plugin/actions/context/xml/NewWidgetXmlAction.java b/src/com/magento/idea/magento2plugin/actions/context/xml/NewWidgetXmlAction.java new file mode 100644 index 000000000..2a4d886d0 --- /dev/null +++ b/src/com/magento/idea/magento2plugin/actions/context/xml/NewWidgetXmlAction.java @@ -0,0 +1,57 @@ +/* + * Copyright © Magento, Inc. All rights reserved. + * See COPYING.txt for license details. + */ + +package com.magento.idea.magento2plugin.actions.context.xml; + +import com.intellij.ide.fileTemplates.actions.AttributesDefaults; +import com.intellij.psi.PsiDirectory; +import com.intellij.psi.PsiFile; +import com.magento.idea.magento2plugin.actions.context.AbstractContextAction; +import com.magento.idea.magento2plugin.magento.files.ModuleWidgetXmlFile; +import com.magento.idea.magento2plugin.magento.packages.ComponentType; +import com.magento.idea.magento2plugin.magento.packages.Package; +import com.magento.idea.magento2plugin.util.magento.GetMagentoModuleUtil; +import org.jetbrains.annotations.NotNull; + +public class NewWidgetXmlAction extends AbstractContextAction { + + public static final String ACTION_NAME = "Magento 2 Widget File"; + public static final String ACTION_DESCRIPTION = "Create a new Magento 2 widget.xml file"; + + /** + * New widget.xml file generation action constructor. + */ + public NewWidgetXmlAction() { + super(ACTION_NAME, ACTION_DESCRIPTION, new ModuleWidgetXmlFile()); + } + + @Override + protected boolean isVisible( + final @NotNull GetMagentoModuleUtil.MagentoModuleData moduleData, + final @NotNull PsiDirectory targetDirectory, + final PsiFile targetFile + ) { + final PsiDirectory configDir = moduleData.getConfigDir(); + + if (configDir == null) { + return false; + } + + return targetDirectory.getName().equals(Package.moduleBaseAreaDir) + && targetDirectory.equals(configDir) + && moduleData.getType().equals(ComponentType.module); + } + + + @Override + protected AttributesDefaults getProperties( + final @NotNull AttributesDefaults defaults, + final @NotNull GetMagentoModuleUtil.MagentoModuleData moduleData, + final PsiDirectory targetDirectory, + final PsiFile targetFile + ) { + return defaults; + } +} diff --git a/src/com/magento/idea/magento2plugin/magento/files/ModuleWidgetXmlFile.java b/src/com/magento/idea/magento2plugin/magento/files/ModuleWidgetXmlFile.java new file mode 100644 index 000000000..1f4e544df --- /dev/null +++ b/src/com/magento/idea/magento2plugin/magento/files/ModuleWidgetXmlFile.java @@ -0,0 +1,30 @@ +/* + * Copyright © Magento, Inc. All rights reserved. + * See COPYING.txt for license details. + */ + +package com.magento.idea.magento2plugin.magento.files; + +import com.intellij.lang.Language; +import com.intellij.lang.xml.XMLLanguage; + +public final class ModuleWidgetXmlFile implements ModuleFileInterface { + + public static final String FILE_NAME = "widget.xml"; + public static final String TEMPLATE = "Magento Widget XML"; + + @Override + public String getFileName() { + return FILE_NAME; + } + + @Override + public String getTemplate() { + return TEMPLATE; + } + + @Override + public Language getLanguage() { + return XMLLanguage.INSTANCE; + } +} From accf8b53157ca43b60567bbdde7206ce5cb28526 Mon Sep 17 00:00:00 2001 From: Mykola Donin Date: Mon, 14 Feb 2022 20:15:27 +0200 Subject: [PATCH 2/2] 980: update code style --- resources/fileTemplates/internal/Magento Widget XML.xml.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/resources/fileTemplates/internal/Magento Widget XML.xml.html b/resources/fileTemplates/internal/Magento Widget XML.xml.html index 54cd6ee64..bf8c42245 100644 --- a/resources/fileTemplates/internal/Magento Widget XML.xml.html +++ b/resources/fileTemplates/internal/Magento Widget XML.xml.html @@ -16,4 +16,4 @@

- \ No newline at end of file +