@grafana/create-plugin 2.6.0 → 2.7.0-canary.528.8a2e623.0

package/README.md

@@ -95,6 +95,14 @@ For more information see [here](https://grafana.com/developers/plugin-tools/migr
 
 ---
 
+## Package your plugin
+
+You can use the `package` command to [package](https://grafana.com/developers/plugin-tools/publish-a-plugin/package-a-plugin) your plugin automatically.
+
+1. Build your plugin: e.g. `npm run build` or `yarn build` and `mage` if your plugin has a backend.
+2. [Sign your plugin](https://grafana.com/developers/plugin-tools/publish-a-plugin/sign-a-plugin).
+3. Run `npx @grafana/create-plugin@latest package` to package your plugin. A zip file with your plugin will be created.
+
 ## Customizing or extending the basic configs
 
 You can read more about customizing or extending the basic configuration [here](https://grafana.com/developers/plugin-tools/create-a-plugin/extend-a-plugin/extend-configurations)

package/dist/bin/run.js

@@ -17,6 +17,7 @@ var commands = {
     migrate: commands_1.migrate,
     generate: commands_1.generate,
     update: commands_1.update,
+    package: commands_1.packagePlugin,
     version: commands_1.version,
 };
 var command = commands[argv._[0]] || commands.generate;

package/dist/commands/index.js

@@ -18,3 +18,4 @@ __exportStar(require("./generate.command"), exports);
 __exportStar(require("./update.command"), exports);
 __exportStar(require("./migrate.command"), exports);
 __exportStar(require("./version.command"), exports);
+__exportStar(require("./package.command"), exports);

package/dist/commands/package.command.js

@@ -0,0 +1,130 @@
+"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 };
+    }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.packagePlugin = void 0;
+var fs_1 = __importDefault(require("fs"));
+var utils_console_1 = require("../utils/utils.console");
+var archiver_1 = __importDefault(require("archiver"));
+var path_1 = __importDefault(require("path"));
+var packagePlugin = function (argv) { return __awaiter(void 0, void 0, void 0, function () {
+    var nonInteractive, CWD, DIS_PATH, PLUGIN_JSON, MANIFEST_TXT, confirm_1, pluginJsonContent, pluginId, zipFileName, zipFilePath, confirm_2, _a, error_1;
+    return __generator(this, function (_b) {
+        switch (_b.label) {
+            case 0:
+                nonInteractive = argv['non-interactive'];
+                CWD = process.cwd();
+                DIS_PATH = path_1.default.join(CWD, 'dist');
+                PLUGIN_JSON = path_1.default.join(DIS_PATH, 'plugin.json');
+                MANIFEST_TXT = path_1.default.join(DIS_PATH, 'MANIFEST.txt');
+                if (!fs_1.default.existsSync(DIS_PATH) || !fs_1.default.statSync(DIS_PATH).isDirectory()) {
+                    (0, utils_console_1.printErrorMessage)("Could not find 'dist' directory. Please build your plugin before running this command. e.g.: `yarn build` or `npm run build`");
+                    process.exit(1);
+                }
+                if (!fs_1.default.existsSync(PLUGIN_JSON)) {
+                    (0, utils_console_1.printErrorMessage)("Could not find 'plugin.json' inside 'dist' directory. Please build your plugin before running this command. e.g.: `yarn build` or `npm run build`");
+                    process.exit(1);
+                }
+                if (!(!fs_1.default.existsSync(MANIFEST_TXT) && !nonInteractive)) return [3, 2];
+                return [4, (0, utils_console_1.confirmPrompt)("Could not find a 'MANIFEST.txt' file inside 'dist' directory. This means that the plugin is not signed. Would you like to continue generating an unsigned archive file?")];
+            case 1:
+                confirm_1 = _b.sent();
+                if (!confirm_1) {
+                    process.exit(1);
+                }
+                _b.label = 2;
+            case 2:
+                pluginJsonContent = require(PLUGIN_JSON);
+                pluginId = pluginJsonContent.id;
+                zipFileName = "".concat(pluginId, ".zip");
+                zipFilePath = path_1.default.join(CWD, zipFileName);
+                if (!fs_1.default.existsSync(zipFilePath)) return [3, 5];
+                _a = nonInteractive;
+                if (_a) return [3, 4];
+                return [4, (0, utils_console_1.confirmPrompt)("A zip file with the name '".concat(zipFileName, "' already exists. Do you want to continue and overwrite it?"))];
+            case 3:
+                _a = (_b.sent());
+                _b.label = 4;
+            case 4:
+                confirm_2 = _a;
+                if (confirm_2) {
+                    try {
+                        fs_1.default.unlinkSync(zipFilePath);
+                    }
+                    catch (error) {
+                        (0, utils_console_1.printErrorMessage)("Could not delete existing zip file: ".concat(error));
+                        process.exit(1);
+                    }
+                }
+                else {
+                    process.exit(1);
+                }
+                _b.label = 5;
+            case 5:
+                _b.trys.push([5, 7, , 8]);
+                return [4, zipDistPath(DIS_PATH, zipFilePath, pluginId)];
+            case 6:
+                _b.sent();
+                (0, utils_console_1.printSuccessMessage)("Successfully created zip archive at ".concat(zipFileName));
+                return [3, 8];
+            case 7:
+                error_1 = _b.sent();
+                (0, utils_console_1.printErrorMessage)("Could not create zip file: ".concat(error_1));
+                return [3, 8];
+            case 8: return [2];
+        }
+    });
+}); };
+exports.packagePlugin = packagePlugin;
+function zipDistPath(path, destination, pathName) {
+    return new Promise(function (resolve, reject) {
+        var output = fs_1.default.createWriteStream(destination);
+        var archive = (0, archiver_1.default)('zip', { zlib: { level: 9 } });
+        output.on('close', function () {
+            resolve(destination);
+        });
+        archive.on('error', function (err) {
+            reject(err);
+        });
+        archive.pipe(output);
+        archive.directory(path, pathName);
+        archive.finalize();
+    });
+}

package/dist/utils/utils.console.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.selectPrompt = exports.confirmPrompt = exports.printSuccessMessage = exports.printMessage = exports.displayArrayAsList = exports.displayAsMarkdown = void 0;
+exports.selectPrompt = exports.confirmPrompt = exports.printErrorMessage = exports.printWarningMessage = exports.printSuccessMessage = exports.printMessage = exports.displayArrayAsList = exports.displayAsMarkdown = void 0;
 var marked = require('marked').marked;
 var TerminalRenderer = require('marked-terminal');
 var _a = require('enquirer'), Confirm = _a.Confirm, Select = _a.Select;
@@ -23,6 +23,14 @@ function printSuccessMessage(msg) {
     console.log(displayAsMarkdown("\n\u2714 ".concat(msg)));
 }
 exports.printSuccessMessage = printSuccessMessage;
+function printWarningMessage(msg) {
+    console.log(displayAsMarkdown("\n\u26A0 ".concat(msg)));
+}
+exports.printWarningMessage = printWarningMessage;
+function printErrorMessage(msg) {
+    console.log(displayAsMarkdown("\n\u274C ".concat(msg)));
+}
+exports.printErrorMessage = printErrorMessage;
 function confirmPrompt(message) {
     var prompt = new Confirm({
         name: 'question',

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/create-plugin",
-  "version": "2.6.0",
+  "version": "2.7.0-canary.528.8a2e623.0",
   "main": "index.js",
   "repository": {
     "directory": "packages/create-plugin",
@@ -38,6 +38,7 @@
     "@types/mkdirp": "^1.0.2",
     "@types/semver": "^7.3.9",
     "@types/which": "^2.0.2",
+    "archiver": "^6.0.1",
     "enquirer": "^2.3.6",
     "find-up": "^5.0.0",
     "glob": "^7.1.7",
@@ -49,6 +50,7 @@
     "which": "^3.0.0"
   },
   "devDependencies": {
+    "@types/archiver": "^6.0.1",
     "@types/glob": "^7.0.0",
     "eslint-plugin-react": "^7.26.1",
     "eslint-plugin-react-hooks": "^4.2.0"
@@ -66,5 +68,5 @@
   "engines": {
     "node": ">=20"
   },
-  "gitHead": "ffb46743a4f8a37fb1cbb4755fa2bad7feae4da5"
+  "gitHead": "8a2e623b848ed62103eadc61e22593acc4c5718f"
 }

package/src/bin/run.ts

@@ -1,7 +1,7 @@
 #!/usr/bin/env node
 
 import minimist from 'minimist';
-import { generate, update, migrate, version } from '../commands';
+import { generate, update, migrate, version, packagePlugin } from '../commands';
 import { isUnsupportedPlatform } from '../utils/utils.os';
 
 // Exit early if operating system isn't supported.
@@ -18,6 +18,7 @@ const commands: Record<string, (argv: minimist.ParsedArgs) => void> = {
   migrate,
   generate,
   update,
+  package: packagePlugin,
   version,
 };
 const command = commands[argv._[0]] || commands.generate;

package/src/commands/index.ts

@@ -2,3 +2,4 @@ export * from './generate.command';
 export * from './update.command';
 export * from './migrate.command';
 export * from './version.command';
+export * from './package.command';

package/src/commands/package.command.ts

@@ -0,0 +1,92 @@
+import minimist from 'minimist';
+import fs from 'fs';
+import { confirmPrompt, printErrorMessage, printSuccessMessage } from '../utils/utils.console';
+import archiver from 'archiver';
+import path from 'path';
+
+export const packagePlugin = async (argv: minimist.ParsedArgs) => {
+  const nonInteractive = argv['non-interactive'];
+
+  const CWD = process.cwd();
+  const DIS_PATH = path.join(CWD, 'dist');
+  const PLUGIN_JSON = path.join(DIS_PATH, 'plugin.json');
+  const MANIFEST_TXT = path.join(DIS_PATH, 'MANIFEST.txt');
+
+  // validate DIS_PATH exists
+  if (!fs.existsSync(DIS_PATH) || !fs.statSync(DIS_PATH).isDirectory()) {
+    printErrorMessage(
+      "Could not find 'dist' directory. Please build your plugin before running this command. e.g.: `yarn build` or `npm run build`"
+    );
+    process.exit(1);
+  }
+
+  // validate PLUGIN_JSON exists
+  if (!fs.existsSync(PLUGIN_JSON)) {
+    printErrorMessage(
+      "Could not find 'plugin.json' inside 'dist' directory. Please build your plugin before running this command. e.g.: `yarn build` or `npm run build`"
+    );
+    process.exit(1);
+  }
+
+  // if no manifest file, warn user and confirm if wish to continue
+  if (!fs.existsSync(MANIFEST_TXT) && !nonInteractive) {
+    const confirm = await confirmPrompt(
+      `Could not find a 'MANIFEST.txt' file inside 'dist' directory. This means that the plugin is not signed. Would you like to continue generating an unsigned archive file?`
+    );
+    if (!confirm) {
+      process.exit(1);
+    }
+  }
+
+  const pluginJsonContent = require(PLUGIN_JSON);
+  const pluginId = pluginJsonContent.id;
+
+  const zipFileName = `${pluginId}.zip`;
+  const zipFilePath = path.join(CWD, zipFileName);
+
+  // if zip file already exists, warn user and confirm if wish to continue
+  if (fs.existsSync(zipFilePath)) {
+    const confirm =
+      nonInteractive ||
+      (await confirmPrompt(
+        `A zip file with the name '${zipFileName}' already exists. Do you want to continue and overwrite it?`
+      ));
+
+    if (confirm) {
+      try {
+        fs.unlinkSync(zipFilePath);
+      } catch (error) {
+        printErrorMessage(`Could not delete existing zip file: ${error}`);
+        process.exit(1);
+      }
+    } else {
+      process.exit(1);
+    }
+  }
+
+  try {
+    await zipDistPath(DIS_PATH, zipFilePath, pluginId);
+    printSuccessMessage(`Successfully created zip archive at ${zipFileName}`);
+  } catch (error) {
+    printErrorMessage(`Could not create zip file: ${error}`);
+  }
+};
+
+function zipDistPath(path: string, destination: string, pathName: string): Promise<string> {
+  return new Promise((resolve, reject) => {
+    const output = fs.createWriteStream(destination);
+    const archive = archiver('zip', { zlib: { level: 9 } });
+
+    output.on('close', () => {
+      resolve(destination);
+    });
+
+    archive.on('error', (err) => {
+      reject(err);
+    });
+
+    archive.pipe(output);
+    archive.directory(path, pathName);
+    archive.finalize();
+  });
+}

package/src/utils/utils.console.ts

@@ -22,6 +22,14 @@ export function printSuccessMessage(msg: string) {
   console.log(displayAsMarkdown(`\n✔ ${msg}`));
 }
 
+export function printWarningMessage(msg: string) {
+  console.log(displayAsMarkdown(`\n⚠ ${msg}`));
+}
+
+export function printErrorMessage(msg: string) {
+  console.log(displayAsMarkdown(`\n❌ ${msg}`));
+}
+
 export function confirmPrompt(message: string): Promise<boolean> {
   const prompt = new Confirm({
     name: 'question',