1141: Add code include, don't show generation action if readme exists

makzef · makzef · commit 711100a4da32 · 2022-09-06T11:35:04.000+03:00
diff --git a/resources/fileTemplates/includes/MD File Description.md.ft b/resources/fileTemplates/includes/MD File Description.md.ft
@@ -0,0 +1,8 @@
+<!---
+    You can describe your module here.
+    We recommend that you add the following information:
+     - implementation details: why and how to use the module, preferably with some example scenarios
+     - any dependencies (usually other modules but could be any important dependencies, libraries, etc)
+     - extension points, APIs, plug-ins, etc
+     - any introduced events
+-->
diff --git a/resources/fileTemplates/includes/MD File Description.md.html b/resources/fileTemplates/includes/MD File Description.md.html
@@ -0,0 +1,12 @@
+<html>
+<body>
+<table width="100%" border="0" cellpadding="5" cellspacing="0" style="border-collapse: collapse; border-color:#111111">
+    <tr>
+        <td colspan="3"><font face="verdana" size="-1">This is a template is used to describe the MD file. It contains a code fragment that can be included into file templates
+            (<b>Templates</b> tab) with the help of the <b>#parse</b> directive.<br>
+            The template is editable. Along with the static text, code and comments.</font><br>
+        </td>
+    </tr>
+</table>
+</body>
+</html>
diff --git a/resources/fileTemplates/internal/Magento Module Readme File MD.md.ft b/resources/fileTemplates/internal/Magento Module Readme File MD.md.ft
@@ -1,10 +1,3 @@
 # ${PACKAGE}_${MODULE_NAME} module
 
-<!---
-    You can describe your module here.
-    We recommend that you add the following information:
-     - implementation details: why and how to use the module, preferably with some example scenarios
-     - any dependencies (usually other modules but could be any important dependencies, libraries, etc)
-     - extension points, APIs, plug-ins, etc
-     - any introduced events
--->
+#parse("MD File Description.md")
diff --git a/src/com/magento/idea/magento2plugin/actions/context/md/NewReadmeMdAction.java b/src/com/magento/idea/magento2plugin/actions/context/md/NewReadmeMdAction.java
@@ -8,6 +8,7 @@
 import com.intellij.ide.fileTemplates.actions.AttributesDefaults;
 import com.intellij.psi.PsiDirectory;
 import com.intellij.psi.PsiFile;
+import com.intellij.util.IncorrectOperationException;
 import com.magento.idea.magento2plugin.actions.context.AbstractContextAction;
 import com.magento.idea.magento2plugin.indexes.ModuleIndex;
 import com.magento.idea.magento2plugin.magento.files.ModuleReadmeMdFile;
@@ -41,7 +42,8 @@ protected boolean isVisible(
                 .split(Package.vendorModuleNameSeparator)[1];
 
         return targetDirectory.getName().equals(magentoModuleName)
-                && targetDirectory.equals(moduleDirectory);
+                && targetDirectory.equals(moduleDirectory)
+                && this.isFileCanBeCreated(moduleDirectory);
     }
 
     @Override
@@ -57,4 +59,16 @@ protected AttributesDefaults getProperties(
 
         return defaults;
     }
+
+    private @NotNull Boolean isFileCanBeCreated(
+            final @NotNull PsiDirectory moduleDirectory
+    ) {
+        try {
+            moduleDirectory.checkCreateFile(ModuleReadmeMdFile.FILE_NAME);
+        } catch (IncorrectOperationException exception) {
+            return false;
+        }
+
+        return true;
+    }
 }
