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

package/dist/utils/utils.templates.js

@@ -1,95 +1,73 @@
-"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 });
-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"));
-var mkdirp_1 = __importDefault(require("mkdirp"));
-var utils_files_1 = require("./utils.files");
-var utils_handlebars_1 = require("./utils.handlebars");
-var utils_plugin_1 = require("./utils.plugin");
-var constants_1 = require("../constants");
-var utils_packageManager_1 = require("./utils.packageManager");
-var utils_files_2 = require("../utils/utils.files");
-var utils_version_1 = require("./utils.version");
-var utils_config_1 = require("./utils.config");
-function getTemplateFiles(pluginType, filter) {
-    var commonFiles = glob_1.default.sync("".concat(constants_1.TEMPLATE_PATHS.common, "/**"), { dot: true });
-    var pluginTypeSpecificFiles = glob_1.default.sync("".concat(constants_1.TEMPLATE_PATHS[pluginType], "/**"), { dot: true });
-    var templateFiles = (0, utils_files_1.filterOutCommonFiles)(__spreadArray(__spreadArray([], commonFiles, true), pluginTypeSpecificFiles, true), pluginType);
+import glob from 'glob';
+import path from 'node:path';
+import fs from 'node:fs';
+import mkdirp from 'mkdirp';
+import { filterOutCommonFiles, isFile, isFileStartingWith } from './utils.files.js';
+import { renderHandlebarsTemplate } from './utils.handlebars.js';
+import { getPluginJson } from './utils.plugin.js';
+import { TEMPLATE_PATHS, EXPORT_PATH_PREFIX, EXTRA_TEMPLATE_VARIABLES } from '../constants.js';
+import { getPackageManagerWithFallback } from './utils.packageManager.js';
+import { getExportFileName } from '../utils/utils.files.js';
+import { getVersion } from './utils.version.js';
+import { getConfig } from './utils.config.js';
+export function getTemplateFiles(pluginType, filter) {
+    const commonFiles = glob.sync(`${TEMPLATE_PATHS.common}/**`, { dot: true });
+    const pluginTypeSpecificFiles = glob.sync(`${TEMPLATE_PATHS[pluginType]}/**`, { dot: true });
+    const templateFiles = filterOutCommonFiles([...commonFiles, ...pluginTypeSpecificFiles], pluginType);
     if (filter) {
-        return templateFiles.filter(function (file) {
-            var projectRelativePath = getProjectRelativeTemplatePath(file, pluginType);
-            return (0, utils_files_1.isFileStartingWith)(projectRelativePath, filter);
+        return templateFiles.filter((file) => {
+            const projectRelativePath = getProjectRelativeTemplatePath(file, pluginType);
+            return isFileStartingWith(projectRelativePath, filter);
         });
     }
     return templateFiles;
 }
-exports.getTemplateFiles = getTemplateFiles;
-function getProjectRelativeTemplatePath(file, pluginType) {
-    return file.replace(constants_1.TEMPLATE_PATHS.common, '').replace(constants_1.TEMPLATE_PATHS[pluginType], '').replace(/^\/+/, '');
+export function getProjectRelativeTemplatePath(file, pluginType) {
+    return file.replace(TEMPLATE_PATHS.common, '').replace(TEMPLATE_PATHS[pluginType], '').replace(/^\/+/, '');
 }
-exports.getProjectRelativeTemplatePath = getProjectRelativeTemplatePath;
-function compileTemplateFiles(filter, data) {
-    var type = (0, utils_plugin_1.getPluginJson)().type;
-    getTemplateFiles(type, filter).forEach(function (file) { return compileSingleTemplateFile(type, file, data); });
+export function compileTemplateFiles(filter, data) {
+    const { type } = getPluginJson();
+    getTemplateFiles(type, filter).forEach((file) => compileSingleTemplateFile(type, file, data));
 }
-exports.compileTemplateFiles = compileTemplateFiles;
-function compileSingleTemplateFile(pluginType, templateFile, data) {
-    if (!(0, utils_files_1.isFile)(templateFile)) {
+export function compileSingleTemplateFile(pluginType, templateFile, data) {
+    if (!isFile(templateFile)) {
         return;
     }
-    var rendered = renderTemplateFromFile(templateFile, data);
-    var relativeExportPath = templateFile.replace(constants_1.TEMPLATE_PATHS.common, '').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);
+    const rendered = renderTemplateFromFile(templateFile, data);
+    const relativeExportPath = templateFile.replace(TEMPLATE_PATHS.common, '').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);
 }
-exports.compileSingleTemplateFile = compileSingleTemplateFile;
-function compileProvisioningTemplateFile(pluginType, templateFile, data) {
-    if (!(0, utils_files_1.isFile)(templateFile)) {
+export function compileProvisioningTemplateFile(pluginType, templateFile, data) {
+    if (!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);
+    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);
 }
-exports.compileProvisioningTemplateFile = compileProvisioningTemplateFile;
-function renderTemplateFromFile(templateFile, data) {
-    return (0, utils_handlebars_1.renderHandlebarsTemplate)(fs_1.default.readFileSync(templateFile).toString(), data);
+export function renderTemplateFromFile(templateFile, data) {
+    return renderHandlebarsTemplate(fs.readFileSync(templateFile).toString(), data);
 }
-exports.renderTemplateFromFile = renderTemplateFromFile;
-function getTemplateData() {
-    var _a, _b, _c;
-    var pluginJson = (0, utils_plugin_1.getPluginJson)();
-    var features = (0, utils_config_1.getConfig)().features;
-    var currentVersion = (0, utils_version_1.getVersion)();
-    var _d = (0, utils_packageManager_1.getPackageManagerWithFallback)(), packageManagerName = _d.packageManagerName, packageManagerVersion = _d.packageManagerVersion;
-    return __assign(__assign({}, constants_1.EXTRA_TEMPLATE_VARIABLES), { pluginId: pluginJson.id, pluginName: pluginJson.name, pluginDescription: (_a = pluginJson.info) === null || _a === void 0 ? void 0 : _a.description, hasBackend: Boolean(pluginJson.backend), orgName: (_c = (_b = pluginJson.info) === null || _b === void 0 ? void 0 : _b.author) === null || _c === void 0 ? void 0 : _c.name, pluginType: pluginJson.type, packageManagerName: packageManagerName, packageManagerVersion: packageManagerVersion, version: currentVersion, bundleGrafanaUI: features.bundleGrafanaUI });
+export function getTemplateData() {
+    const pluginJson = getPluginJson();
+    const { features } = getConfig();
+    const currentVersion = getVersion();
+    const { packageManagerName, packageManagerVersion } = getPackageManagerWithFallback();
+    return {
+        ...EXTRA_TEMPLATE_VARIABLES,
+        pluginId: pluginJson.id,
+        pluginName: pluginJson.name,
+        pluginDescription: pluginJson.info?.description,
+        hasBackend: Boolean(pluginJson.backend),
+        orgName: pluginJson.info?.author?.name,
+        pluginType: pluginJson.type,
+        packageManagerName,
+        packageManagerVersion,
+        version: currentVersion,
+        bundleGrafanaUI: features.bundleGrafanaUI,
+    };
 }
-exports.getTemplateData = getTemplateData;

package/dist/utils/utils.version.js

@@ -1,15 +1,13 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getVersion = void 0;
-var fs_1 = require("fs");
-var path_1 = require("path");
-function getVersion() {
-    var packageJsonPath = (0, path_1.resolve)(__dirname, '..', '..', 'package.json');
-    var pkg = (0, fs_1.readFileSync)(packageJsonPath, 'utf8');
-    var version = JSON.parse(pkg).version;
+import { readFileSync } from 'node:fs';
+import { resolve } from 'node:path';
+import { fileURLToPath } from 'node:url';
+const __dirname = fileURLToPath(new URL('.', import.meta.url));
+export function getVersion() {
+    const packageJsonPath = resolve(__dirname, '..', '..', 'package.json');
+    const pkg = readFileSync(packageJsonPath, 'utf8');
+    const { version } = JSON.parse(pkg);
     if (!version) {
-        throw "Could not find the version of create-plugin";
+        throw `Could not find the version of create-plugin`;
     }
     return version;
 }
-exports.getVersion = getVersion;

package/package.json

@@ -1,7 +1,6 @@
 {
   "name": "@grafana/create-plugin",
-  "version": "2.11.2",
-  "main": "index.js",
+  "version": "2.12.0-canary.658.dabaee1.0",
   "repository": {
     "directory": "packages/create-plugin",
     "url": "https://github.com/grafana/plugin-tools"
@@ -9,6 +8,13 @@
   "author": "Grafana",
   "license": "Apache-2.0",
   "bin": "./dist/bin/run.js",
+  "type": "module",
+  "exports": {
+    "node": {
+      "import": "./index.js"
+    },
+    "default": "./index.js"
+  },
   "publishConfig": {
     "registry": "https://registry.npmjs.org/",
     "access": "public"
@@ -30,10 +36,12 @@
     "generate-datasource-backend": "tsc && npm run clean-generated && CREATE_PLUGIN_DEV=true node ./dist/bin/run.js --pluginName='Sample datasource' --orgName='sample-org' --pluginDescription='This is a sample datasource.' --pluginType='datasource' --hasBackend --hasGithubWorkflows --hasGithubLevitateWorkflow",
     "lint": "eslint --cache --ext .js,.jsx,.ts,.tsx ./src",
     "lint:fix": "npm run lint -- --fix",
-    "test": "jest",
+    "test": "vitest",
+    "test:ci": "vitest run",
     "typecheck": "tsc --noEmit"
   },
   "dependencies": {
+    "@types/marked-terminal": "^6.0.1",
     "@types/minimist": "^1.2.2",
     "@types/mkdirp": "^1.0.2",
     "@types/semver": "^7.3.9",
@@ -45,7 +53,7 @@
     "glob": "^7.1.7",
     "handlebars": "^4.7.8",
     "marked": "^10.0.0",
-    "marked-terminal": "^5.1.1",
+    "marked-terminal": "^6.2.0",
     "minimist": "^1.2.8",
     "mkdirp": "^1.0.4",
     "semver": "^7.3.5",
@@ -55,7 +63,13 @@
   "devDependencies": {
     "@types/glob": "^7.0.0",
     "eslint-plugin-react": "^7.26.1",
-    "eslint-plugin-react-hooks": "^4.2.0"
+    "eslint-plugin-react-hooks": "^4.2.0",
+    "vitest": "^1.1.3"
+  },
+  "overrides": {
+    "@types/marked-terminal": {
+      "marked": "^10.0.0"
+    }
   },
   "nodemonConfig": {
     "watch": [
@@ -73,5 +87,5 @@
   "engines": {
     "node": ">=20"
   },
-  "gitHead": "fb151d4a42b5070192759ad4e86d79ce6ce9fbe9"
+  "gitHead": "dabaee1ff0a80d59cf5ffb016b5deda96e052633"
 }

package/src/bin/run.ts

@@ -1,8 +1,8 @@
 #!/usr/bin/env node
 
 import minimist from 'minimist';
-import { generate, update, migrate, version, provisioning } from '../commands';
-import { isUnsupportedPlatform } from '../utils/utils.os';
+import { generate, update, migrate, version, provisioning } from '../commands/index.js';
+import { isUnsupportedPlatform } from '../utils/utils.os.js';
 
 // Exit early if operating system isn't supported.
 if (isUnsupportedPlatform()) {

package/src/commands/generate/prettify-files.ts

@@ -1,6 +1,6 @@
 import { exec as nodeExec } from 'node:child_process';
 import { promisify } from 'node:util';
-import fs from 'fs';
+import fs from 'node:fs';
 
 const exec = promisify(nodeExec);
 

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

@@ -1,7 +1,7 @@
-import { displayAsMarkdown } from '../../utils/utils.console';
-import { normalizeId } from '../../utils/utils.handlebars';
-import { getPackageManagerFromUserAgent } from '../../utils/utils.packageManager';
-import { CliArgs } from '../types';
+import { displayAsMarkdown } from '../../utils/utils.console.js';
+import { normalizeId } from '../../utils/utils.handlebars.js';
+import { getPackageManagerFromUserAgent } from '../../utils/utils.packageManager.js';
+import { CliArgs } from '../types.js';
 
 export function printGenerateSuccessMessage(answers: CliArgs) {
   const directory = normalizeId(answers.pluginName, answers.orgName, answers.pluginType);

package/src/commands/generate/prompt-user.ts

@@ -1,7 +1,7 @@
 import minimist from 'minimist';
 import Enquirer from 'enquirer';
-import { PLUGIN_TYPES } from '../../constants';
-import { CliArgs } from '../types';
+import { PLUGIN_TYPES } from '../../constants.js';
+import { CliArgs } from '../types.js';
 
 export async function promptUser(argv: minimist.ParsedArgs) {
   let answers: Partial<CliArgs> = {};

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

@@ -1,6 +1,6 @@
 import which from 'which';
-import fs from 'fs';
-import { exec } from 'child_process';
+import fs from 'node:fs';
+import { exec } from 'node:child_process';
 
 const SDK_GO_MODULE = 'github.com/grafana/grafana-plugin-sdk-go';
 

package/src/commands/generate.command.ts

@@ -2,21 +2,21 @@ import glob from 'glob';
 import minimist from 'minimist';
 import chalk from 'chalk';
 import { mkdir, readdir, writeFile } from 'node:fs/promises';
-import path from 'path';
-import { EXTRA_TEMPLATE_VARIABLES, IS_DEV, PLUGIN_TYPES, TEMPLATE_PATHS } from '../constants';
-import { getConfig } from '../utils/utils.config';
-import { printError } from '../utils/utils.console';
-import { directoryExists, getExportFileName, isFile } from '../utils/utils.files';
-import { normalizeId } from '../utils/utils.handlebars';
-import { getPackageManagerFromUserAgent, getPackageManagerInstallCmd } from '../utils/utils.packageManager';
-import { getExportPath } from '../utils/utils.path';
-import { renderTemplateFromFile } from '../utils/utils.templates';
-import { getVersion } from '../utils/utils.version';
-import { prettifyFiles } from './generate/prettify-files';
-import { printGenerateSuccessMessage } from './generate/print-success-message';
-import { promptUser } from './generate/prompt-user';
-import { updateGoSdkAndModules } from './generate/update-go-sdk-and-packages';
-import { CliArgs, TemplateData } from './types';
+import path from 'node:path';
+import { EXTRA_TEMPLATE_VARIABLES, IS_DEV, PLUGIN_TYPES, TEMPLATE_PATHS } from '../constants.js';
+import { getConfig } from '../utils/utils.config.js';
+import { printError } from '../utils/utils.console.js';
+import { directoryExists, getExportFileName, isFile } from '../utils/utils.files.js';
+import { normalizeId } from '../utils/utils.handlebars.js';
+import { getPackageManagerFromUserAgent, getPackageManagerInstallCmd } from '../utils/utils.packageManager.js';
+import { getExportPath } from '../utils/utils.path.js';
+import { renderTemplateFromFile } from '../utils/utils.templates.js';
+import { getVersion } from '../utils/utils.version.js';
+import { prettifyFiles } from './generate/prettify-files.js';
+import { printGenerateSuccessMessage } from './generate/print-success-message.js';
+import { promptUser } from './generate/prompt-user.js';
+import { updateGoSdkAndModules } from './generate/update-go-sdk-and-packages.js';
+import { CliArgs, TemplateData } from './types.js';
 
 export const generate = async (argv: minimist.ParsedArgs) => {
   const answers = await promptUser(argv);

package/src/commands/index.ts

@@ -1,5 +1,5 @@
-export * from './generate.command';
-export * from './update.command';
-export * from './migrate.command';
-export * from './version.command';
-export * from './provisioning.command';
+export * from './generate.command.js';
+export * from './update.command.js';
+export * from './migrate.command.js';
+export * from './version.command.js';
+export * from './provisioning.command.js';

package/src/commands/migrate.command.ts

@@ -1,12 +1,12 @@
-import { TEXT, MIGRATION_CONFIG } from '../constants';
-import { displayArrayAsList, printMessage, printSuccessMessage, confirmPrompt } from '../utils/utils.console';
-import { compileTemplateFiles, getTemplateData } from '../utils/utils.templates';
+import { TEXT, MIGRATION_CONFIG } from '../constants.js';
+import { displayArrayAsList, printMessage, printSuccessMessage, confirmPrompt } from '../utils/utils.console.js';
+import { compileTemplateFiles, getTemplateData } from '../utils/utils.templates.js';
 import {
   getExportTemplateName,
   getOnlyExistingInCwd,
   getOnlyNotExistingInCwd,
   removeFilesInCwd,
-} from '../utils/utils.files';
+} from '../utils/utils.files.js';
 import {
   getPackageJsonUpdatesAsText,
   updatePackageJson,
@@ -16,8 +16,8 @@ import {
   updateNpmScripts,
   cleanUpPackageJson,
   writePackageManagerInPackageJson,
-} from '../utils/utils.npm';
-import { getPackageManagerWithFallback } from '../utils/utils.packageManager';
+} from '../utils/utils.npm.js';
+import { getPackageManagerWithFallback } from '../utils/utils.packageManager.js';
 
 export const migrate = async () => {
   try {

package/src/commands/provisioning.command.ts

@@ -1,10 +1,10 @@
 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';
+import path from 'node:path';
+import fs from 'node:fs';
+import { TEMPLATE_PATHS, TEXT } from '../constants.js';
+import { getPluginJson } from '../utils/utils.plugin.js';
+import { compileProvisioningTemplateFile, getTemplateData } from '../utils/utils.templates.js';
+import { confirmPrompt, printMessage, printSuccessMessage, printError } from '../utils/utils.console.js';
 
 export const provisioning = async () => {
   const { type } = getPluginJson();

package/src/commands/types.ts

@@ -1,4 +1,4 @@
-import { PLUGIN_TYPES } from '../constants';
+import { PLUGIN_TYPES } from '../constants.js';
 
 export type CliArgs = {
   pluginName: string;

package/src/commands/update.command.ts

@@ -1,14 +1,14 @@
-import { TEXT, UDPATE_CONFIG } from '../constants';
-import { compileTemplateFiles, getTemplateData } from '../utils/utils.templates';
-import { confirmPrompt, selectPrompt, printMessage, printSuccessMessage } from '../utils/utils.console';
+import { TEXT, UDPATE_CONFIG } from '../constants.js';
+import { compileTemplateFiles, getTemplateData } from '../utils/utils.templates.js';
+import { confirmPrompt, selectPrompt, printMessage, printSuccessMessage } from '../utils/utils.console.js';
 import {
   updatePackageJson,
   hasNpmDependenciesToUpdate,
   getPackageJsonUpdatesAsText,
   updateNpmScripts,
   writePackageManagerInPackageJson,
-} from '../utils/utils.npm';
-import { getPackageManagerWithFallback } from '../utils/utils.packageManager';
+} from '../utils/utils.npm.js';
+import { getPackageManagerWithFallback } from '../utils/utils.packageManager.js';
 
 export const update = async () => {
   try {

package/src/commands/version.command.ts

@@ -1,5 +1,8 @@
-import { resolve } from 'path';
-import { readFileSync } from 'fs';
+import { resolve } from 'node:path';
+import { readFileSync } from 'node:fs';
+import { fileURLToPath } from 'node:url';
+
+const __dirname = fileURLToPath(new URL('.', import.meta.url));
 
 export const version = async () => {
   try {

package/src/constants.ts

@@ -1,4 +1,7 @@
-import path from 'path';
+import path from 'node:path';
+import { fileURLToPath } from 'node:url';
+
+const __dirname = fileURLToPath(new URL('.', import.meta.url));
 
 export const IS_DEV = process.env.CREATE_PLUGIN_DEV !== undefined;
 

package/src/utils/tests/utils.files.test.ts

@@ -1,5 +1,5 @@
-import { PLUGIN_TYPES, TEMPLATE_PATHS } from '../../constants';
-import { filterOutCommonFiles, isFile } from '../utils.files';
+import { PLUGIN_TYPES, TEMPLATE_PATHS } from '../../constants.js';
+import { filterOutCommonFiles, isFile } from '../utils.files.js';
 
 describe('Utils/Files', () => {
   describe('filterOutCommonFiles()', () => {

package/src/utils/tests/utils.handlebars.test.ts

@@ -1,5 +1,5 @@
-import { PLUGIN_TYPES } from '../../constants';
-import { normalizeId } from '../utils.handlebars';
+import { PLUGIN_TYPES } from '../../constants.js';
+import { normalizeId } from '../utils.handlebars.js';
 
 describe('Handlebars helpers', () => {
   describe('normalize id', () => {