@grafana/create-plugin 2.11.0-canary.634.15520dc.0 → 2.11.0

package/dist/commands/generate.plopfile.js

@@ -1,214 +0,0 @@
-"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)) {
-            if (!ar) ar = Array.prototype.slice.call(from, 0, i);
-            ar[i] = from[i];
-        }
-    }
-    return to.concat(ar || Array.prototype.slice.call(from));
-};
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
-Object.defineProperty(exports, "__esModule", { value: true });
-var fs_1 = __importDefault(require("fs"));
-var glob_1 = __importDefault(require("glob"));
-var path_1 = __importDefault(require("path"));
-var constants_1 = require("../constants");
-var utils_handlebars_1 = require("../utils/utils.handlebars");
-var utils_path_1 = require("../utils/utils.path");
-var utils_packageManager_1 = require("../utils/utils.packageManager");
-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 prettify_files_1 = require("./generate-actions/prettify-files");
-var utils_files_1 = require("../utils/utils.files");
-var utils_config_1 = require("../utils/utils.config");
-var utils_version_1 = require("../utils/utils.version");
-function default_1(plop) {
-    plop.setHelper('if_eq', utils_handlebars_1.ifEq);
-    plop.setHelper('normalize_id', utils_handlebars_1.normalizeId);
-    plop.setActionType('printSuccessMessage', print_success_message_1.printGenerateSuccessMessage);
-    plop.setActionType('prettifyFiles', prettify_files_1.prettifyFiles);
-    plop.setActionType('updateGoSdkAndModules', update_go_sdk_and_packages_1.updateGoSdkAndModules);
-    plop.setGenerator('create-plugin', {
-        description: 'used to scaffold a grafana plugin',
-        prompts: [
-            {
-                name: 'pluginName',
-                type: 'input',
-                message: 'What is going to be the name of your plugin?',
-                validate: function (value) {
-                    if (/.+/.test(value)) {
-                        return true;
-                    }
-                    return 'Plugin name is required';
-                },
-            },
-            {
-                name: 'orgName',
-                type: 'input',
-                message: 'What is the organization name of your plugin?',
-                validate: function (value) {
-                    if (/.+/.test(value)) {
-                        return true;
-                    }
-                    return 'Organization name is required';
-                },
-            },
-            {
-                name: 'pluginDescription',
-                type: 'input',
-                message: 'How would you describe your plugin?',
-                default: '',
-            },
-            {
-                name: 'pluginType',
-                type: 'list',
-                choices: [constants_1.PLUGIN_TYPES.app, constants_1.PLUGIN_TYPES.datasource, constants_1.PLUGIN_TYPES.panel, constants_1.PLUGIN_TYPES.scenes],
-                message: 'What type of plugin would you like?',
-            },
-            {
-                name: 'hasBackend',
-                type: 'confirm',
-                message: 'Do you want a backend part of your plugin?',
-                default: false,
-                when: function (answers) { return answers.pluginType !== constants_1.PLUGIN_TYPES.panel; },
-            },
-            {
-                name: 'hasGithubWorkflows',
-                type: 'confirm',
-                message: 'Do you want to add Github CI and Release workflows?',
-                default: false,
-            },
-            {
-                name: 'hasGithubLevitateWorkflow',
-                type: 'confirm',
-                message: 'Do you want to add a Github workflow for automatically checking "Grafana API compatibility" on PRs?',
-                default: false,
-            },
-        ],
-        actions: function (_a) {
-            var pluginName = _a.pluginName, orgName = _a.orgName, pluginType = _a.pluginType, hasBackend = _a.hasBackend, hasGithubWorkflows = _a.hasGithubWorkflows, hasGithubLevitateWorkflow = _a.hasGithubLevitateWorkflow;
-            var features = (0, utils_config_1.getConfig)().features;
-            var currentVersion = (0, utils_version_1.getVersion)();
-            var exportPath = (0, utils_path_1.getExportPath)(pluginName, orgName, pluginType);
-            var pluginId = (0, utils_handlebars_1.normalizeId)(pluginName, orgName, pluginType);
-            var _b = (0, utils_packageManager_1.getPackageManagerFromUserAgent)(), packageManagerName = _b.packageManagerName, packageManagerVersion = _b.packageManagerVersion;
-            var packageManagerInstallCmd = (0, utils_packageManager_1.getPackageManagerInstallCmd)(packageManagerName);
-            var isAppType = pluginType === constants_1.PLUGIN_TYPES.app || pluginType === constants_1.PLUGIN_TYPES.scenes;
-            var templateData = {
-                pluginId: pluginId,
-                packageManagerName: packageManagerName,
-                packageManagerInstallCmd: packageManagerInstallCmd,
-                packageManagerVersion: packageManagerVersion,
-                isAppType: isAppType,
-                isNPM: packageManagerName === 'npm',
-                version: currentVersion,
-                bundleGrafanaUI: features.bundleGrafanaUI,
-            };
-            var commonActions = getActionsForTemplateFolder({
-                folderPath: constants_1.TEMPLATE_PATHS.common,
-                exportPath: exportPath,
-                templateData: templateData,
-            });
-            var pluginTypeSpecificActions = getActionsForTemplateFolder({
-                folderPath: constants_1.TEMPLATE_PATHS[pluginType],
-                exportPath: exportPath,
-                templateData: templateData,
-            });
-            var backendFolderPath = isAppType ? constants_1.TEMPLATE_PATHS.backendApp : constants_1.TEMPLATE_PATHS.backend;
-            var backendActions = hasBackend
-                ? getActionsForTemplateFolder({ folderPath: backendFolderPath, exportPath: exportPath, templateData: templateData })
-                : [];
-            var pluginActions = __spreadArray(__spreadArray(__spreadArray([], backendActions, true), pluginTypeSpecificActions, true), commonActions, true).reduce(function (acc, file) {
-                var actionExists = acc.find(function (f) { return f.path === file.path; });
-                if (actionExists && actionExists.type === 'add' && file.type === 'add') {
-                    return acc;
-                }
-                acc.push(file);
-                return acc;
-            }, []);
-            var ciWorkflowActions = hasGithubWorkflows
-                ? getActionsForTemplateFolder({
-                    folderPath: constants_1.TEMPLATE_PATHS.ciWorkflows,
-                    exportPath: exportPath,
-                    templateData: templateData,
-                })
-                : [];
-            var isCompatibleWorkflowActions = hasGithubLevitateWorkflow
-                ? getActionsForTemplateFolder({
-                    folderPath: constants_1.TEMPLATE_PATHS.isCompatibleWorkflow,
-                    exportPath: exportPath,
-                    templateData: templateData,
-                })
-                : [];
-            var readmeActions = getActionsForReadme({ exportPath: exportPath, templateData: templateData });
-            return __spreadArray(__spreadArray(__spreadArray(__spreadArray(__spreadArray([], pluginActions, true), ciWorkflowActions, true), readmeActions, true), isCompatibleWorkflowActions, true), [
-                {
-                    type: 'updateGoSdkAndModules',
-                },
-                { type: 'prettifyFiles' },
-                {
-                    type: 'printSuccessMessage',
-                },
-            ], false);
-        },
-    });
-}
-exports.default = default_1;
-function getActionsForReadme(_a) {
-    var exportPath = _a.exportPath, templateData = _a.templateData;
-    return [
-        replacePatternWithTemplateInReadme('-- INSERT FRONTEND GETTING STARTED --', 'frontend-getting-started.md', exportPath, templateData),
-        replacePatternWithTemplateInReadme('-- INSERT BACKEND GETTING STARTED --', 'backend-getting-started.md', exportPath, templateData),
-        replacePatternWithTemplateInReadme('-- INSERT DISTRIBUTING YOUR PLUGIN --', 'distributing-your-plugin.md', exportPath, templateData),
-    ];
-}
-function replacePatternWithTemplateInReadme(pattern, partialsFile, exportPath, templateData) {
-    return {
-        type: 'modify',
-        path: path_1.default.join(exportPath, 'README.md'),
-        pattern: pattern,
-        template: undefined,
-        templateFile: path_1.default.join(constants_1.PARTIALS_DIR, partialsFile),
-        data: __assign(__assign({}, constants_1.EXTRA_TEMPLATE_VARIABLES), templateData),
-    };
-}
-function getActionsForTemplateFolder(_a) {
-    var folderPath = _a.folderPath, exportPath = _a.exportPath, templateData = _a.templateData;
-    var files = glob_1.default.sync("".concat(folderPath, "/**"), { dot: true });
-    if (templateData.packageManagerName !== 'pnpm') {
-        files = files.filter(function (file) { return path_1.default.basename(file) !== 'npmrc'; });
-    }
-    function getExportPath(f) {
-        return path_1.default.relative(folderPath, path_1.default.dirname(f));
-    }
-    return files.filter(isFile).map(function (f) { return ({
-        type: 'add',
-        templateFile: f,
-        path: path_1.default.join(exportPath, getExportPath(f), (0, utils_files_1.getExportFileName)(f)),
-        force: constants_1.IS_DEV,
-        abortOnFail: false,
-        data: __assign(__assign({}, constants_1.EXTRA_TEMPLATE_VARIABLES), templateData),
-    }); });
-}
-function isFile(path) {
-    try {
-        return fs_1.default.lstatSync(path).isFile();
-    }
-    catch (e) {
-        return false;
-    }
-}

package/scripts/generate-app-backend.js

@@ -1,29 +0,0 @@
-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 app with backend',
-      pluginType: 'app',
-      hasBackend: true,
-      hasGithubWorkflows: true,
-      hasGithubLevitateWorkflow: true,
-    },
-    {
-      onFailure: console.error,
-    }
-  );
-}
-
-generate();

package/scripts/generate-app.js

@@ -1,29 +0,0 @@
-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 app',
-      pluginType: 'app',
-      hasBackend: false,
-      hasGithubWorkflows: true,
-      hasGithubLevitateWorkflow: true,
-    },
-    {
-      onFailure: console.error,
-    }
-  );
-}
-
-generate();

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

@@ -1,29 +0,0 @@
-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: true,
-      hasGithubWorkflows: true,
-      hasGithubLevitateWorkflow: true,
-    },
-    {
-      onFailure: console.error,
-    }
-  );
-}
-
-generate();

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

@@ -1,29 +0,0 @@
-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,
-    },
-    {
-      onFailure: console.error,
-    }
-  );
-}
-
-generate();

package/scripts/generate-panel.js

@@ -1,28 +0,0 @@
-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 panel',
-      pluginType: 'panel',
-      hasGithubWorkflows: true,
-      hasGithubLevitateWorkflow: true,
-    },
-    {
-      onFailure: console.error,
-    }
-  );
-}
-
-generate();

package/scripts/generate-scenes-app.js

@@ -1,29 +0,0 @@
-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 scenes app',
-      pluginType: 'scenesapp',
-      hasBackend: false,
-      hasGithubWorkflows: true,
-      hasGithubLevitateWorkflow: true,
-    },
-    {
-      onFailure: console.error,
-    }
-  );
-}
-
-generate();

package/src/commands/generate.plopfile.ts

@@ -1,272 +0,0 @@
-import fs from 'fs';
-import glob from 'glob';
-import path from 'path';
-import type { ModifyActionConfig, NodePlopAPI } from 'plop';
-import { EXTRA_TEMPLATE_VARIABLES, IS_DEV, PARTIALS_DIR, PLUGIN_TYPES, TEMPLATE_PATHS } from '../constants';
-import { ifEq, normalizeId } from '../utils/utils.handlebars';
-import { getExportPath } from '../utils/utils.path';
-import { getPackageManagerInstallCmd, getPackageManagerFromUserAgent } from '../utils/utils.packageManager';
-import { printGenerateSuccessMessage } from './generate-actions/print-success-message';
-import { updateGoSdkAndModules } from './generate-actions/update-go-sdk-and-packages';
-import { prettifyFiles } from './generate-actions/prettify-files';
-import { CliArgs, TemplateData } from './types';
-import { getExportFileName } from '../utils/utils.files';
-import { getConfig } from '../utils/utils.config';
-import { getVersion } from '../utils/utils.version';
-
-// 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', printGenerateSuccessMessage);
-  plop.setActionType('prettifyFiles', prettifyFiles);
-  plop.setActionType('updateGoSdkAndModules', updateGoSdkAndModules);
-
-  plop.setGenerator('create-plugin', {
-    description: 'used to scaffold a grafana plugin',
-    prompts: [
-      {
-        name: 'pluginName',
-        type: 'input',
-        message: 'What is going to be the name of your plugin?',
-        validate: (value: string) => {
-          if (/.+/.test(value)) {
-            return true;
-          }
-          return 'Plugin name is required';
-        },
-      },
-      {
-        name: 'orgName',
-        type: 'input',
-        message: 'What is the organization name of your plugin?',
-        validate: (value: string) => {
-          if (/.+/.test(value)) {
-            return true;
-          }
-          return 'Organization name is required';
-        },
-      },
-      {
-        name: 'pluginDescription',
-        type: 'input',
-        message: 'How would you describe your plugin?',
-        default: '',
-      },
-      {
-        name: 'pluginType',
-        type: 'list',
-        choices: [PLUGIN_TYPES.app, PLUGIN_TYPES.datasource, PLUGIN_TYPES.panel, PLUGIN_TYPES.scenes],
-        message: 'What type of plugin would you like?',
-      },
-      {
-        name: 'hasBackend',
-        type: 'confirm',
-        message: 'Do you want a backend part of your plugin?',
-        default: false,
-        when: (answers: CliArgs) => answers.pluginType !== PLUGIN_TYPES.panel,
-      },
-      {
-        name: 'hasGithubWorkflows',
-        type: 'confirm',
-        message: 'Do you want to add Github CI and Release workflows?',
-        default: false,
-      },
-      {
-        name: 'hasGithubLevitateWorkflow',
-        type: 'confirm',
-        message: 'Do you want to add a Github workflow for automatically checking "Grafana API compatibility" on PRs?',
-        default: false,
-      },
-    ],
-    actions: function ({
-      pluginName,
-      orgName,
-      pluginType,
-      hasBackend,
-      hasGithubWorkflows,
-      hasGithubLevitateWorkflow,
-    }: CliArgs) {
-      const { features } = getConfig();
-      const currentVersion = getVersion();
-      const exportPath = getExportPath(pluginName, orgName, pluginType);
-      const pluginId = normalizeId(pluginName, orgName, pluginType);
-      // Support the users package manager of choice.
-      const { packageManagerName, packageManagerVersion } = getPackageManagerFromUserAgent();
-      const packageManagerInstallCmd = getPackageManagerInstallCmd(packageManagerName);
-      const isAppType = pluginType === PLUGIN_TYPES.app || pluginType === PLUGIN_TYPES.scenes;
-      const templateData: TemplateData = {
-        pluginId,
-        packageManagerName,
-        packageManagerInstallCmd,
-        packageManagerVersion,
-        isAppType,
-        isNPM: packageManagerName === 'npm',
-        version: currentVersion,
-        bundleGrafanaUI: features.bundleGrafanaUI,
-      };
-      // Copy over files that are shared between plugins types
-      const commonActions = getActionsForTemplateFolder({
-        folderPath: TEMPLATE_PATHS.common,
-        exportPath,
-        templateData,
-      });
-
-      // Copy over files from the plugin type specific folder, e.g. "templates/app" for "app" plugins ("app" | "panel" | "datasource").
-      const pluginTypeSpecificActions = getActionsForTemplateFolder({
-        folderPath: TEMPLATE_PATHS[pluginType],
-        exportPath,
-        templateData,
-      });
-
-      // Copy over backend-specific files (if selected)
-      const backendFolderPath = isAppType ? TEMPLATE_PATHS.backendApp : TEMPLATE_PATHS.backend;
-      const backendActions = hasBackend
-        ? getActionsForTemplateFolder({ folderPath: backendFolderPath, exportPath, templateData })
-        : [];
-
-      // Common, pluginType and backend actions can contain different templates for the same destination.
-      // This filtering removes the duplicate file additions to prevent plop erroring and makes sure the
-      // correct template is scaffolded.
-      // Note that the order is reversed so backend > pluginType > common
-      const pluginActions = [...backendActions, ...pluginTypeSpecificActions, ...commonActions].reduce((acc, file) => {
-        const actionExists = acc.find((f) => f.path === file.path);
-        // return early to prevent multiple add type actions being added to the array
-        if (actionExists && actionExists.type === 'add' && file.type === 'add') {
-          return acc;
-        }
-        acc.push(file);
-        return acc;
-      }, []);
-
-      // Copy over Github workflow files (if selected)
-      const ciWorkflowActions = hasGithubWorkflows
-        ? getActionsForTemplateFolder({
-            folderPath: TEMPLATE_PATHS.ciWorkflows,
-            exportPath,
-            templateData,
-          })
-        : [];
-
-      const isCompatibleWorkflowActions = hasGithubLevitateWorkflow
-        ? getActionsForTemplateFolder({
-            folderPath: TEMPLATE_PATHS.isCompatibleWorkflow,
-            exportPath,
-            templateData,
-          })
-        : [];
-
-      // Replace conditional bits in the Readme files
-      const readmeActions = getActionsForReadme({ exportPath, templateData });
-
-      return [
-        ...pluginActions,
-        ...ciWorkflowActions,
-        ...readmeActions,
-        ...isCompatibleWorkflowActions,
-        {
-          type: 'updateGoSdkAndModules',
-        },
-        { type: 'prettifyFiles' },
-        {
-          type: 'printSuccessMessage',
-        },
-      ];
-    },
-  });
-}
-
-function getActionsForReadme({
-  exportPath,
-  templateData,
-}: {
-  exportPath: string;
-  templateData: TemplateData;
-}): ModifyActionConfig[] {
-  return [
-    replacePatternWithTemplateInReadme(
-      '-- INSERT FRONTEND GETTING STARTED --',
-      'frontend-getting-started.md',
-      exportPath,
-      templateData
-    ),
-    replacePatternWithTemplateInReadme(
-      '-- INSERT BACKEND GETTING STARTED --',
-      'backend-getting-started.md',
-      exportPath,
-      templateData
-    ),
-    replacePatternWithTemplateInReadme(
-      '-- INSERT DISTRIBUTING YOUR PLUGIN --',
-      'distributing-your-plugin.md',
-      exportPath,
-      templateData
-    ),
-  ];
-}
-
-function replacePatternWithTemplateInReadme(
-  pattern: string,
-  partialsFile: string,
-  exportPath: string,
-  templateData: TemplateData
-): ModifyActionConfig {
-  return {
-    type: 'modify',
-    path: path.join(exportPath, 'README.md'),
-    pattern,
-    // @ts-ignore
-    template: undefined,
-    templateFile: path.join(PARTIALS_DIR, partialsFile),
-    data: {
-      ...EXTRA_TEMPLATE_VARIABLES,
-      ...templateData,
-    },
-  };
-}
-
-// TODO<use Plop action `addMany` instead>
-function getActionsForTemplateFolder({
-  folderPath,
-  exportPath,
-  templateData,
-}: {
-  folderPath: string;
-  exportPath: string;
-  templateData: TemplateData;
-}) {
-  let files = glob.sync(`${folderPath}/**`, { dot: true });
-
-  // The npmrc file is only useful for `pnpm` settings. We can remove it for other package managers.
-  if (templateData.packageManagerName !== 'pnpm') {
-    files = files.filter((file) => path.basename(file) !== 'npmrc');
-  }
-
-  function getExportPath(f: string) {
-    return path.relative(folderPath, path.dirname(f));
-  }
-
-  return files.filter(isFile).map((f) => ({
-    type: 'add',
-    templateFile: f,
-    // The target path where the compiled template is saved to
-    path: path.join(exportPath, getExportPath(f), getExportFileName(f)),
-    // Support overriding files in development for overriding "generated" plugins.
-    force: IS_DEV,
-    // We would still like to scaffold as many files as possible even if one fails
-    abortOnFail: false,
-    data: {
-      ...EXTRA_TEMPLATE_VARIABLES,
-      ...templateData,
-    },
-  }));
-}
-
-function isFile(path: string) {
-  try {
-    return fs.lstatSync(path).isFile();
-  } catch (e) {
-    return false;
-  }
-}