@grafana/create-plugin 2.11.2 → 2.12.0-canary.658.dabaee1.0

package/dist/bin/run.js

@@ -1,24 +1,19 @@
 #!/usr/bin/env node
-"use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-var minimist_1 = __importDefault(require("minimist"));
-var commands_1 = require("../commands");
-var utils_os_1 = require("../utils/utils.os");
-if ((0, utils_os_1.isUnsupportedPlatform)()) {
+import minimist from 'minimist';
+import { generate, update, migrate, version, provisioning } from '../commands/index.js';
+import { isUnsupportedPlatform } from '../utils/utils.os.js';
+if (isUnsupportedPlatform()) {
     console.error("Unsupported operating system 'Windows' detected. Please use WSL with create-plugin. For more info visit: https://grafana.com/developers/plugin-tools/troubleshooting#i-am-getting-unsupported-operating-system-windows-detected-please-use-wsl-with-create-plugin");
     process.exit(1);
 }
-var args = process.argv.slice(2);
-var argv = (0, minimist_1.default)(args);
-var commands = {
-    migrate: commands_1.migrate,
-    generate: commands_1.generate,
-    update: commands_1.update,
-    version: commands_1.version,
-    provisioning: commands_1.provisioning,
+const args = process.argv.slice(2);
+const argv = minimist(args);
+const commands = {
+    migrate,
+    generate,
+    update,
+    version,
+    provisioning,
 };
-var command = commands[argv._[0]] || commands.generate;
+const command = commands[argv._[0]] || commands.generate;
 command(argv);

package/dist/commands/generate/prettify-files.js

@@ -1,72 +1,17 @@
-"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 (g && (g = 0, op[0] && (_ = 0)), _) 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 };
+import { exec as nodeExec } from 'node:child_process';
+import { promisify } from 'node:util';
+import fs from 'node:fs';
+const exec = promisify(nodeExec);
+export async function prettifyFiles(exportPath) {
+    if (!fs.existsSync(exportPath)) {
+        return '';
     }
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.prettifyFiles = void 0;
-var node_child_process_1 = require("node:child_process");
-var node_util_1 = require("node:util");
-var fs_1 = __importDefault(require("fs"));
-var exec = (0, node_util_1.promisify)(node_child_process_1.exec);
-function prettifyFiles(exportPath) {
-    return __awaiter(this, void 0, void 0, function () {
-        var command, error_1;
-        return __generator(this, function (_a) {
-            switch (_a.label) {
-                case 0:
-                    if (!fs_1.default.existsSync(exportPath)) {
-                        return [2, ''];
-                    }
-                    _a.label = 1;
-                case 1:
-                    _a.trys.push([1, 3, , 4]);
-                    command = 'npx -y prettier@2 . --write';
-                    return [4, exec(command, { cwd: exportPath })];
-                case 2:
-                    _a.sent();
-                    return [3, 4];
-                case 3:
-                    error_1 = _a.sent();
-                    throw new Error('There was a problem running prettier on the plugin files. Please run `npx -y prettier@2 . --write` manually in your plugin directory.');
-                case 4: return [2, 'Successfully ran prettier against new plugin.'];
-            }
-        });
-    });
+    try {
+        let command = 'npx -y prettier@2 . --write';
+        await exec(command, { cwd: exportPath });
+    }
+    catch (error) {
+        throw new Error('There was a problem running prettier on the plugin files. Please run `npx -y prettier@2 . --write` manually in your plugin directory.');
+    }
+    return 'Successfully ran prettier against new plugin.';
 }
-exports.prettifyFiles = prettifyFiles;

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

@@ -1,34 +1,31 @@
-"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));
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.printGenerateSuccessMessage = void 0;
-var utils_console_1 = require("../../utils/utils.console");
-var utils_handlebars_1 = require("../../utils/utils.handlebars");
-var utils_packageManager_1 = require("../../utils/utils.packageManager");
-function printGenerateSuccessMessage(answers) {
-    var directory = (0, utils_handlebars_1.normalizeId)(answers.pluginName, answers.orgName, answers.pluginType);
-    var packageManagerName = (0, utils_packageManager_1.getPackageManagerFromUserAgent)().packageManagerName;
-    var commands = __spreadArray(__spreadArray([
-        "- `cd ./".concat(directory, "`"),
-        "- `".concat(packageManagerName, " install` to install frontend dependencies."),
-        "- `".concat(packageManagerName, " run 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), [
+import { displayAsMarkdown } from '../../utils/utils.console.js';
+import { normalizeId } from '../../utils/utils.handlebars.js';
+import { getPackageManagerFromUserAgent } from '../../utils/utils.packageManager.js';
+export function printGenerateSuccessMessage(answers) {
+    const directory = normalizeId(answers.pluginName, answers.orgName, answers.pluginType);
+    const { packageManagerName } = getPackageManagerFromUserAgent();
+    const commands = [
+        `- \`cd ./${directory}\``,
+        `- \`${packageManagerName} install\` to install frontend dependencies.`,
+        `- \`${packageManagerName} run 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.',
-    ], false);
-    var msg = "\n# Congratulations 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- Learn more about Grafana Plugin Development at https://grafana.com/developers/plugin-tools\n");
-    console.log((0, utils_console_1.displayAsMarkdown)(msg));
+    ];
+    const msg = `\n# 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._
+
+- Learn more about Grafana Plugin Development at https://grafana.com/developers/plugin-tools
+`;
+    console.log(displayAsMarkdown(msg));
 }
-exports.printGenerateSuccessMessage = printGenerateSuccessMessage;

package/dist/commands/generate/prompt-user.js

@@ -1,99 +1,31 @@
-"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];
+import Enquirer from 'enquirer';
+import { PLUGIN_TYPES } from '../../constants.js';
+export async function promptUser(argv) {
+    let answers = {};
+    const enquirer = new Enquirer();
+    for (const prompt of prompts) {
+        const { name, shouldPrompt } = prompt;
+        if (argv.hasOwnProperty(name)) {
+            answers = { ...answers, [name]: argv[name] };
         }
-        return t;
-    };
-    return __assign.apply(this, arguments);
-};
-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 (g && (g = 0, op[0] && (_ = 0)), _) 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;
+        else {
+            if (typeof shouldPrompt === 'function' && !shouldPrompt(answers)) {
+                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 };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.promptUser = void 0;
-var enquirer_1 = __importDefault(require("enquirer"));
-var constants_1 = require("../../constants");
-function promptUser(argv) {
-    return __awaiter(this, void 0, void 0, function () {
-        var answers, enquirer, _i, prompts_1, prompt_1, name_1, shouldPrompt, result;
-        var _a;
-        return __generator(this, function (_b) {
-            switch (_b.label) {
-                case 0:
-                    answers = {};
-                    enquirer = new enquirer_1.default();
-                    _i = 0, prompts_1 = prompts;
-                    _b.label = 1;
-                case 1:
-                    if (!(_i < prompts_1.length)) return [3, 6];
-                    prompt_1 = prompts_1[_i];
-                    name_1 = prompt_1.name, shouldPrompt = prompt_1.shouldPrompt;
-                    if (!argv.hasOwnProperty(name_1)) return [3, 2];
-                    answers = __assign(__assign({}, answers), (_a = {}, _a[name_1] = argv[name_1], _a));
-                    return [3, 5];
-                case 2:
-                    if (!(typeof shouldPrompt === 'function' && !shouldPrompt(answers))) return [3, 3];
-                    return [3, 5];
-                case 3: return [4, enquirer.prompt(prompt_1)];
-                case 4:
-                    result = _b.sent();
-                    answers = __assign(__assign({}, answers), result);
-                    _b.label = 5;
-                case 5:
-                    _i++;
-                    return [3, 1];
-                case 6: return [2, answers];
+            else {
+                const result = await enquirer.prompt(prompt);
+                answers = { ...answers, ...result };
             }
-        });
-    });
+        }
+    }
+    return answers;
 }
-exports.promptUser = promptUser;
-var prompts = [
+const prompts = [
     {
         name: 'pluginName',
         type: 'input',
         message: 'What is going to be the name of your plugin?',
-        validate: function (value) {
+        validate: (value) => {
             if (/.+/.test(value)) {
                 return true;
             }
@@ -104,7 +36,7 @@ var prompts = [
         name: 'orgName',
         type: 'input',
         message: 'What is the organization name of your plugin?',
-        validate: function (value) {
+        validate: (value) => {
             if (/.+/.test(value)) {
                 return true;
             }
@@ -120,7 +52,7 @@ var prompts = [
     {
         name: 'pluginType',
         type: 'select',
-        choices: [constants_1.PLUGIN_TYPES.app, constants_1.PLUGIN_TYPES.datasource, constants_1.PLUGIN_TYPES.panel, constants_1.PLUGIN_TYPES.scenes],
+        choices: [PLUGIN_TYPES.app, PLUGIN_TYPES.datasource, PLUGIN_TYPES.panel, PLUGIN_TYPES.scenes],
         message: 'What type of plugin would you like?',
     },
     {
@@ -128,7 +60,7 @@ var prompts = [
         type: 'confirm',
         message: 'Do you want a backend part of your plugin?',
         initial: false,
-        shouldPrompt: function (answers) { return answers.pluginType !== constants_1.PLUGIN_TYPES.panel; },
+        shouldPrompt: (answers) => answers.pluginType !== PLUGIN_TYPES.panel,
     },
     {
         name: 'hasGithubWorkflows',

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

@@ -1,113 +1,44 @@
-"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 (g && (g = 0, op[0] && (_ = 0)), _) 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 };
+import which from 'which';
+import fs from 'node:fs';
+import { exec } from 'node:child_process';
+const SDK_GO_MODULE = 'github.com/grafana/grafana-plugin-sdk-go';
+export async function updateGoSdkAndModules(exportPath) {
+    const goModPath = `${exportPath}/go.mod`;
+    if (!fs.existsSync(goModPath)) {
+        return '';
     }
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.updateGoSdkAndModules = void 0;
-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(exportPath) {
-    return __awaiter(this, void 0, void 0, function () {
-        var goModPath, goBinaryPath, _a;
-        return __generator(this, function (_b) {
-            switch (_b.label) {
-                case 0:
-                    goModPath = "".concat(exportPath, "/go.mod");
-                    if (!fs_1.default.existsSync(goModPath)) {
-                        return [2, ''];
-                    }
-                    return [4, (0, which_1.default)('go', { nothrow: true })];
-                case 1:
-                    goBinaryPath = _b.sent();
-                    if (!goBinaryPath) {
-                        return [2, ''];
-                    }
-                    _b.label = 2;
-                case 2:
-                    _b.trys.push([2, 5, , 6]);
-                    return [4, updateSdk(exportPath)];
-                case 3:
-                    _b.sent();
-                    return [4, updateGoMod(exportPath)];
-                case 4:
-                    _b.sent();
-                    return [3, 6];
-                case 5:
-                    _a = _b.sent();
-                    throw new Error('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.');
-                case 6: return [2, 'Grafana go sdk updated successfully.'];
-            }
-        });
-    });
+    const goBinaryPath = await which('go', { nothrow: true });
+    if (!goBinaryPath) {
+        return '';
+    }
+    try {
+        await updateSdk(exportPath);
+        await updateGoMod(exportPath);
+    }
+    catch {
+        throw new Error('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.');
+    }
+    return 'Grafana go sdk updated successfully.';
 }
-exports.updateGoSdkAndModules = updateGoSdkAndModules;
 function updateSdk(exportPath) {
-    var _this = this;
-    return new Promise(function (resolve, reject) { return __awaiter(_this, void 0, void 0, function () {
-        var command;
-        return __generator(this, function (_a) {
-            command = "go get ".concat(SDK_GO_MODULE);
-            (0, child_process_1.exec)(command, { cwd: exportPath }, function (error) {
-                if (error) {
-                    reject();
-                }
-                resolve();
-            });
-            return [2];
+    return new Promise(async (resolve, reject) => {
+        const command = `go get ${SDK_GO_MODULE}`;
+        exec(command, { cwd: exportPath }, (error) => {
+            if (error) {
+                reject();
+            }
+            resolve();
         });
-    }); });
+    });
 }
 function updateGoMod(exportPath) {
-    var _this = this;
-    return new Promise(function (resolve, reject) { return __awaiter(_this, void 0, void 0, function () {
-        var command;
-        return __generator(this, function (_a) {
-            command = "go mod tidy";
-            (0, child_process_1.exec)(command, { cwd: exportPath }, function (error) {
-                if (error) {
-                    reject();
-                }
-                resolve();
-            });
-            return [2];
+    return new Promise(async (resolve, reject) => {
+        const command = `go mod tidy`;
+        exec(command, { cwd: exportPath }, (error) => {
+            if (error) {
+                reject();
+            }
+            resolve();
         });
-    }); });
+    });
 }