@grafana/create-plugin 1.0.1 → 1.1.0

package/CHANGELOG.md

@@ -1,3 +1,26 @@
+# v1.1.0 (Mon Mar 06 2023)
+
+:tada: This release contains work from a new contributor! :tada:
+
+Thank you, Romain Gaillard ([@romain-gaillard](https://github.com/romain-gaillard)), for all your work!
+
+#### 🚀 Enhancement
+
+- Auto update grafana go sdk after generation [#214](https://github.com/grafana/plugin-tools/pull/214) ([@academo](https://github.com/academo))
+
+#### 🐛 Bug Fix
+
+- Bumped mage action to v2 to avoid the warning "Node.js 12 actions are… [#213](https://github.com/grafana/plugin-tools/pull/213) ([@romain-gaillard](https://github.com/romain-gaillard))
+- Fix datasource without backend template and update test CI [#206](https://github.com/grafana/plugin-tools/pull/206) ([@academo](https://github.com/academo))
+- Minor typo fixed and improved comment consistency in frontend-getting-started.md [#211](https://github.com/grafana/plugin-tools/pull/211) ([@romain-gaillard](https://github.com/romain-gaillard))
+
+#### Authors: 2
+
+- Esteban Beltran ([@academo](https://github.com/academo))
+- Romain Gaillard ([@romain-gaillard](https://github.com/romain-gaillard))
+
+---
+
 # v1.0.1 (Fri Mar 03 2023)
 
 :tada: This release contains work from a new contributor! :tada:

package/dist/commands/generate-actions/print-success-message.js

@@ -0,0 +1,32 @@
+"use strict";
+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)) {
+            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
+            ar[i] = from[i];
+        }
+    }
+    return to.concat(ar || Array.prototype.slice.call(from));
+};
+exports.__esModule = true;
+exports.printGenerateSuccessMessage = void 0;
+var utils_console_1 = require("../../utils/utils.console");
+var utils_handlebars_1 = require("../../utils/utils.handlebars");
+function printGenerateSuccessMessage(answers) {
+    var directory = (0, utils_handlebars_1.normalizeId)(answers.pluginName, answers.orgName, answers.pluginType);
+    var commands = __spreadArray(__spreadArray([
+        "- `cd ./".concat(directory, "`"),
+        '- `yarn install` to install frontend dependencies.',
+        '- `yarn dev` to build (and watch) the plugin frontend code.'
+    ], (answers.hasBackend
+        ? [
+            '- `mage -v build:linux` to build the plugin backend code. Rerun this command every time you edit your backend files.',
+        ]
+        : []), true), [
+        '- `docker-compose up` to start a grafana development server. Restart this command after each time you run mage to run your new backend code.',
+        '- Open http://localhost:3000 in your browser to create a dashboard to begin developing your plugin.',
+    ], false);
+    var msg = "\nCongratulations on scaffolding a Grafana ".concat(answers.pluginType, " plugin! \uD83D\uDE80\n\n## What's next?\n\nRun the following commands to get started:\n").concat(commands.map(function (command) { return command; }).join('\n'), "\n\n_Note: We strongly recommend creating a new Git repository by running `git init` in ./").concat(directory, " before continuing._\n\n- View create-plugin documentation at https://grafana.github.io/plugin-tools/\n- Learn more about Grafana Plugins at https://grafana.com/docs/grafana/latest/plugins/developing/development/\n");
+    return (0, utils_console_1.displayAsMarkdown)(msg);
+}
+exports.printGenerateSuccessMessage = printGenerateSuccessMessage;

package/dist/commands/generate-actions/update-go-sdk-and-packages.js

@@ -0,0 +1,79 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (_) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+exports.__esModule = true;
+exports.updateGoSdkAndModules = void 0;
+var utils_path_1 = require("../../utils/utils.path");
+var which_1 = __importDefault(require("which"));
+var fs_1 = __importDefault(require("fs"));
+var child_process_1 = require("child_process");
+var SDK_GO_MODULE = 'github.com/grafana/grafana-plugin-sdk-go';
+function updateGoSdkAndModules(_a) {
+    var _this = this;
+    var pluginName = _a.pluginName, orgName = _a.orgName, pluginType = _a.pluginType;
+    return new Promise(function (resolve, reject) { return __awaiter(_this, void 0, void 0, function () {
+        var exportPath, goModPath, goBinaryPath, command;
+        return __generator(this, function (_a) {
+            switch (_a.label) {
+                case 0:
+                    exportPath = (0, utils_path_1.getExportPath)(pluginName, orgName, pluginType);
+                    goModPath = "".concat(exportPath, "/go.mod");
+                    if (!fs_1["default"].existsSync(goModPath)) {
+                        resolve('');
+                    }
+                    return [4, (0, which_1["default"])('go', { nothrow: true })];
+                case 1:
+                    goBinaryPath = _a.sent();
+                    if (!goBinaryPath) {
+                        resolve('');
+                    }
+                    command = "go get ".concat(SDK_GO_MODULE);
+                    (0, child_process_1.exec)(command, { cwd: exportPath }, function (error) {
+                        if (error) {
+                            reject('There was an error trying to update the grafana go sdk. Please run `go get github.com/grafana/grafana-plugin-sdk-go` manually in your plugin directory.');
+                        }
+                        resolve('Grafana go sdk updated successfully.');
+                    });
+                    return [2];
+            }
+        });
+    }); });
+}
+exports.updateGoSdkAndModules = updateGoSdkAndModules;

package/dist/commands/generate.plopfile.js

@@ -27,12 +27,15 @@ var glob_1 = __importDefault(require("glob"));
 var path_1 = __importDefault(require("path"));
 var fs_1 = __importDefault(require("fs"));
 var utils_handlebars_1 = require("../utils/utils.handlebars");
-var utils_console_1 = require("../utils/utils.console");
 var constants_1 = require("../constants");
+var print_success_message_1 = require("./generate-actions/print-success-message");
+var update_go_sdk_and_packages_1 = require("./generate-actions/update-go-sdk-and-packages");
+var utils_path_1 = require("../utils/utils.path");
 function default_1(plop) {
     plop.setHelper('if_eq', utils_handlebars_1.ifEq);
     plop.setHelper('normalize_id', utils_handlebars_1.normalizeId);
-    plop.setActionType('printSuccessMessage', printSuccessMessage);
+    plop.setActionType('printSuccessMessage', print_success_message_1.printGenerateSuccessMessage);
+    plop.setActionType('updateGoSdkAndModules', update_go_sdk_and_packages_1.updateGoSdkAndModules);
     plop.setGenerator('create-plugin', {
         description: 'used to scaffold a grafana plugin',
         prompts: [
@@ -92,7 +95,7 @@ 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 exportPath = (0, utils_path_1.getExportPath)(pluginName, orgName, pluginType);
             var pluginId = (0, utils_handlebars_1.normalizeId)(pluginName, orgName, pluginType);
             var commonActions = getActionsForTemplateFolder({
                 folderPath: constants_1.TEMPLATE_PATHS.common,
@@ -123,6 +126,9 @@ function default_1(plop) {
                 : [];
             var readmeActions = getActionsForReadme({ exportPath: exportPath });
             return __spreadArray(__spreadArray(__spreadArray(__spreadArray(__spreadArray([], pluginActions, true), ciWorkflowActions, true), readmeActions, true), isCompatibleWorkflowActions, true), [
+                {
+                    type: 'updateGoSdkAndModules'
+                },
                 {
                     type: 'printSuccessMessage'
                 },
@@ -178,28 +184,3 @@ function isFile(path) {
         return false;
     }
 }
-function getExportPath(pluginName, orgName, pluginType) {
-    if (constants_1.IS_DEV) {
-        return constants_1.DEV_EXPORT_DIR;
-    }
-    else {
-        return path_1["default"].join(process.cwd(), (0, utils_handlebars_1.normalizeId)(pluginName, orgName, pluginType));
-    }
-}
-function printSuccessMessage(answers) {
-    var directory = (0, utils_handlebars_1.normalizeId)(answers.pluginName, answers.orgName, answers.pluginType);
-    var commands = __spreadArray(__spreadArray([
-        "- `cd ./".concat(directory, "`"),
-        '- `yarn install` to install frontend dependencies.',
-        '- `yarn dev` to build (and watch) the plugin frontend code.'
-    ], (answers.hasBackend
-        ? [
-            '- `mage -v build:linux` to build the plugin backend code. Rerun this command every time you edit your backend files.',
-        ]
-        : []), true), [
-        '- `docker-compose up` to start a grafana development server. Restart this command after each time you run mage to run your new backend code.',
-        '- Open http://localhost:3000 in your browser to create a dashboard to begin developing your plugin.',
-    ], false);
-    var msg = "\nCongratulations on scaffolding a Grafana ".concat(answers.pluginType, " plugin! \uD83D\uDE80\n\n## What's next?\n\nRun the following commands to get started:\n").concat(commands.map(function (command) { return command; }).join('\n'), "\n\n_Note: We strongly recommend creating a new Git repository by running `git init` in ./").concat(directory, " before continuing._\n\n- View create-plugin documentation at https://grafana.github.io/plugin-tools/\n- Learn more about Grafana Plugins at https://grafana.com/docs/grafana/latest/plugins/developing/development/\n");
-    return (0, utils_console_1.displayAsMarkdown)(msg);
-}

package/dist/commands/types.js

@@ -0,0 +1,2 @@
+"use strict";
+exports.__esModule = true;

package/dist/constants.js

@@ -30,7 +30,7 @@ var PLUGIN_TYPES;
     PLUGIN_TYPES["secretsmanager"] = "secretsmanager";
 })(PLUGIN_TYPES = exports.PLUGIN_TYPES || (exports.PLUGIN_TYPES = {}));
 exports.EXTRA_TEMPLATE_VARIABLES = {
-    grafanaVersion: '9.2.5'
+    grafanaVersion: '9.3.8'
 };
 exports.GRAFANA_FE_PACKAGES = [
     '@grafana/data',

package/dist/utils/utils.path.js

@@ -0,0 +1,18 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+exports.__esModule = true;
+exports.getExportPath = void 0;
+var path_1 = __importDefault(require("path"));
+var constants_1 = require("../constants");
+var utils_handlebars_1 = require("./utils.handlebars");
+function getExportPath(pluginName, orgName, pluginType) {
+    if (constants_1.IS_DEV) {
+        return constants_1.DEV_EXPORT_DIR;
+    }
+    else {
+        return path_1["default"].join(process.cwd(), (0, utils_handlebars_1.normalizeId)(pluginName, orgName, pluginType));
+    }
+}
+exports.getExportPath = getExportPath;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/create-plugin",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "main": "index.js",
   "repository": {
     "directory": "packages/create-plugin",
@@ -24,7 +24,8 @@
     "generate-app": "tsc && yarn clean-generated && CREATE_PLUGIN_DEV=true node ./scripts/generate-app.js",
     "generate-app-backend": "tsc && yarn clean-generated && CREATE_PLUGIN_DEV=true node ./scripts/generate-app-backend.js",
     "generate-panel": "tsc && yarn clean-generated && CREATE_PLUGIN_DEV=true node ./scripts/generate-panel.js",
-    "generate-datasource": "tsc && yarn clean-generated && CREATE_PLUGIN_DEV=true node ./scripts/generate-datasource.js",
+    "generate-datasource": "tsc && yarn clean-generated && CREATE_PLUGIN_DEV=true node ./scripts/generate-datasource-without-backend.js",
+    "generate-datasource-backend": "tsc && yarn clean-generated && CREATE_PLUGIN_DEV=true node ./scripts/generate-datasource-with-backend.js",
     "lint": "eslint --cache --ext .js,.jsx,.ts,.tsx ./src",
     "lint:fix": "yarn lint --fix",
     "test": "jest",
@@ -34,13 +35,15 @@
     "@types/minimist": "^1.2.2",
     "@types/mkdirp": "^1.0.2",
     "@types/semver": "^7.3.9",
+    "@types/which": "^2.0.2",
     "enquirer": "^2.3.6",
     "glob": "^7.1.7",
     "marked": "^4.0.12",
     "marked-terminal": "^5.1.1",
     "mkdirp": "^1.0.4",
     "plop": "^2.7.4",
-    "semver": "^7.3.5"
+    "semver": "^7.3.5",
+    "which": "^3.0.0"
   },
   "devDependencies": {
     "@types/glob": "^7.0.0",
@@ -60,5 +63,5 @@
   "engines": {
     "node": ">=16"
   },
-  "gitHead": "df4b2df88e1f540db9d6f3122115e1ac5bbdf2cf"
+  "gitHead": "411764c1c19aec00fb109d91c71c4aef109b05e2"
 }

package/scripts/generate-app-backend.js

@@ -2,7 +2,7 @@ const nodePlop = require('node-plop');
 const path = require('path');
 const fs = require('fs');
 
-async function generateApp() {
+async function generate() {
   const plopFile = path.join(__dirname, '../dist/commands/generate.plopfile.js');
   if (!fs.existsSync(plopFile)) {
     console.error('Run build first');
@@ -21,4 +21,4 @@ async function generateApp() {
   });
 }
 
-generateApp();
+generate();

package/scripts/generate-app.js

@@ -2,7 +2,7 @@ const nodePlop = require('node-plop');
 const path = require('path');
 const fs = require('fs');
 
-async function generatePanel() {
+async function generate() {
   const plopFile = path.join(__dirname, '../dist/commands/generate.plopfile.js');
   if (!fs.existsSync(plopFile)) {
     console.error('Run build first');
@@ -21,4 +21,4 @@ async function generatePanel() {
   });
 }
 
-generatePanel();
+generate();

package/scripts/{generate-datasource.js → generate-datasource-with-backend.js}

@@ -2,7 +2,7 @@ const nodePlop = require('node-plop');
 const path = require('path');
 const fs = require('fs');
 
-async function generatePanel() {
+async function generate() {
   const plopFile = path.join(__dirname, '../dist/commands/generate.plopfile.js');
   if (!fs.existsSync(plopFile)) {
     console.error('Run build first');
@@ -21,4 +21,4 @@ async function generatePanel() {
   });
 }
 
-generatePanel();
+generate();

package/scripts/generate-datasource-without-backend.js

@@ -0,0 +1,24 @@
+const nodePlop = require('node-plop');
+const path = require('path');
+const fs = require('fs');
+
+async function generate() {
+  const plopFile = path.join(__dirname, '../dist/commands/generate.plopfile.js');
+  if (!fs.existsSync(plopFile)) {
+    console.error('Run build first');
+    process.exit(1);
+  }
+  const plop = await nodePlop(plopFile);
+  const generator = plop.getGenerator('create-plugin');
+  await generator.runActions({
+    pluginName: 'my-plugin',
+    orgName: 'my-org',
+    pluginDescription: 'Auto-generated datasource',
+    pluginType: 'datasource',
+    hasBackend: false,
+    hasGithubWorkflows: true,
+    hasGithubLevitateWorkflow: true,
+  });
+}
+
+generate();

package/scripts/generate-panel.js

@@ -2,7 +2,7 @@ const nodePlop = require('node-plop');
 const path = require('path');
 const fs = require('fs');
 
-async function generatePanel() {
+async function generate() {
   const plopFile = path.join(__dirname, '../dist/commands/generate.plopfile.js');
   if (!fs.existsSync(plopFile)) {
     console.error('Run build first');
@@ -20,4 +20,4 @@ async function generatePanel() {
   });
 }
 
-generatePanel();
+generate();

package/src/commands/generate-actions/print-success-message.ts

@@ -0,0 +1,36 @@
+import { displayAsMarkdown } from '../../utils/utils.console';
+import { normalizeId } from '../../utils/utils.handlebars';
+import { CliArgs } from '../types';
+
+export function printGenerateSuccessMessage(answers: CliArgs) {
+  const directory = normalizeId(answers.pluginName, answers.orgName, answers.pluginType);
+
+  const commands = [
+    `- \`cd ./${directory}\``,
+    '- `yarn install` to install frontend dependencies.',
+    '- `yarn dev` to build (and watch) the plugin frontend code.',
+    ...(answers.hasBackend
+      ? [
+          '- `mage -v build:linux` to build the plugin backend code. Rerun this command every time you edit your backend files.',
+        ]
+      : []),
+    '- `docker-compose up` to start a grafana development server. Restart this command after each time you run mage to run your new backend code.',
+    '- Open http://localhost:3000 in your browser to create a dashboard to begin developing your plugin.',
+  ];
+
+  const msg = `
+Congratulations on scaffolding a Grafana ${answers.pluginType} plugin! 🚀
+
+## What's next?
+
+Run the following commands to get started:
+${commands.map((command) => command).join('\n')}
+
+_Note: We strongly recommend creating a new Git repository by running \`git init\` in ./${directory} before continuing._
+
+- View create-plugin documentation at https://grafana.github.io/plugin-tools/
+- Learn more about Grafana Plugins at https://grafana.com/docs/grafana/latest/plugins/developing/development/
+`;
+
+  return displayAsMarkdown(msg);
+}

package/src/commands/generate-actions/update-go-sdk-and-packages.ts

@@ -0,0 +1,39 @@
+import { getExportPath } from '../../utils/utils.path';
+import { CliArgs } from '../types';
+import which from 'which';
+import fs from 'fs';
+import { exec } from 'child_process';
+
+const SDK_GO_MODULE = 'github.com/grafana/grafana-plugin-sdk-go';
+
+export function updateGoSdkAndModules({ pluginName, orgName, pluginType }: CliArgs): Promise<string> {
+  return new Promise(async (resolve, reject) => {
+    // plugin directory
+    const exportPath = getExportPath(pluginName, orgName, pluginType);
+
+    // check if there is a go.mod file in exportPath
+    const goModPath = `${exportPath}/go.mod`;
+    if (!fs.existsSync(goModPath)) {
+      // skip if there is no go.mod file
+      resolve('');
+    }
+
+    const goBinaryPath = await which('go', { nothrow: true });
+
+    // if no go binary is found, skip
+    if (!goBinaryPath) {
+      resolve('');
+    }
+
+    // run go get SDK_GO_MODULE to update the go.mod file
+    const command = `go get ${SDK_GO_MODULE}`;
+    exec(command, { cwd: exportPath }, (error) => {
+      if (error) {
+        reject(
+          'There was an error trying to update the grafana go sdk. Please run `go get github.com/grafana/grafana-plugin-sdk-go` manually in your plugin directory.'
+        );
+      }
+      resolve('Grafana go sdk updated successfully.');
+    });
+  });
+}

package/src/commands/generate.plopfile.ts

@@ -3,32 +3,19 @@ import glob from 'glob';
 import path from 'path';
 import fs from 'fs';
 import { ifEq, normalizeId } from '../utils/utils.handlebars';
-import { displayAsMarkdown } from '../utils/utils.console';
-import {
-  IS_DEV,
-  TEMPLATE_PATHS,
-  PARTIALS_DIR,
-  PLUGIN_TYPES,
-  EXTRA_TEMPLATE_VARIABLES,
-  DEV_EXPORT_DIR,
-} from '../constants';
-
-type CliArgs = {
-  pluginName: string;
-  pluginDescription: string;
-  orgName: string;
-  pluginType: PLUGIN_TYPES;
-  hasBackend: boolean;
-  hasGithubWorkflows: boolean;
-  hasGithubLevitateWorkflow: boolean;
-};
+import { IS_DEV, TEMPLATE_PATHS, PARTIALS_DIR, PLUGIN_TYPES, EXTRA_TEMPLATE_VARIABLES } from '../constants';
+import { printGenerateSuccessMessage } from './generate-actions/print-success-message';
+import { updateGoSdkAndModules } from './generate-actions/update-go-sdk-and-packages';
+import { CliArgs } from './types';
+import { getExportPath } from '../utils/utils.path';
 
 // Plopfile API documentation: https://plopjs.com/documentation/#plopfile-api
 export default function (plop: NodePlopAPI) {
   plop.setHelper('if_eq', ifEq);
   plop.setHelper('normalize_id', normalizeId);
 
-  plop.setActionType('printSuccessMessage', printSuccessMessage);
+  plop.setActionType('printSuccessMessage', printGenerateSuccessMessage);
+  plop.setActionType('updateGoSdkAndModules', updateGoSdkAndModules);
 
   plop.setGenerator('create-plugin', {
     description: 'used to scaffold a grafana plugin',
@@ -147,6 +134,9 @@ export default function (plop: NodePlopAPI) {
         ...ciWorkflowActions,
         ...readmeActions,
         ...isCompatibleWorkflowActions,
+        {
+          type: 'updateGoSdkAndModules',
+        },
         {
           type: 'printSuccessMessage',
         },
@@ -237,44 +227,3 @@ function isFile(path: string) {
     return false;
   }
 }
-
-function getExportPath(pluginName: string, orgName: string, pluginType: PLUGIN_TYPES) {
-  if (IS_DEV) {
-    return DEV_EXPORT_DIR;
-  } else {
-    return path.join(process.cwd(), normalizeId(pluginName, orgName, pluginType));
-  }
-}
-
-function printSuccessMessage(answers: CliArgs) {
-  const directory = normalizeId(answers.pluginName, answers.orgName, answers.pluginType);
-
-  const commands = [
-    `- \`cd ./${directory}\``,
-    '- `yarn install` to install frontend dependencies.',
-    '- `yarn dev` to build (and watch) the plugin frontend code.',
-    ...(answers.hasBackend
-      ? [
-          '- `mage -v build:linux` to build the plugin backend code. Rerun this command every time you edit your backend files.',
-        ]
-      : []),
-    '- `docker-compose up` to start a grafana development server. Restart this command after each time you run mage to run your new backend code.',
-    '- Open http://localhost:3000 in your browser to create a dashboard to begin developing your plugin.',
-  ];
-
-  const msg = `
-Congratulations on scaffolding a Grafana ${answers.pluginType} plugin! 🚀
-
-## What's next?
-
-Run the following commands to get started:
-${commands.map((command) => command).join('\n')}
-
-_Note: We strongly recommend creating a new Git repository by running \`git init\` in ./${directory} before continuing._
-
-- View create-plugin documentation at https://grafana.github.io/plugin-tools/
-- Learn more about Grafana Plugins at https://grafana.com/docs/grafana/latest/plugins/developing/development/
-`;
-
-  return displayAsMarkdown(msg);
-}

package/src/commands/types.ts

@@ -0,0 +1,11 @@
+import { PLUGIN_TYPES } from '../constants';
+
+export type CliArgs = {
+  pluginName: string;
+  pluginDescription: string;
+  orgName: string;
+  pluginType: PLUGIN_TYPES;
+  hasBackend: boolean;
+  hasGithubWorkflows: boolean;
+  hasGithubLevitateWorkflow: boolean;
+};

package/src/constants.ts

@@ -38,7 +38,7 @@ export enum PLUGIN_TYPES {
 // and will be available to use in the templates.
 // Example: "@grafana/ui": "{{ grafanaVersion }}"
 export const EXTRA_TEMPLATE_VARIABLES = {
-  grafanaVersion: '9.2.5',
+  grafanaVersion: '9.3.8',
 };
 
 export const GRAFANA_FE_PACKAGES = [

package/src/utils/utils.path.ts

@@ -0,0 +1,11 @@
+import path from 'path';
+import { PLUGIN_TYPES, IS_DEV, DEV_EXPORT_DIR } from '../constants';
+import { normalizeId } from './utils.handlebars';
+
+export function getExportPath(pluginName: string, orgName: string, pluginType: PLUGIN_TYPES): string {
+  if (IS_DEV) {
+    return DEV_EXPORT_DIR;
+  } else {
+    return path.join(process.cwd(), normalizeId(pluginName, orgName, pluginType));
+  }
+}

package/templates/_partials/frontend-getting-started.md

@@ -24,7 +24,7 @@
    # Runs the tests and watches for changes, requires git init first
    yarn test
    
-   # Exists after running all the tests
+   # Exits after running all the tests
    yarn test:ci
    ```
 
@@ -37,10 +37,10 @@
 6. Run the E2E tests (using Cypress)
 
    ```bash
-   # Spin up a Grafana instance first that we tests against 
+   # Spins up a Grafana instance first that we tests against 
    yarn server
    
-   # Start the tests
+   # Starts the tests
    yarn e2e
    ```
 

package/templates/datasource/src/datasource.ts

@@ -7,7 +7,7 @@ import {
   FieldType,
 } from '@grafana/data';
 
-import { MyQuery, MyDataSourceOptions, DEFAULT_QUERY } from './types';
+import { MyQuery, MyDataSourceOptions } from './types';
 
 export class DataSource extends DataSourceApi<MyQuery, MyDataSourceOptions> {
   constructor(instanceSettings: DataSourceInstanceSettings<MyDataSourceOptions>) {

package/templates/github/ci/.github/workflows/ci.yml

@@ -59,14 +59,14 @@ jobs:
 
       - name: Test backend
         if: steps.check-for-backend.outputs.has-backend == 'true'
-        uses: magefile/mage-action@v1
+        uses: magefile/mage-action@v2
         with:
           version: latest
           args: coverage
 
       - name: Build backend
         if: steps.check-for-backend.outputs.has-backend == 'true'
-        uses: magefile/mage-action@v1
+        uses: magefile/mage-action@v2
         with:
           version: latest
           args: buildAll

package/templates/github/ci/.github/workflows/release.yml

@@ -41,14 +41,14 @@ jobs:
 
       - name: Test backend
         if: steps.check-for-backend.outputs.has-backend == 'true'
-        uses: magefile/mage-action@v1
+        uses: magefile/mage-action@v2
         with:
           version: latest
           args: coverage
 
       - name: Build backend
         if: steps.check-for-backend.outputs.has-backend == 'true'
-        uses: magefile/mage-action@v1
+        uses: magefile/mage-action@v2
         with:
           version: latest
           args: buildAll