@grafana/create-plugin 0.4.1 → 0.5.0

package/CHANGELOG.md

@@ -1,3 +1,24 @@
+# v0.5.0 (Mon Nov 07 2022)
+
+:tada: This release contains work from a new contributor! :tada:
+
+Thank you, Giuseppe Guerra ([@xnyo](https://github.com/xnyo)), for all your work!
+
+#### 🚀 Enhancement
+
+- Create-Plugin: Implement DataSourceWithBackend for datasource plugins with backend [#134](https://github.com/grafana/plugin-tools/pull/134) ([@xnyo](https://github.com/xnyo))
+
+#### 🐛 Bug Fix
+
+- Use pluginId to generate the docker-compose.yml file [#128](https://github.com/grafana/plugin-tools/pull/128) ([@academo](https://github.com/academo))
+
+#### Authors: 2
+
+- Esteban Beltran ([@academo](https://github.com/academo))
+- Giuseppe Guerra ([@xnyo](https://github.com/xnyo))
+
+---
+
 # v0.4.1 (Mon Oct 31 2022)
 
 #### 🐛 Bug Fix

package/dist/commands/generate.plopfile.js

@@ -1,4 +1,15 @@
 "use strict";
+var __assign = (this && this.__assign) || function () {
+    __assign = Object.assign || function(t) {
+        for (var s, i = 1, n = arguments.length; i < n; i++) {
+            s = arguments[i];
+            for (var p in s) if (Object.prototype.hasOwnProperty.call(s, p))
+                t[p] = s[p];
+        }
+        return t;
+    };
+    return __assign.apply(this, arguments);
+};
 var __spreadArray = (this && this.__spreadArray) || function (to, from, pack) {
     if (pack || arguments.length === 2) for (var i = 0, l = from.length, ar; i < l; i++) {
         if (ar || !(i in from)) {
@@ -80,7 +91,12 @@ function default_1(plop) {
         actions: function (_a) {
             var pluginName = _a.pluginName, orgName = _a.orgName, pluginType = _a.pluginType, hasBackend = _a.hasBackend, hasGithubWorkflows = _a.hasGithubWorkflows, hasGithubLevitateWorkflow = _a.hasGithubLevitateWorkflow;
             var exportPath = getExportPath(pluginName, orgName, pluginType);
-            var commonActions = getActionsForTemplateFolder({ folderPath: constants_1.TEMPLATE_PATHS.common, exportPath: exportPath });
+            var pluginId = (0, utils_handlebars_1.normalizeId)(pluginName, orgName, pluginType);
+            var commonActions = getActionsForTemplateFolder({
+                folderPath: constants_1.TEMPLATE_PATHS.common,
+                exportPath: exportPath,
+                templateData: { pluginId: pluginId }
+            });
             var pluginTypeSpecificActions = getActionsForTemplateFolder({
                 folderPath: constants_1.TEMPLATE_PATHS[pluginType],
                 exportPath: exportPath
@@ -118,7 +134,7 @@ function replacePatternWithTemplateInReadme(pattern, partialsFile, exportPath) {
     };
 }
 function getActionsForTemplateFolder(_a) {
-    var folderPath = _a.folderPath, exportPath = _a.exportPath;
+    var folderPath = _a.folderPath, exportPath = _a.exportPath, _b = _a.templateData, templateData = _b === void 0 ? {} : _b;
     var files = glob_1["default"].sync("".concat(folderPath, "/**"), { dot: true });
     function getExportFileName(f) {
         if (path_1["default"].basename(f) === 'gitignore') {
@@ -135,7 +151,7 @@ function getActionsForTemplateFolder(_a) {
         path: path_1["default"].join(exportPath, getExportPath(f), getExportFileName(f)),
         force: constants_1.IS_DEV,
         abortOnFail: false,
-        data: constants_1.EXTRA_TEMPLATE_VARIABLES
+        data: __assign(__assign({}, constants_1.EXTRA_TEMPLATE_VARIABLES), templateData)
     }); });
 }
 function isFile(path) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/create-plugin",
-  "version": "0.4.1",
+  "version": "0.5.0",
   "main": "index.js",
   "repository": {
     "directory": "packages/create-plugin",
@@ -59,5 +59,5 @@
   "engines": {
     "node": ">=16"
   },
-  "gitHead": "ded867f4ea88599fb923a9d7c71514e1f6b85c00"
+  "gitHead": "e1bd595325dbb9ff838c2e3d674ab5c4f4a67a92"
 }

package/src/commands/generate.plopfile.ts

@@ -93,8 +93,13 @@ export default function (plop: NodePlopAPI) {
       hasGithubLevitateWorkflow,
     }: CliArgs) {
       const exportPath = getExportPath(pluginName, orgName, pluginType);
+      const pluginId = normalizeId(pluginName, orgName, pluginType);
       // Copy over files that are shared between plugins types
-      const commonActions = getActionsForTemplateFolder({ folderPath: TEMPLATE_PATHS.common, exportPath });
+      const commonActions = getActionsForTemplateFolder({
+        folderPath: TEMPLATE_PATHS.common,
+        exportPath,
+        templateData: { pluginId },
+      });
 
       // Copy over files from the plugin type specific folder, e.g. "tempaltes/app" for "app" plugins ("app" | "panel" | "datasource").
       const pluginTypeSpecificActions = getActionsForTemplateFolder({
@@ -163,7 +168,15 @@ function replacePatternWithTemplateInReadme(
 }
 
 // TODO<use Plop action `addMany` instead>
-function getActionsForTemplateFolder({ folderPath, exportPath }: { folderPath: string; exportPath: string }) {
+function getActionsForTemplateFolder({
+  folderPath,
+  exportPath,
+  templateData = {},
+}: {
+  folderPath: string;
+  exportPath: string;
+  templateData?: Record<string, string>;
+}) {
   const files = glob.sync(`${folderPath}/**`, { dot: true });
   function getExportFileName(f: string) {
     // yarn and npm packing will not include `.gitignore` files
@@ -186,7 +199,10 @@ function getActionsForTemplateFolder({ folderPath, exportPath }: { folderPath: s
     force: IS_DEV,
     // We would still like to scaffold as many files as possible even if one fails
     abortOnFail: false,
-    data: EXTRA_TEMPLATE_VARIABLES,
+    data: {
+      ...EXTRA_TEMPLATE_VARIABLES,
+      ...templateData,
+    },
   }));
 }
 

package/templates/backend/src/datasource.ts

@@ -0,0 +1,10 @@
+import { DataSourceInstanceSettings } from '@grafana/data';
+
+import { MyQuery, MyDataSourceOptions } from './types';
+import { DataSourceWithBackend } from '@grafana/runtime';
+
+export class DataSource extends DataSourceWithBackend<MyQuery, MyDataSourceOptions> {
+  constructor(instanceSettings: DataSourceInstanceSettings<MyDataSourceOptions>) {
+    super(instanceSettings);
+  }
+}

package/templates/common/docker-compose.yaml

@@ -2,7 +2,7 @@ version: '3.0'
 
 services:
   grafana:
-    container_name: '{{ normalize_id pluginName orgName pluginType }}'
+    container_name: '{{ pluginId }}'
     build:
       context: ./.config
       args:
@@ -10,5 +10,5 @@ services:
     ports:
       - 3000:3000/tcp
     volumes:
-      - ./dist:/var/lib/grafana/plugins/{{ normalize_id pluginName orgName pluginType }}
+      - ./dist:/var/lib/grafana/plugins/{{ pluginId }}
       - ./provisioning:/etc/grafana/provisioning