@grafana/create-plugin 0.6.2 → 0.6.3

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+# v0.6.3 (Mon Nov 28 2022)
+
+#### 🐛 Bug Fix
+
+- Create Plugin: Fix incorrect templates being used for scaffolding [#158](https://github.com/grafana/plugin-tools/pull/158) ([@jackw](https://github.com/jackw))
+
+#### Authors: 1
+
+- Jack Westbrook ([@jackw](https://github.com/jackw))
+
+---
+
 # v0.6.2 (Thu Nov 24 2022)
 
 #### 🐛 Bug Fix

package/dist/commands/generate.plopfile.js

@@ -105,6 +105,14 @@ function default_1(plop) {
             var backendActions = hasBackend
                 ? getActionsForTemplateFolder({ folderPath: backendFolderPath, exportPath: exportPath })
                 : [];
+            var pluginActions = __spreadArray(__spreadArray(__spreadArray([], backendActions, true), pluginTypeSpecificActions, true), commonActions, true).reduce(function (acc, file) {
+                var actionExists = acc.find(function (f) { return f.path === file.path; });
+                if (actionExists && actionExists.type === 'add' && file.type === 'add') {
+                    return acc;
+                }
+                acc.push(file);
+                return acc;
+            }, []);
             var ciWorkflowActions = hasGithubWorkflows
                 ? getActionsForTemplateFolder({ folderPath: constants_1.TEMPLATE_PATHS.ciWorkflows, exportPath: exportPath })
                 : [];
@@ -112,7 +120,7 @@ function default_1(plop) {
                 ? getActionsForTemplateFolder({ folderPath: constants_1.TEMPLATE_PATHS.isCompatibleWorkflow, exportPath: exportPath })
                 : [];
             var readmeActions = getActionsForReadme({ exportPath: exportPath });
-            return __spreadArray(__spreadArray(__spreadArray(__spreadArray(__spreadArray(__spreadArray([], commonActions, true), pluginTypeSpecificActions, true), backendActions, true), ciWorkflowActions, true), readmeActions, true), isCompatibleWorkflowActions, true);
+            return __spreadArray(__spreadArray(__spreadArray(__spreadArray([], pluginActions, true), ciWorkflowActions, true), readmeActions, true), isCompatibleWorkflowActions, true);
         }
     });
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/create-plugin",
-  "version": "0.6.2",
+  "version": "0.6.3",
   "main": "index.js",
   "repository": {
     "directory": "packages/create-plugin",
@@ -60,5 +60,5 @@
   "engines": {
     "node": ">=16"
   },
-  "gitHead": "3095dcb3b735c93b0c4fa64d9d5f8590b0030293"
+  "gitHead": "f1dc565ab40f62006c023bc3eda23e8ebeed6ae7"
 }

package/src/commands/generate.plopfile.ts

@@ -101,7 +101,7 @@ export default function (plop: NodePlopAPI) {
         templateData: { pluginId },
       });
 
-      // Copy over files from the plugin type specific folder, e.g. "tempaltes/app" for "app" plugins ("app" | "panel" | "datasource").
+      // Copy over files from the plugin type specific folder, e.g. "templates/app" for "app" plugins ("app" | "panel" | "datasource").
       const pluginTypeSpecificActions = getActionsForTemplateFolder({
         folderPath: TEMPLATE_PATHS[pluginType],
         exportPath,
@@ -113,6 +113,20 @@ export default function (plop: NodePlopAPI) {
         ? getActionsForTemplateFolder({ folderPath: backendFolderPath, exportPath })
         : [];
 
+      // Common, pluginType and backend actions can contain different templates for the same destination.
+      // This filtering removes the duplicate file additions to prevent plop erroring and makes sure the
+      // correct template is scaffolded.
+      // Note that the order is reversed so backend > pluginType > common
+      const pluginActions = [...backendActions, ...pluginTypeSpecificActions, ...commonActions].reduce((acc, file) => {
+        const actionExists = acc.find((f) => f.path === file.path);
+        // return early to prevent multiple add type actions being added to the array
+        if (actionExists && actionExists.type === 'add' && file.type === 'add') {
+          return acc;
+        }
+        acc.push(file);
+        return acc;
+      }, []);
+
       // Copy over Github workflow files (if selected)
       const ciWorkflowActions = hasGithubWorkflows
         ? getActionsForTemplateFolder({ folderPath: TEMPLATE_PATHS.ciWorkflows, exportPath })
@@ -125,14 +139,7 @@ export default function (plop: NodePlopAPI) {
       // Replace conditional bits in the Readme files
       const readmeActions = getActionsForReadme({ exportPath });
 
-      return [
-        ...commonActions,
-        ...pluginTypeSpecificActions,
-        ...backendActions,
-        ...ciWorkflowActions,
-        ...readmeActions,
-        ...isCompatibleWorkflowActions,
-      ];
+      return [...pluginActions, ...ciWorkflowActions, ...readmeActions, ...isCompatibleWorkflowActions];
     },
   });
 }
@@ -196,7 +203,7 @@ function getActionsForTemplateFolder({
     templateFile: f,
     // The target path where the compiled template is saved to
     path: path.join(exportPath, getExportPath(f), getExportFileName(f)),
-    // We would like to override generated files in development mode
+    // Support overriding files in development for overriding "generated" plugins.
     force: IS_DEV,
     // We would still like to scaffold as many files as possible even if one fails
     abortOnFail: false,