@grafana/create-plugin 2.7.0 → 2.8.0-canary.529.3bb5785.0

package/README.md

@@ -97,8 +97,23 @@ For more information see [here](https://grafana.com/developers/plugin-tools/migr
 
 ## 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)
+You can read more about customizing or extending the basic configuration in our [documentation](https://grafana.com/developers/plugin-tools/create-a-plugin/extend-a-plugin/extend-configurations).
+
+## Add provisioning to your existing plugin
+
+You can streamline the plugin review process by incorporating provisioning into your existing plugin, enabling reviewers to test your plugin more efficiently.
+
+```bash
+# Run this command from the root of your plugin
+cd ./my-plugin
+
+npx @grafana/create-plugin@latest provisioning
+```
+
+For more information see our [documentation](https://grafana.com/developers/plugin-tools/publish-a-plugin/develop-a-plugin/provide-provisioning).
+
+---
 
 ## Contributing
 
-We are always grateful for contributions! See the [CONTRIBUTING.md](../CONTRIBUTING.md) for more information.
+We are always grateful for contributions! See [CONTRIBUTING.md](../CONTRIBUTING.md) for more information.

package/dist/bin/run.js

@@ -18,6 +18,7 @@ var commands = {
     generate: commands_1.generate,
     update: commands_1.update,
     version: commands_1.version,
+    provisioning: commands_1.provisioning,
 };
 var command = commands[argv._[0]] || commands.generate;
 command(argv);

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("./provisioning.command"), exports);

package/dist/commands/provisioning.command.js

@@ -0,0 +1,88 @@
+"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.provisioning = void 0;
+var glob_1 = __importDefault(require("glob"));
+var path_1 = __importDefault(require("path"));
+var fs_1 = __importDefault(require("fs"));
+var constants_1 = require("../constants");
+var utils_plugin_1 = require("../utils/utils.plugin");
+var utils_templates_1 = require("../utils/utils.templates");
+var utils_console_1 = require("../utils/utils.console");
+var provisioning = function () { return __awaiter(void 0, void 0, void 0, function () {
+    var type, provisioningFolder, provisioningSpecificFiles, error_1;
+    return __generator(this, function (_a) {
+        switch (_a.label) {
+            case 0:
+                type = (0, utils_plugin_1.getPluginJson)().type;
+                provisioningFolder = path_1.default.join(process.cwd(), 'provisioning');
+                _a.label = 1;
+            case 1:
+                _a.trys.push([1, 3, , 4]);
+                return [4, (0, utils_console_1.confirmPrompt)(constants_1.TEXT.addProvisioning)];
+            case 2:
+                if (_a.sent()) {
+                    if (!fs_1.default.existsSync(provisioningFolder)) {
+                        provisioningSpecificFiles = glob_1.default.sync("".concat(constants_1.TEMPLATE_PATHS[type], "/provisioning/**"), { dot: true });
+                        provisioningSpecificFiles.forEach(function (file) {
+                            (0, utils_templates_1.compileProvisioningTemplateFile)(type, file, (0, utils_templates_1.getTemplateData)());
+                        });
+                        (0, utils_console_1.printSuccessMessage)(constants_1.TEXT.addProvisioningSuccess);
+                    }
+                    else {
+                        (0, utils_console_1.printMessage)("You plugin already has provisioning files located under ".concat(provisioningFolder, ", aborting."));
+                        process.exit(0);
+                    }
+                }
+                else {
+                    (0, utils_console_1.printMessage)(constants_1.TEXT.addProvisioningAborted);
+                    process.exit(1);
+                }
+                return [3, 4];
+            case 3:
+                error_1 = _a.sent();
+                (0, utils_console_1.printError)(error_1);
+                return [3, 4];
+            case 4: return [2];
+        }
+    });
+}); };
+exports.provisioning = provisioning;

package/dist/constants.js

@@ -75,7 +75,10 @@ exports.TEXT = {
     updateNpmDependenciesPrompt: '**Would you like to update the following dependencies in the `package.json?`**',
     updateNpmDependenciesSuccess: 'Successfully updated the NPM dependencies.',
     updateNpmDependenciesAborted: 'No NPM dependencies have been updated.',
-    removeNpmDependenciesPrompt: '**Would you like to remove the following possibly unnecessary NPM dependencies?**',
+    addProvisioning: '**Do you want to add provisioning files?**',
+    addProvisioningSuccess: 'Successfully added provisioning.',
+    addProvisioningAborted: 'No provisioning has been added.',
+    removeNpmDependenciesPrompt: '**Do you want to remove the following possibly unnecessary NPM dependencies?**',
     removeNpmDependenciesSuccess: 'Unnecessary NPM dependencies removed successfully.',
     removeNpmDependenciesAborted: 'No NPM dependencies have been removed.',
     updateConfigPrompt: "**Would you like to update the project's configuration?**",

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.printError = 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,10 @@ function printSuccessMessage(msg) {
     console.log(displayAsMarkdown("\n\u2714 ".concat(msg)));
 }
 exports.printSuccessMessage = printSuccessMessage;
+function printError(error) {
+    console.error(displayAsMarkdown("\n\u274C ".concat(error)));
+}
+exports.printError = printError;
 function confirmPrompt(message) {
     var prompt = new Confirm({
         name: 'question',

package/dist/utils/utils.templates.js

@@ -23,7 +23,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getTemplateData = exports.renderTemplateFromFile = exports.compileSingleTemplateFile = exports.compileTemplateFiles = exports.getProjectRelativeTemplatePath = exports.getTemplateFiles = void 0;
+exports.getTemplateData = exports.renderTemplateFromFile = exports.compileProvisioningTemplateFile = exports.compileSingleTemplateFile = exports.compileTemplateFiles = exports.getProjectRelativeTemplatePath = exports.getTemplateFiles = void 0;
 var glob_1 = __importDefault(require("glob"));
 var path_1 = __importDefault(require("path"));
 var fs_1 = __importDefault(require("fs"));
@@ -69,6 +69,17 @@ function compileSingleTemplateFile(pluginType, templateFile, data) {
     fs_1.default.writeFileSync(exportPath, rendered);
 }
 exports.compileSingleTemplateFile = compileSingleTemplateFile;
+function compileProvisioningTemplateFile(pluginType, templateFile, data) {
+    if (!(0, utils_files_1.isFile)(templateFile)) {
+        return;
+    }
+    var rendered = renderTemplateFromFile(templateFile, data);
+    var relativeExportPath = templateFile.replace(constants_1.TEMPLATE_PATHS[pluginType], '.');
+    var exportPath = path_1.default.join(constants_1.EXPORT_PATH_PREFIX, path_1.default.dirname(relativeExportPath), (0, utils_files_2.getExportFileName)(templateFile));
+    mkdirp_1.default.sync(path_1.default.dirname(exportPath));
+    fs_1.default.writeFileSync(exportPath, rendered);
+}
+exports.compileProvisioningTemplateFile = compileProvisioningTemplateFile;
 function renderTemplateFromFile(templateFile, data) {
     return (0, utils_handlebars_1.renderHandlebarsTemplate)(fs_1.default.readFileSync(templateFile).toString(), data);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/create-plugin",
-  "version": "2.7.0",
+  "version": "2.8.0-canary.529.3bb5785.0",
   "main": "index.js",
   "repository": {
     "directory": "packages/create-plugin",
@@ -66,5 +66,5 @@
   "engines": {
     "node": ">=20"
   },
-  "gitHead": "a3755f78d7c2565d39543be73c1814e2e69011da"
+  "gitHead": "3bb5785c63815edd3da2b16b1ddf0110fa1952ea"
 }

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, provisioning } from '../commands';
 import { isUnsupportedPlatform } from '../utils/utils.os';
 
 // Exit early if operating system isn't supported.
@@ -19,6 +19,7 @@ const commands: Record<string, (argv: minimist.ParsedArgs) => void> = {
   generate,
   update,
   version,
+  provisioning,
 };
 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 './provisioning.command';

package/src/commands/provisioning.command.ts

@@ -0,0 +1,32 @@
+import glob from 'glob';
+import path from 'path';
+import fs from 'fs';
+import { TEMPLATE_PATHS, TEXT } from '../constants';
+import { getPluginJson } from '../utils/utils.plugin';
+import { compileProvisioningTemplateFile, getTemplateData } from '../utils/utils.templates';
+import { confirmPrompt, printMessage, printSuccessMessage, printError } from '../utils/utils.console';
+
+export const provisioning = async () => {
+  const { type } = getPluginJson();
+  const provisioningFolder = path.join(process.cwd(), 'provisioning');
+  try {
+    if (await confirmPrompt(TEXT.addProvisioning)) {
+      if (!fs.existsSync(provisioningFolder)) {
+        const provisioningSpecificFiles = glob.sync(`${TEMPLATE_PATHS[type]}/provisioning/**`, { dot: true });
+
+        provisioningSpecificFiles.forEach((file) => {
+          compileProvisioningTemplateFile(type, file, getTemplateData());
+        });
+        printSuccessMessage(TEXT.addProvisioningSuccess);
+      } else {
+        printMessage(`You plugin already has provisioning files located under ${provisioningFolder}, aborting.`);
+        process.exit(0);
+      }
+    } else {
+      printMessage(TEXT.addProvisioningAborted);
+      process.exit(1);
+    }
+  } catch (error) {
+    printError(error);
+  }
+};

package/src/constants.ts

@@ -99,7 +99,11 @@ export const TEXT = {
   updateNpmDependenciesSuccess: 'Successfully updated the NPM dependencies.',
   updateNpmDependenciesAborted: 'No NPM dependencies have been updated.',
 
-  removeNpmDependenciesPrompt: '**Would you like to remove the following possibly unnecessary NPM dependencies?**',
+  addProvisioning: '**Do you want to add provisioning files?**',
+  addProvisioningSuccess: 'Successfully added provisioning.',
+  addProvisioningAborted: 'No provisioning has been added.',
+
+  removeNpmDependenciesPrompt: '**Do you want to remove the following possibly unnecessary NPM dependencies?**',
   removeNpmDependenciesSuccess: 'Unnecessary NPM dependencies removed successfully.',
   removeNpmDependenciesAborted: 'No NPM dependencies have been removed.',
 

package/src/utils/utils.console.ts

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

package/src/utils/utils.templates.ts

@@ -61,6 +61,19 @@ export function compileSingleTemplateFile(pluginType: string, templateFile: stri
   fs.writeFileSync(exportPath, rendered);
 }
 
+export function compileProvisioningTemplateFile(pluginType: string, templateFile: string, data?: any) {
+  if (!isFile(templateFile)) {
+    return;
+  }
+
+  const rendered = renderTemplateFromFile(templateFile, data);
+  const relativeExportPath = templateFile.replace(TEMPLATE_PATHS[pluginType], '.');
+  const exportPath = path.join(EXPORT_PATH_PREFIX, path.dirname(relativeExportPath), getExportFileName(templateFile));
+
+  mkdirp.sync(path.dirname(exportPath));
+  fs.writeFileSync(exportPath, rendered);
+}
+
 export function renderTemplateFromFile(templateFile: string, data?: any) {
   return renderHandlebarsTemplate(fs.readFileSync(templateFile).toString(), data);
 }

package/templates/app/provisioning/plugins/README.md

@@ -0,0 +1,4 @@
+For more information see our documentation:
+
+- [Provision Grafana](https://grafana.com/docs/grafana/latest/administration/provisioning/)
+- [Provision a plugin](https://grafana.com/developers/plugin-tools/publish-a-plugin/provide-provisioning)

package/templates/app/provisioning/plugins/apps.yaml

@@ -2,4 +2,10 @@ apiVersion: 1
 
 apps:
   - type: '{{ normalize_id pluginName orgName 'app' }}'
+    org_id: 1
+    org_name: '{{ orgName }}'
     disabled: false
+    jsonData:
+      apiUrl: http://default-url.com
+    secureJsonData:
+      apiKey: secret-key

package/templates/datasource/provisioning/README.md

@@ -0,0 +1 @@
+For more information see [Provision dashboards and data sources](https://grafana.com/tutorials/provision-dashboards-and-data-sources/)

package/templates/datasource/provisioning/datasources/datasources.yml

@@ -0,0 +1,10 @@
+apiVersion: 1
+
+datasources:
+  - name: '{{ pluginName }}'
+    type: '{{ normalize_id pluginName orgName 'datasource' }}'
+    access: proxy
+    isDefault: false
+    orgId: 1
+    version: 1
+    editable: true

package/templates/panel/provisioning/README.md

@@ -0,0 +1 @@
+For more information see [Provision dashboards and data sources](https://grafana.com/tutorials/provision-dashboards-and-data-sources/)

package/templates/panel/provisioning/dashboards/dashboard.json

@@ -0,0 +1,71 @@
+{
+  "annotations": {
+    "list": [
+      {
+        "builtIn": 1,
+        "datasource": {
+          "type": "grafana",
+          "uid": "-- Grafana --"
+        },
+        "enable": true,
+        "hide": true,
+        "iconColor": "rgba(0, 211, 255, 1)",
+        "name": "Annotations & Alerts",
+        "type": "dashboard"
+      }
+    ]
+  },
+  "editable": true,
+  "fiscalYearStartMonth": 0,
+  "graphTooltip": 0,
+  "links": [],
+  "liveNow": false,
+  "panels": [
+    {
+      "datasource": {
+        "type": "grafana",
+        "uid": "grafana"
+      },
+      "gridPos": {
+        "h": 8,
+        "w": 12,
+        "x": 0,
+        "y": 0
+      },
+      "id": 1,
+      "options": {
+        "seriesCountSize": "sm",
+        "showSeriesCount": false,
+        "text": "Default value of text input option"
+      },
+      "targets": [
+        {
+          "datasource": {
+            "type": "datasource",
+            "uid": "grafana"
+          },
+          "queryType": "randomWalk",
+          "refId": "A"
+        }
+      ],
+      "title": "Panel Title",
+      "type": "{{ pluginId }}"
+    }
+  ],
+  "refresh": "",
+  "schemaVersion": 38,
+  "style": "dark",
+  "tags": [],
+  "templating": {
+    "list": []
+  },
+  "time": {
+    "from": "now-6h",
+    "to": "now"
+  },
+  "timepicker": {},
+  "timezone": "",
+  "title": "Provisioned {{ pluginName }} dashboard",
+  "version": 0,
+  "weekStart": ""
+}

package/templates/panel/provisioning/dashboards/default.yaml

@@ -0,0 +1,7 @@
+apiVersion: 1
+
+providers:
+  - name: '{{ pluginName }}'
+    type: file
+    options:
+      path: /etc/grafana/provisioning/dashboards

package/templates/scenes-app/provisioning/README.md

@@ -0,0 +1,4 @@
+For more information see our documentation:
+
+- [Provision Grafana](https://grafana.com/docs/grafana/latest/administration/provisioning/)
+- [Provision a plugin](https://grafana.com/developers/plugin-tools/publish-a-plugin/provide-provisioning)

package/templates/scenes-app/provisioning/custom.ini

@@ -0,0 +1,5 @@
+app_mode = development
+
+[feature_toggles]
+
+

package/templates/scenes-app/provisioning/datasources/default.yaml

@@ -2,5 +2,5 @@ apiVersion: 1
 
 datasources:
   - name: gdev-testdata
-    isDefault: true
+    isDefault: false
     type: testdata

package/templates/scenes-app/provisioning/plugins/app.yaml

@@ -0,0 +1,12 @@
+apiVersion: 1
+
+apps:
+  - type: '{{ normalize_id pluginName orgName 'app' }}'
+    org_id: 1
+    org_name: '{{ orgName }}'
+    disabled: false
+    jsonData:
+      apiUrl: http://default-url.com
+      isApiKeySet: true
+    secureJsonData:
+      apiKey: secret-key

package/templates/scenes-app/provisioning/plugins/apps.yaml

@@ -1,5 +0,0 @@
-apiVersion: 1
-
-apps:
-  - type: '{{ normalize_id pluginName orgName 'app' }}'
-    disabled: false