@grafana/create-plugin 0.6.1 → 0.6.2-canary.158.e2fc550.0

package/README.md

@@ -8,7 +8,7 @@ Create Grafana plugins with ease.
   - [Create a new plugin](#create-a-new-plugin)
     - [Quick overview](#quick-overview)
       - [`yarn` (1.x)](#yarn-1x)
-      - [`yarn` (> 2.x)](#yarn--2x)
+      - [`yarn` (\> 2.x)](#yarn--2x)
       - [`npx`](#npx)
       - [`npm`](#npm)
   - [Migrate your existing plugin](#migrate-your-existing-plugin)
@@ -61,6 +61,7 @@ npm init @grafana/plugin
 ---
 
 ## Migrate your existing plugin
+:warning: We [do not support](https://grafana.com/docs/grafana/latest/developers/angular_deprecation/) plugins written in `angular`
 
 In case you have an existing plugin previously created using the `@grafana/toolkit` you can use the
 following command to migrate it to the new build tooling:

package/dist/commands/generate.plopfile.js

@@ -105,6 +105,15 @@ function default_1(plop) {
             var backendActions = hasBackend
                 ? getActionsForTemplateFolder({ folderPath: backendFolderPath, exportPath: exportPath })
                 : [];
+            var pluginActions = __spreadArray(__spreadArray(__spreadArray([], commonActions, true), pluginTypeSpecificActions, true), backendActions, true).reduceRight(function (acc, file) {
+                var exists = acc.some(function (f) { return f.path === file.path; });
+                if (exists && file.type !== 'modify') {
+                    return acc;
+                }
+                acc.push(file);
+                return acc;
+            }, [])
+                .reverse();
             var ciWorkflowActions = hasGithubWorkflows
                 ? getActionsForTemplateFolder({ folderPath: constants_1.TEMPLATE_PATHS.ciWorkflows, exportPath: exportPath })
                 : [];
@@ -112,7 +121,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.1",
+  "version": "0.6.2-canary.158.e2fc550.0",
   "main": "index.js",
   "repository": {
     "directory": "packages/create-plugin",
@@ -60,5 +60,5 @@
   "engines": {
     "node": ">=16"
   },
-  "gitHead": "03f7684959edf280722d5d5fed80de83383422b0"
+  "gitHead": "e2fc5503dc5eb38c10ff0db191f57c0eda0d5fcd"
 }

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,21 @@ export default function (plop: NodePlopAPI) {
         ? getActionsForTemplateFolder({ folderPath: backendFolderPath, exportPath })
         : [];
 
+      // Common, pluginType and backend actions can contain the same destination filenames.
+      // This filtering allows overriding templates by removing the duplication destinations
+      const pluginActions = [...commonActions, ...pluginTypeSpecificActions, ...backendActions]
+        .reduceRight((acc, file) => {
+          const exists = acc.some((f) => f.path === file.path);
+          // if the file.path already exists and isn't a modification exclude it.
+          if (exists && file.type !== 'modify') {
+            return acc;
+          }
+
+          acc.push(file);
+          return acc;
+        }, [])
+        .reverse();
+
       // Copy over Github workflow files (if selected)
       const ciWorkflowActions = hasGithubWorkflows
         ? getActionsForTemplateFolder({ folderPath: TEMPLATE_PATHS.ciWorkflows, exportPath })
@@ -125,14 +140,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 +204,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,