@grafana/create-plugin 2.10.0 → 2.10.2-canary.624.1787d34.0

package/CHANGELOG.md

@@ -1,3 +1,22 @@
+# v2.10.1 (Thu Dec 14 2023)
+
+:tada: This release contains work from a new contributor! :tada:
+
+Thank you, Carson ([@mure](https://github.com/mure)), for all your work!
+
+#### 🐛 Bug Fix
+
+- Copy over `query_help.md` when building plugins [#374](https://github.com/grafana/plugin-tools/pull/374) ([@mure](https://github.com/mure) [@jackw](https://github.com/jackw))
+- Minor edits to style of README.md [#583](https://github.com/grafana/plugin-tools/pull/583) ([@josmperez](https://github.com/josmperez))
+
+#### Authors: 3
+
+- Carson ([@mure](https://github.com/mure))
+- Jack Westbrook ([@jackw](https://github.com/jackw))
+- Joseph Perez ([@josmperez](https://github.com/josmperez))
+
+---
+
 # v2.10.0 (Tue Dec 12 2023)
 
 #### 🚀 Enhancement

package/dist/commands/migrate.command.js

@@ -53,7 +53,7 @@ var migrate = function () { return __awaiter(void 0, void 0, void 0, function ()
                 return [4, (0, utils_console_1.confirmPrompt)(constants_1.TEXT.overrideFilesPrompt + '\n' + (0, utils_console_1.displayArrayAsList)(constants_1.MIGRATION_CONFIG.filesToOverride))];
             case 1:
                 if (_a.sent()) {
-                    (0, utils_templates_1.compileTemplateFiles)(constants_1.MIGRATION_CONFIG.filesToOverride, (0, utils_templates_1.getTemplateData)());
+                    (0, utils_templates_1.compileTemplateFiles)(constants_1.MIGRATION_CONFIG.filesToOverride.map(utils_files_1.getExportTemplateName), (0, utils_templates_1.getTemplateData)());
                     (0, utils_console_1.printSuccessMessage)(constants_1.TEXT.overrideFilesSuccess);
                 }
                 else {

package/dist/utils/utils.files.js

@@ -3,7 +3,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isFileStartingWith = exports.getExportFileName = exports.removeFilesInCwd = exports.getOnlyNotExistingInCwd = exports.getOnlyExistingInCwd = exports.readJsonFile = exports.isFile = exports.filterOutCommonFiles = void 0;
+exports.isFileStartingWith = exports.getExportFileName = exports.getExportTemplateName = exports.removeFilesInCwd = exports.getOnlyNotExistingInCwd = exports.getOnlyExistingInCwd = exports.readJsonFile = exports.isFile = exports.filterOutCommonFiles = void 0;
 var path_1 = __importDefault(require("path"));
 var fs_1 = __importDefault(require("fs"));
 var constants_1 = require("../constants");
@@ -52,6 +52,17 @@ function removeFilesInCwd(files) {
     }
 }
 exports.removeFilesInCwd = removeFilesInCwd;
+function getExportTemplateName(f) {
+    var baseName = path_1.default.basename(f);
+    for (var _i = 0, _a = Object.entries(configFileNamesMap); _i < _a.length; _i++) {
+        var _b = _a[_i], key = _b[0], value = _b[1];
+        if (value === baseName) {
+            return key;
+        }
+    }
+    return baseName;
+}
+exports.getExportTemplateName = getExportTemplateName;
 function getExportFileName(f) {
     var baseName = path_1.default.basename(f);
     if (Object.keys(configFileNamesMap).includes(baseName)) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/create-plugin",
-  "version": "2.10.0",
+  "version": "2.10.2-canary.624.1787d34.0",
   "main": "index.js",
   "repository": {
     "directory": "packages/create-plugin",
@@ -66,5 +66,5 @@
   "engines": {
     "node": ">=20"
   },
-  "gitHead": "5a5226f5a561f7a050dc26387d48f10def9c1de0"
+  "gitHead": "1787d3412fccceb73f95f91a2ed29395674608c4"
 }

package/src/commands/migrate.command.ts

@@ -1,7 +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 { getOnlyExistingInCwd, getOnlyNotExistingInCwd, removeFilesInCwd } from '../utils/utils.files';
+import {
+  getExportTemplateName,
+  getOnlyExistingInCwd,
+  getOnlyNotExistingInCwd,
+  removeFilesInCwd,
+} from '../utils/utils.files';
 import {
   getPackageJsonUpdatesAsText,
   updatePackageJson,
@@ -23,7 +28,7 @@ export const migrate = async () => {
     // 1. Add / update configuration files
     // --------------------------
     if (await confirmPrompt(TEXT.overrideFilesPrompt + '\n' + displayArrayAsList(MIGRATION_CONFIG.filesToOverride))) {
-      compileTemplateFiles(MIGRATION_CONFIG.filesToOverride, getTemplateData());
+      compileTemplateFiles(MIGRATION_CONFIG.filesToOverride.map(getExportTemplateName), getTemplateData());
       printSuccessMessage(TEXT.overrideFilesSuccess);
     } else {
       printMessage(TEXT.overrideFilesAborted);

package/src/utils/utils.files.ts

@@ -50,6 +50,19 @@ export function removeFilesInCwd(files: string[]) {
   }
 }
 
+/** Given a exported file name it'll return its equivalent
+ * in the template folder.
+ */
+export function getExportTemplateName(f: string) {
+  const baseName = path.basename(f);
+  for (const [key, value] of Object.entries(configFileNamesMap)) {
+    if (value === baseName) {
+      return key;
+    }
+  }
+  return baseName;
+}
+
 export function getExportFileName(f: string) {
   const baseName = path.basename(f);
 

package/templates/app/README.md

@@ -4,9 +4,9 @@ This template is a starting point for building an app plugin for Grafana.
 
 ## What are Grafana app plugins?
 
-App plugins can let you create a custom out-of-the-box monitoring experience by custom pages, nested datasources and panel plugins.
+App plugins can let you create a custom out-of-the-box monitoring experience by custom pages, nested data sources and panel plugins.
 
-## Getting started
+## Get started
 
 {{#if hasBackend}}-- INSERT BACKEND GETTING STARTED --{{/if}}
 -- INSERT FRONTEND GETTING STARTED --
@@ -19,4 +19,4 @@ Below you can find source code for existing app plugins and other related docume
 
 - [Basic app plugin example](https://github.com/grafana/grafana-plugin-examples/tree/master/examples/app-basic#readme)
 - [`plugin.json` documentation](https://grafana.com/developers/plugin-tools/reference-plugin-json)
-- [How to sign a plugin?](https://grafana.com/developers/plugin-tools/publish-a-plugin/sign-a-plugin)
+- [Sign a plugin](https://grafana.com/developers/plugin-tools/publish-a-plugin/sign-a-plugin)

package/templates/common/.config/webpack/webpack.config.ts

@@ -157,6 +157,7 @@ const config = async (env): Promise<Configuration> => {
           { from: 'img/**/*', to: '.', noErrorOnMissing: true }, // Optional
           { from: 'libs/**/*', to: '.', noErrorOnMissing: true }, // Optional
           { from: 'static/**/*', to: '.', noErrorOnMissing: true }, // Optional
+          { from: '**/query_help.md', to: '.', noErrorOnMissing: true}, // Optional
         ],
       }),
       // Replace certain template-variables in the README and plugin.json