@grafana/create-plugin 5.0.0-canary.1018.f88ab25.0 → 5.0.0

package/CHANGELOG.md

@@ -1,3 +1,27 @@
+# v5.0.0 (Wed Jul 31 2024)
+
+#### 💥 Breaking Change
+
+- Create-Plugin: Simplify Prompts [#1018](https://github.com/grafana/plugin-tools/pull/1018) ([@jackw](https://github.com/jackw))
+
+#### Authors: 1
+
+- Jack Westbrook ([@jackw](https://github.com/jackw))
+
+---
+
+# v4.16.3 (Mon Jul 29 2024)
+
+#### 🐛 Bug Fix
+
+- Create Plugin: Template dynamic public path [#1023](https://github.com/grafana/plugin-tools/pull/1023) ([@jackw](https://github.com/jackw))
+
+#### Authors: 1
+
+- Jack Westbrook ([@jackw](https://github.com/jackw))
+
+---
+
 # v4.16.2 (Fri Jul 12 2024)
 
 #### 🐛 Bug Fix

package/dist/commands/generate/print-success-message.js

@@ -1,3 +1,4 @@
+import { machine } from 'node:os';
 import { displayAsMarkdown } from '../../utils/utils.console.js';
 import { normalizeId } from '../../utils/utils.handlebars.js';
 import { getPackageManagerFromUserAgent } from '../../utils/utils.packageManager.js';
@@ -11,7 +12,7 @@ export function printGenerateSuccessMessage(answers) {
         `- \`${packageManagerName} run dev\` to build (and watch) the plugin frontend code.`,
         ...(answers.hasBackend
             ? [
-                '- `mage -v build:backend` to build the plugin backend code. Rerun this command every time you edit your backend files.',
+                `- ${getBackendCmd()} to build the plugin backend code. Rerun this command every time you edit your backend files.`,
             ]
             : []),
         '- `docker-compose up` to start a grafana development server.',
@@ -30,3 +31,10 @@ _Note: We strongly recommend creating a new Git repository by running \`git init
 `;
     console.log(displayAsMarkdown(msg));
 }
+function getBackendCmd() {
+    const platform = machine();
+    if (platform === 'arm64') {
+        return '`mage -v build:linuxARM64`';
+    }
+    return '`mage -v build:linux`';
+}

package/dist/commands/generate/prompt-user.js

@@ -3,17 +3,17 @@ import { PLUGIN_TYPES } from '../../constants.js';
 export async function promptUser(argv) {
     let answers = {};
     const enquirer = new Enquirer();
-    for (const prompt of prompts) {
-        const { name, shouldPrompt } = prompt(answers);
-        if (argv.hasOwnProperty(name)) {
-            answers = { ...answers, [name]: argv[name] };
+    for (const p of prompts) {
+        const prompt = p(answers);
+        if (argv.hasOwnProperty(prompt.name)) {
+            answers = { ...answers, [prompt.name]: argv[prompt.name] };
         }
         else {
-            if (typeof shouldPrompt === 'function' && !shouldPrompt(answers)) {
+            if (typeof prompt.shouldPrompt === 'function' && !prompt.shouldPrompt(answers)) {
                 continue;
             }
             else {
-                const result = await enquirer.prompt(prompt(answers));
+                const result = await enquirer.prompt(prompt);
                 answers = { ...answers, ...result };
             }
         }
@@ -26,33 +26,37 @@ const prompts = [
         type: 'select',
         choices: [
             {
-                name: 'App (Custom pages, UI Extensions and bundling other plugins)',
+                message: 'App (add custom pages, UI extensions and bundle other plugins)',
                 value: PLUGIN_TYPES.app,
             },
             {
-                name: 'Data source (Query data from a custom source)',
+                message: 'Data source (query data from a custom source)',
                 value: PLUGIN_TYPES.datasource,
             },
             {
-                name: 'Panel (New visualization for data or a widget)',
+                message: 'Panel (add a visualization for data or a widget)',
                 value: PLUGIN_TYPES.panel,
             },
             {
-                name: 'App with Scenes (Create dynamic dashboards in app pages)',
+                message: 'App with Scenes (create dynamic dashboards in app pages)',
                 value: PLUGIN_TYPES.scenes,
             },
         ],
-        message: 'Select plugin type',
-    }),
-    (answers) => ({
-        name: 'hasBackend',
-        type: 'confirm',
-        message: answers.pluginType === PLUGIN_TYPES.app
-            ? 'Does your plugin require a backend to support server-side functionality (e.g. calling external APIs, custom backend logic, advanced authentication, etc)?'
-            : 'Does your plugin require a backend to support server-side functionality (e.g. alerting, advanced authentication, public dashboards, etc)?',
-        initial: false,
-        shouldPrompt: (answers) => answers.pluginType !== PLUGIN_TYPES.panel,
+        message: 'Select a plugin type',
     }),
+    (answers) => {
+        const isAppType = answers.pluginType === PLUGIN_TYPES.app || answers.pluginType === PLUGIN_TYPES.scenes;
+        const message = isAppType
+            ? 'Add a backend to support server-side functionality? (calling external APIs, custom backend logic, advanced authentication, etc)'
+            : 'Add a backend to support server-side functionality? (alerting, advanced authentication, public dashboards, etc)';
+        return {
+            name: 'hasBackend',
+            type: 'confirm',
+            message: message,
+            initial: false,
+            shouldPrompt: (answers) => answers.pluginType !== PLUGIN_TYPES.panel,
+        };
+    },
     () => ({
         name: 'pluginName',
         type: 'input',
@@ -75,10 +79,4 @@ const prompts = [
             return 'Organization name is required';
         },
     }),
-    () => ({
-        name: 'pluginDescription',
-        type: 'input',
-        message: 'How would you describe your plugin?',
-        initial: '',
-    }),
 ];

package/dist/commands/generate/update-go-sdk-and-packages.js

@@ -1,7 +1,9 @@
 import which from 'which';
 import fs from 'node:fs';
+import createDebug from 'debug';
 import { exec } from 'node:child_process';
 const SDK_GO_MODULE = 'github.com/grafana/grafana-plugin-sdk-go';
+const debug = createDebug('create-plugin:update-go');
 export async function updateGoSdkAndModules(exportPath) {
     const goModPath = `${exportPath}/go.mod`;
     if (!fs.existsSync(goModPath)) {
@@ -12,19 +14,21 @@ export async function updateGoSdkAndModules(exportPath) {
         return '';
     }
     try {
+        const version = await getLatestSdkVersion(exportPath);
         await updateSdk(exportPath);
         await updateGoMod(exportPath);
+        return `Updated Grafana go sdk to ${version} (latest)`;
     }
     catch {
         throw new Error('There was an error trying to update the grafana go sdk. Please run `go get github.com/grafana/grafana-plugin-sdk-go` manually in your plugin directory.');
     }
-    return 'Grafana go sdk updated successfully.';
 }
 function updateSdk(exportPath) {
     return new Promise(async (resolve, reject) => {
         const command = `go get ${SDK_GO_MODULE}`;
         exec(command, { cwd: exportPath }, (error) => {
             if (error) {
+                debug(error);
                 reject();
             }
             resolve();
@@ -36,9 +40,23 @@ function updateGoMod(exportPath) {
         const command = `go mod tidy`;
         exec(command, { cwd: exportPath }, (error) => {
             if (error) {
+                debug(error);
                 reject();
             }
             resolve();
         });
     });
 }
+function getLatestSdkVersion(exportPath) {
+    return new Promise(async (resolve, reject) => {
+        const command = `go list -m -json ${SDK_GO_MODULE}@latest`;
+        exec(command, { cwd: exportPath }, (error, stdout) => {
+            if (error) {
+                debug(error);
+                reject();
+            }
+            const version = JSON.parse(stdout).Version;
+            resolve(version);
+        });
+    });
+}

package/dist/commands/generate.command.js

@@ -2,7 +2,7 @@ import { glob } from 'glob';
 import chalk from 'chalk';
 import { mkdir, readdir, writeFile } from 'node:fs/promises';
 import path from 'node:path';
-import { EXTRA_TEMPLATE_VARIABLES, IS_DEV, TEMPLATE_PATHS } from '../constants.js';
+import { EXTRA_TEMPLATE_VARIABLES, IS_DEV, PLUGIN_TYPES, TEMPLATE_PATHS } from '../constants.js';
 import { printError } from '../utils/utils.console.js';
 import { directoryExists, getExportFileName, isFile } from '../utils/utils.files.js';
 import { getExportPath } from '../utils/utils.path.js';
@@ -22,9 +22,17 @@ export const generate = async (argv) => {
         process.exit(1);
     }
     const actions = getTemplateActions({ templateData, exportPath });
-    const { changes, failures } = await generateFiles({ actions });
+    const failures = await generateFiles({ actions });
+    const changes = [
+        `Scaffolded ${templateData.pluginId} ${templateData.pluginType} plugin ${templateData.hasBackend ? '(with Go backend)' : ''}`,
+        'Added basic E2E test (Playwright)',
+        `${provisioningMsg[templateData.pluginType]}`,
+        'Configured development environment (Docker)',
+        'Added default GitHub actions for CI, releases and Grafana compatibility',
+    ];
+    console.log('');
     changes.forEach((change) => {
-        console.log(`${chalk.green('✔︎ ++')} ${change.path}`);
+        console.log(`${chalk.green('✔︎')} ${change}`);
     });
     failures.forEach((failure) => {
         printError(`${failure.error}`);
@@ -33,6 +41,7 @@ export const generate = async (argv) => {
         await execPostScaffoldFunction(updateGoSdkAndModules, exportPath);
     }
     await execPostScaffoldFunction(prettifyFiles, { targetPath: exportPath });
+    console.log('\n');
     printGenerateSuccessMessage(templateData);
 };
 function getTemplateActions({ exportPath, templateData }) {
@@ -60,7 +69,7 @@ function getTemplateActions({ exportPath, templateData }) {
     }, []);
     const ciWorkflowActions = getActionsForTemplateFolder({
         folderPath: TEMPLATE_PATHS.ciWorkflows,
-        exportPath,
+        exportPath: path.join(exportPath, '.github'),
         templateData,
     });
     return [...pluginActions, ...ciWorkflowActions];
@@ -84,7 +93,6 @@ function getActionsForTemplateFolder({ folderPath, exportPath, templateData, })
 }
 async function generateFiles({ actions }) {
     const failures = [];
-    const changes = [];
     for (const action of actions) {
         try {
             const rootDir = path.dirname(action.path);
@@ -94,9 +102,6 @@ async function generateFiles({ actions }) {
             }
             const rendered = renderTemplateFromFile(action.templateFile, action.data);
             await writeFile(action.path, rendered);
-            changes.push({
-                path: action.path,
-            });
         }
         catch (error) {
             let message;
@@ -112,7 +117,7 @@ async function generateFiles({ actions }) {
             });
         }
     }
-    return { failures, changes };
+    return failures;
 }
 async function execPostScaffoldFunction(fn, ...args) {
     try {
@@ -125,3 +130,9 @@ async function execPostScaffoldFunction(fn, ...args) {
         printError(`${error}`);
     }
 }
+const provisioningMsg = {
+    [PLUGIN_TYPES.app]: 'Set up provisioning for app',
+    [PLUGIN_TYPES.datasource]: 'Set up provisioning for data source instance',
+    [PLUGIN_TYPES.panel]: 'Set up provisioning for basic dashboard and TestData data source instance',
+    [PLUGIN_TYPES.scenes]: 'Set up provisioning for app and TestData data source instance',
+};

package/dist/constants.js

@@ -16,15 +16,13 @@ export const TEMPLATE_PATHS = {
     common: path.join(TEMPLATES_DIR, 'common'),
     datasource: path.join(TEMPLATES_DIR, 'datasource'),
     panel: path.join(TEMPLATES_DIR, 'panel'),
-    ciWorkflows: path.join(TEMPLATES_DIR, '.github'),
-    isCompatibleWorkflow: path.join(TEMPLATES_DIR, 'github', 'is-compatible'),
+    ciWorkflows: path.join(TEMPLATES_DIR, 'github'),
 };
 export var PLUGIN_TYPES;
 (function (PLUGIN_TYPES) {
     PLUGIN_TYPES["app"] = "app";
     PLUGIN_TYPES["panel"] = "panel";
     PLUGIN_TYPES["datasource"] = "datasource";
-    PLUGIN_TYPES["secretsmanager"] = "secretsmanager";
     PLUGIN_TYPES["scenes"] = "scenesapp";
 })(PLUGIN_TYPES || (PLUGIN_TYPES = {}));
 export const EXTRA_TEMPLATE_VARIABLES = {

package/dist/utils/utils.prettifyFiles.js

@@ -20,7 +20,7 @@ export async function prettifyFiles(options) {
     catch (error) {
         throw new Error('There was a problem running prettier on the plugin files. Please run `npx -y prettier@2 . --write` manually in your plugin directory.');
     }
-    return 'Successfully ran prettier against new plugin.';
+    return '';
 }
 function isPrettierUsed(projectRoot) {
     return Boolean(getPrettierVersion(projectRoot));

package/dist/utils/utils.templates.js

@@ -12,7 +12,7 @@ import { getPackageManagerInstallCmd, getPackageManagerWithFallback, getPackageM
 import { getExportFileName } from '../utils/utils.files.js';
 import { getGrafanaRuntimeVersion, getVersion } from './utils.version.js';
 import { getConfig } from './utils.config.js';
-const debug = createDebug('templates');
+const debug = createDebug('create-plugin:templates');
 export function getTemplateFiles(pluginType, filter) {
     const commonFiles = glob.sync(`${TEMPLATE_PATHS.common}/**`, { dot: true });
     const pluginTypeSpecificFiles = glob.sync(`${TEMPLATE_PATHS[pluginType]}/**`, { dot: true });
@@ -73,7 +73,6 @@ export function getTemplateData(cliArgs) {
             ...EXTRA_TEMPLATE_VARIABLES,
             pluginId: normalizeId(cliArgs.pluginName, cliArgs.orgName, cliArgs.pluginType),
             pluginName: cliArgs.pluginName,
-            pluginDescription: cliArgs.pluginDescription,
             hasBackend: cliArgs.hasBackend,
             orgName: cliArgs.orgName,
             pluginType: cliArgs.pluginType,
@@ -97,7 +96,6 @@ export function getTemplateData(cliArgs) {
             ...EXTRA_TEMPLATE_VARIABLES,
             pluginId: pluginJson.id,
             pluginName: pluginJson.name,
-            pluginDescription: pluginJson.info.description,
             hasBackend: pluginJson.backend,
             orgName: pluginJson.info.author.name,
             pluginType: pluginJson.type,

package/fixtures/test-template/src/plugin.json

@@ -6,7 +6,7 @@
   "backend": true,
   "executable": "gpx_{{ snakeCase pluginName }}",
   "info": {
-    "description": "{{ sentenceCase pluginDescription }}",
+    "description": "",
     "author": {
       "name": "{{ sentenceCase orgName }}"
     },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/create-plugin",
-  "version": "5.0.0-canary.1018.f88ab25.0",
+  "version": "5.0.0",
   "repository": {
     "directory": "packages/create-plugin",
     "url": "https://github.com/grafana/plugin-tools"
@@ -28,12 +28,12 @@
     "dev-scenes-app": "nodemon --exec 'npm run generate-scenes-app'",
     "dev-panel": "nodemon --exec 'npm run generate-panel'",
     "dev-datasource": "nodemon --exec 'npm run generate-datasource'",
-    "generate-app": "tsc && npm run clean-generated && CREATE_PLUGIN_DEV=true node ./dist/bin/run.js --pluginName='Sample app' --orgName='sample-org' --pluginDescription='This is a sample app.' --pluginType='app' --no-hasBackend",
-    "generate-scenes-app": "tsc && npm run clean-generated && CREATE_PLUGIN_DEV=true node ./dist/bin/run.js --pluginName='Sample scenesapp' --orgName='sample-org' --pluginDescription='This is a sample scenes app.' --pluginType='scenesapp' --no-hasBackend",
-    "generate-app-backend": "tsc && npm run clean-generated && CREATE_PLUGIN_DEV=true node ./dist/bin/run.js --pluginName='Sample app' --orgName='sample-org' --pluginDescription='This is a sample backend app.' --pluginType='app' --hasBackend",
-    "generate-panel": "tsc && npm run clean-generated && CREATE_PLUGIN_DEV=true node ./dist/bin/run.js --pluginName='Sample panel' --orgName='sample-org' --pluginDescription='This is a sample panel.' --pluginType='panel'",
-    "generate-datasource": "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' --no-hasBackend",
-    "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",
+    "generate-app": "tsc && npm run clean-generated && CREATE_PLUGIN_DEV=true node ./dist/bin/run.js --pluginName='Sample app' --orgName='sample-org' --pluginType='app' --no-hasBackend",
+    "generate-scenes-app": "tsc && npm run clean-generated && CREATE_PLUGIN_DEV=true node ./dist/bin/run.js --pluginName='Sample scenesapp' --orgName='sample-org' --pluginType='scenesapp' --no-hasBackend",
+    "generate-app-backend": "tsc && npm run clean-generated && CREATE_PLUGIN_DEV=true node ./dist/bin/run.js --pluginName='Sample app' --orgName='sample-org' --pluginType='app' --hasBackend",
+    "generate-panel": "tsc && npm run clean-generated && CREATE_PLUGIN_DEV=true node ./dist/bin/run.js --pluginName='Sample panel' --orgName='sample-org' --pluginType='panel'",
+    "generate-datasource": "tsc && npm run clean-generated && CREATE_PLUGIN_DEV=true node ./dist/bin/run.js --pluginName='Sample datasource' --orgName='sample-org' --pluginType='datasource' --no-hasBackend",
+    "generate-datasource-backend": "tsc && npm run clean-generated && CREATE_PLUGIN_DEV=true node ./dist/bin/run.js --pluginName='Sample datasource' --orgName='sample-org' --pluginType='datasource' --hasBackend",
     "lint": "eslint --cache --ext .js,.jsx,.ts,.tsx ./src",
     "lint:fix": "npm run lint -- --fix",
     "test": "vitest",
@@ -87,5 +87,5 @@
   "engines": {
     "node": ">=20"
   },
-  "gitHead": "f88ab256aaf0f053f7536d3033f564d8f34566f5"
+  "gitHead": "56c4ac2b94ab9d83be84be4379a90751359fe66e"
 }

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

@@ -1,11 +1,13 @@
+import { machine } from 'node:os';
+import { TemplateData } from '../../types.js';
 import { displayAsMarkdown } from '../../utils/utils.console.js';
 import { normalizeId } from '../../utils/utils.handlebars.js';
 import { getPackageManagerFromUserAgent } from '../../utils/utils.packageManager.js';
-import { TemplateData } from '../../types.js';
 
 export function printGenerateSuccessMessage(answers: TemplateData) {
   const directory = normalizeId(answers.pluginName, answers.orgName, answers.pluginType);
   const { packageManagerName } = getPackageManagerFromUserAgent();
+
   const commands = [
     `- \`cd ./${directory}\``,
     `- \`${packageManagerName} install\` to install frontend dependencies.`,
@@ -13,7 +15,7 @@ export function printGenerateSuccessMessage(answers: TemplateData) {
     `- \`${packageManagerName} run dev\` to build (and watch) the plugin frontend code.`,
     ...(answers.hasBackend
       ? [
-          '- `mage -v build:backend` to build the plugin backend code. Rerun this command every time you edit your backend files.',
+          `- ${getBackendCmd()} to build the plugin backend code. Rerun this command every time you edit your backend files.`,
         ]
       : []),
     '- `docker-compose up` to start a grafana development server.',
@@ -34,3 +36,12 @@ _Note: We strongly recommend creating a new Git repository by running \`git init
 
   console.log(displayAsMarkdown(msg));
 }
+
+function getBackendCmd() {
+  const platform = machine();
+  if (platform === 'arm64') {
+    return '`mage -v build:linuxARM64`';
+  }
+
+  return '`mage -v build:linux`';
+}

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

@@ -7,16 +7,16 @@ export async function promptUser(argv: minimist.ParsedArgs) {
   let answers: Partial<GenerateCliArgs> = {};
   const enquirer = new Enquirer();
 
-  for (const prompt of prompts) {
-    const { name, shouldPrompt } = prompt(answers);
+  for (const p of prompts) {
+    const prompt = p(answers);
 
-    if (argv.hasOwnProperty(name)) {
-      answers = { ...answers, [name]: argv[name] };
+    if (argv.hasOwnProperty(prompt.name)) {
+      answers = { ...answers, [prompt.name]: argv[prompt.name] };
     } else {
-      if (typeof shouldPrompt === 'function' && !shouldPrompt(answers)) {
+      if (typeof prompt.shouldPrompt === 'function' && !prompt.shouldPrompt(answers)) {
         continue;
       } else {
-        const result = await enquirer.prompt(prompt(answers));
+        const result = await enquirer.prompt(prompt);
         answers = { ...answers, ...result };
       }
     }
@@ -36,7 +36,7 @@ type Prompt = {
 };
 
 type Choice = {
-  name: string;
+  name?: string;
   message?: string;
   value?: unknown;
   hint?: string;
@@ -51,34 +51,38 @@ const prompts: Array<(answers: Partial<GenerateCliArgs>) => Prompt> = [
     type: 'select',
     choices: [
       {
-        name: 'App (Custom pages, UI Extensions and bundling other plugins)',
+        message: 'App (add custom pages, UI extensions and bundle other plugins)',
         value: PLUGIN_TYPES.app,
       },
       {
-        name: 'Data source (Query data from a custom source)',
+        message: 'Data source (query data from a custom source)',
         value: PLUGIN_TYPES.datasource,
       },
       {
-        name: 'Panel (New visualization for data or a widget)',
+        message: 'Panel (add a visualization for data or a widget)',
         value: PLUGIN_TYPES.panel,
       },
       {
-        name: 'App with Scenes (Create dynamic dashboards in app pages)',
+        message: 'App with Scenes (create dynamic dashboards in app pages)',
         value: PLUGIN_TYPES.scenes,
       },
     ],
-    message: 'Select plugin type',
-  }),
-  (answers) => ({
-    name: 'hasBackend',
-    type: 'confirm',
-    message:
-      answers.pluginType === PLUGIN_TYPES.app
-        ? 'Does your plugin require a backend to support server-side functionality (e.g. calling external APIs, custom backend logic, advanced authentication, etc)?'
-        : 'Does your plugin require a backend to support server-side functionality (e.g. alerting, advanced authentication, public dashboards, etc)?',
-    initial: false,
-    shouldPrompt: (answers) => answers.pluginType !== PLUGIN_TYPES.panel,
+    message: 'Select a plugin type',
   }),
+  (answers) => {
+    const isAppType = answers.pluginType === PLUGIN_TYPES.app || answers.pluginType === PLUGIN_TYPES.scenes;
+    const message = isAppType
+      ? 'Add a backend to support server-side functionality? (calling external APIs, custom backend logic, advanced authentication, etc)'
+      : 'Add a backend to support server-side functionality? (alerting, advanced authentication, public dashboards, etc)';
+
+    return {
+      name: 'hasBackend',
+      type: 'confirm',
+      message: message,
+      initial: false,
+      shouldPrompt: (answers) => answers.pluginType !== PLUGIN_TYPES.panel,
+    };
+  },
   () => ({
     name: 'pluginName',
     type: 'input',
@@ -101,10 +105,4 @@ const prompts: Array<(answers: Partial<GenerateCliArgs>) => Prompt> = [
       return 'Organization name is required';
     },
   }),
-  () => ({
-    name: 'pluginDescription',
-    type: 'input',
-    message: 'How would you describe your plugin?',
-    initial: '',
-  }),
 ];

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

@@ -1,9 +1,12 @@
 import which from 'which';
 import fs from 'node:fs';
+import createDebug from 'debug';
 import { exec } from 'node:child_process';
 
 const SDK_GO_MODULE = 'github.com/grafana/grafana-plugin-sdk-go';
 
+const debug = createDebug('create-plugin:update-go');
+
 export async function updateGoSdkAndModules(exportPath: string) {
   // check if there is a go.mod file in exportPath
   const goModPath = `${exportPath}/go.mod`;
@@ -20,14 +23,15 @@ export async function updateGoSdkAndModules(exportPath: string) {
   }
 
   try {
+    const version = await getLatestSdkVersion(exportPath);
     await updateSdk(exportPath);
     await updateGoMod(exportPath);
+    return `Updated Grafana go sdk to ${version} (latest)`;
   } catch {
     throw new Error(
       'There was an error trying to update the grafana go sdk. Please run `go get github.com/grafana/grafana-plugin-sdk-go` manually in your plugin directory.'
     );
   }
-  return 'Grafana go sdk updated successfully.';
 }
 
 function updateSdk(exportPath: string): Promise<void> {
@@ -36,6 +40,7 @@ function updateSdk(exportPath: string): Promise<void> {
     const command = `go get ${SDK_GO_MODULE}`;
     exec(command, { cwd: exportPath }, (error) => {
       if (error) {
+        debug(error);
         reject();
       }
       resolve();
@@ -49,9 +54,25 @@ function updateGoMod(exportPath: string): Promise<void> {
     const command = `go mod tidy`;
     exec(command, { cwd: exportPath }, (error) => {
       if (error) {
+        debug(error);
         reject();
       }
       resolve();
     });
   });
 }
+
+function getLatestSdkVersion(exportPath: string): Promise<string> {
+  return new Promise(async (resolve, reject) => {
+    // run go list SDK_GO_MODULE@latest to get the latest version number
+    const command = `go list -m -json ${SDK_GO_MODULE}@latest`;
+    exec(command, { cwd: exportPath }, (error, stdout) => {
+      if (error) {
+        debug(error);
+        reject();
+      }
+      const version = JSON.parse(stdout).Version;
+      resolve(version);
+    });
+  });
+}

package/src/commands/generate.command.ts

@@ -3,7 +3,7 @@ import minimist from 'minimist';
 import chalk from 'chalk';
 import { mkdir, readdir, writeFile } from 'node:fs/promises';
 import path from 'node:path';
-import { EXTRA_TEMPLATE_VARIABLES, IS_DEV, TEMPLATE_PATHS } from '../constants.js';
+import { EXTRA_TEMPLATE_VARIABLES, IS_DEV, PLUGIN_TYPES, TEMPLATE_PATHS } from '../constants.js';
 import { printError } from '../utils/utils.console.js';
 import { directoryExists, getExportFileName, isFile } from '../utils/utils.files.js';
 import { getExportPath } from '../utils/utils.path.js';
@@ -28,10 +28,19 @@ export const generate = async (argv: minimist.ParsedArgs) => {
   }
 
   const actions = getTemplateActions({ templateData, exportPath });
-  const { changes, failures } = await generateFiles({ actions });
-
+  const failures = await generateFiles({ actions });
+  const changes = [
+    `Scaffolded ${templateData.pluginId} ${templateData.pluginType} plugin ${
+      templateData.hasBackend ? '(with Go backend)' : ''
+    }`,
+    'Added basic E2E test (Playwright)',
+    `${provisioningMsg[templateData.pluginType]}`,
+    'Configured development environment (Docker)',
+    'Added default GitHub actions for CI, releases and Grafana compatibility',
+  ];
+  console.log('');
   changes.forEach((change) => {
-    console.log(`${chalk.green('✔︎ ++')} ${change.path}`);
+    console.log(`${chalk.green('✔︎')} ${change}`);
   });
 
   failures.forEach((failure) => {
@@ -42,7 +51,7 @@ export const generate = async (argv: minimist.ParsedArgs) => {
     await execPostScaffoldFunction(updateGoSdkAndModules, exportPath);
   }
   await execPostScaffoldFunction(prettifyFiles, { targetPath: exportPath });
-
+  console.log('\n');
   printGenerateSuccessMessage(templateData);
 };
 
@@ -91,7 +100,7 @@ function getTemplateActions({ exportPath, templateData }: { exportPath: string;
   // Copy over Github workflow files
   const ciWorkflowActions = getActionsForTemplateFolder({
     folderPath: TEMPLATE_PATHS.ciWorkflows,
-    exportPath,
+    exportPath: path.join(exportPath, '.github'),
     templateData,
   });
 
@@ -131,7 +140,6 @@ function getActionsForTemplateFolder({
 
 async function generateFiles({ actions }: { actions: any[] }) {
   const failures = [];
-  const changes = [];
   for (const action of actions) {
     try {
       const rootDir = path.dirname(action.path);
@@ -142,9 +150,6 @@ async function generateFiles({ actions }: { actions: any[] }) {
 
       const rendered = renderTemplateFromFile(action.templateFile, action.data);
       await writeFile(action.path, rendered);
-      changes.push({
-        path: action.path,
-      });
     } catch (error) {
       let message;
       if (error instanceof Error) {
@@ -158,7 +163,7 @@ async function generateFiles({ actions }: { actions: any[] }) {
       });
     }
   }
-  return { failures, changes };
+  return failures;
 }
 
 type AsyncFunction<T> = (...args: any[]) => Promise<T>;
@@ -173,3 +178,10 @@ async function execPostScaffoldFunction<T>(fn: AsyncFunction<T>, ...args: Parame
     printError(`${error}`);
   }
 }
+
+const provisioningMsg = {
+  [PLUGIN_TYPES.app]: 'Set up provisioning for app',
+  [PLUGIN_TYPES.datasource]: 'Set up provisioning for data source instance',
+  [PLUGIN_TYPES.panel]: 'Set up provisioning for basic dashboard and TestData data source instance',
+  [PLUGIN_TYPES.scenes]: 'Set up provisioning for app and TestData data source instance',
+};

package/src/constants.ts

@@ -27,15 +27,15 @@ export const TEMPLATE_PATHS: Record<string, string> = {
   common: path.join(TEMPLATES_DIR, 'common'),
   datasource: path.join(TEMPLATES_DIR, 'datasource'),
   panel: path.join(TEMPLATES_DIR, 'panel'),
-  ciWorkflows: path.join(TEMPLATES_DIR, '.github'),
-  isCompatibleWorkflow: path.join(TEMPLATES_DIR, 'github', 'is-compatible'),
+  ciWorkflows: path.join(TEMPLATES_DIR, 'github'),
 };
 
 export enum PLUGIN_TYPES {
   app = 'app',
   panel = 'panel',
   datasource = 'datasource',
-  secretsmanager = 'secretsmanager',
+  // TODO: Don't understand why this is here. Cannot create a secretsmanager or a renderer.
+  // secretsmanager = 'secretsmanager',
   scenes = 'scenesapp',
 }
 

package/src/types.ts

@@ -4,7 +4,6 @@ import { PLUGIN_TYPES } from './constants.js';
 // (Either via user prompts or CLI arguments)
 export type GenerateCliArgs = {
   pluginName: string;
-  pluginDescription: string;
   orgName: string;
   pluginType: PLUGIN_TYPES;
   hasBackend: boolean;
@@ -13,7 +12,6 @@ export type GenerateCliArgs = {
 export type TemplateData = {
   pluginId: string;
   pluginName: string;
-  pluginDescription: string;
   hasBackend: boolean;
   orgName: string;
   pluginType: PLUGIN_TYPES;

package/src/utils/utils.prettifyFiles.ts

@@ -35,7 +35,7 @@ export async function prettifyFiles(options: PrettifyFilesArgs) {
       'There was a problem running prettier on the plugin files. Please run `npx -y prettier@2 . --write` manually in your plugin directory.'
     );
   }
-  return 'Successfully ran prettier against new plugin.';
+  return '';
 }
 
 function isPrettierUsed(projectRoot?: string) {

package/src/utils/utils.templates.ts

@@ -24,7 +24,7 @@ import { getExportFileName } from '../utils/utils.files.js';
 import { getGrafanaRuntimeVersion, getVersion } from './utils.version.js';
 import { getConfig } from './utils.config.js';
 
-const debug = createDebug('templates');
+const debug = createDebug('create-plugin:templates');
 
 /**
  *
@@ -118,7 +118,6 @@ export function getTemplateData(cliArgs?: GenerateCliArgs): TemplateData {
       ...EXTRA_TEMPLATE_VARIABLES,
       pluginId: normalizeId(cliArgs.pluginName, cliArgs.orgName, cliArgs.pluginType),
       pluginName: cliArgs.pluginName,
-      pluginDescription: cliArgs.pluginDescription,
       hasBackend: cliArgs.hasBackend,
       orgName: cliArgs.orgName,
       pluginType: cliArgs.pluginType,
@@ -144,7 +143,6 @@ export function getTemplateData(cliArgs?: GenerateCliArgs): TemplateData {
       ...EXTRA_TEMPLATE_VARIABLES,
       pluginId: pluginJson.id,
       pluginName: pluginJson.name,
-      pluginDescription: pluginJson.info.description,
       hasBackend: pluginJson.backend,
       orgName: pluginJson.info.author.name,
       pluginType: pluginJson.type,

package/templates/app/src/plugin.json

@@ -7,7 +7,7 @@
   "executable": "gpx_{{ snakeCase pluginName }}",{{/if}}
   "info": {
     "keywords": ["app"],
-    "description": "{{ sentenceCase pluginDescription }}",
+    "description": "",
     "author": {
       "name": "{{ sentenceCase orgName }}"
     },

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

@@ -8,18 +8,30 @@
 import CopyWebpackPlugin from 'copy-webpack-plugin';
 import ESLintPlugin from 'eslint-webpack-plugin';
 import ForkTsCheckerWebpackPlugin from 'fork-ts-checker-webpack-plugin';
-import LiveReloadPlugin from 'webpack-livereload-plugin';
 import path from 'path';
 import ReplaceInFileWebpackPlugin from 'replace-in-file-webpack-plugin';
 import TerserPlugin from 'terser-webpack-plugin';
 import { type Configuration, BannerPlugin } from 'webpack';
+import LiveReloadPlugin from 'webpack-livereload-plugin';
+import VirtualModulesPlugin from 'webpack-virtual-modules';
 
-import { getPackageJson, getPluginJson, hasReadme, getEntries, isWSL, getCPConfigVersion } from './utils';
-import { SOURCE_DIR, DIST_DIR } from './constants';
+import { DIST_DIR, SOURCE_DIR } from './constants';
+import { getCPConfigVersion, getEntries, getPackageJson, getPluginJson, hasReadme, isWSL } from './utils';
 
 const pluginJson = getPluginJson();
 const cpVersion = getCPConfigVersion();
 
+const virtualPublicPath = new VirtualModulesPlugin({
+  'node_modules/grafana-public-path.js': `
+import amdMetaModule from 'amd-module';
+
+__webpack_public_path__ =
+  amdMetaModule && amdMetaModule.uri
+    ? amdMetaModule.uri.slice(0, amdMetaModule.uri.lastIndexOf('/') + 1)
+    : 'public/plugins/${pluginJson.id}/';
+`,
+});
+
 const config = async (env): Promise<Configuration> => {
   const baseConfig: Configuration = {
     cache: {
@@ -112,7 +124,7 @@ const config = async (env): Promise<Configuration> => {
             {
               loader: 'imports-loader',
               options: {
-                imports: `side-effects ${path.join(__dirname, 'publicPath.ts')}`,
+                imports: `side-effects grafana-public-path`,
               },
             },
           ],
@@ -169,6 +181,7 @@ const config = async (env): Promise<Configuration> => {
     },
 
     plugins: [
+      virtualPublicPath,
       // Insert create plugin version information into the bundle
       new BannerPlugin({
         banner: "/* [create-plugin] version: " + cpVersion + " */",

package/templates/common/_package.json

@@ -1,7 +1,6 @@
 {
   "name": "{{ kebabCase pluginName }}",
   "version": "1.0.0",
-  "description": "{{ sentenceCase pluginDescription }}",
   "scripts": {
     "build": "webpack -c ./.config/webpack/webpack.config.ts --env production",
     "dev": "webpack -w -c ./.config/webpack/webpack.config.ts --env development",
@@ -57,7 +56,8 @@
     "typescript": "4.8.4",
     "webpack": "^5.86.0",
     "webpack-cli": "^5.1.4",
-    "webpack-livereload-plugin": "^3.0.2"
+    "webpack-livereload-plugin": "^3.0.2",
+    "webpack-virtual-modules": "^0.6.2"
   },
   "engines": {
     "node": ">=20"

package/templates/common/src/README.md

@@ -3,19 +3,17 @@
 Remove any remaining comments before publishing as these may be displayed on Grafana.com -->
 # {{ titleCase pluginName }}
 
-{{ sentenceCase pluginDescription }}
-
 <!-- To help maximize the impact of your README and improve usability for users, we propose the following loose structure:
 
 **BEFORE YOU BEGIN**
 - Ensure all links are absolute URLs so that they will work when the README is displayed within Grafana and Grafana.com
-- Be inspired ✨ 
+- Be inspired ✨
   - [grafana-polystat-panel](https://github.com/grafana/grafana-polystat-panel)
   - [volkovlabs-variable-panel](https://github.com/volkovlabs/volkovlabs-variable-panel)
 
 **ADD SOME BADGES**
 
-Badges convey useful information at a glance for users whether in the Catalog or viewing the source code. You can use the generator on [Shields.io](https://shields.io/badges/dynamic-json-badge) together with the Grafana.com API 
+Badges convey useful information at a glance for users whether in the Catalog or viewing the source code. You can use the generator on [Shields.io](https://shields.io/badges/dynamic-json-badge) together with the Grafana.com API
 to create dynamic badges that update automatically when you publish a new version to the marketplace.
 
 - For the logo field use 'grafana'.
@@ -30,7 +28,7 @@ Full example: ![Dynamic JSON Badge](https://img.shields.io/badge/dynamic/json?lo
 Consider other [badges](https://shields.io/badges) as you feel appropriate for your project.
 
 ## Overview / Introduction
-Provide one or more paragraphs as an introduction to your plugin to help users understand why they should use it.  
+Provide one or more paragraphs as an introduction to your plugin to help users understand why they should use it.
 
 Consider including screenshots:
 - in [plugin.json](https://grafana.com/developers/plugin-tools/reference/plugin-json#info) include them as relative links.
@@ -47,4 +45,4 @@ If your project has dedicated documentation available for users, provide links h
 
 ## Contributing
 Do you want folks to contribute to the plugin or provide feedback through specific means? If so, tell them how!
--->
+-->

package/templates/datasource/src/plugin.json

@@ -7,7 +7,7 @@
   "backend": true,
   "executable": "gpx_{{ snakeCase pluginName }}",{{/if}}
   "info": {
-    "description": "{{ sentenceCase pluginDescription }}",
+    "description": "",
     "author": {
       "name": "{{ sentenceCase orgName }}"
     },

package/templates/panel/src/plugin.json

@@ -5,7 +5,7 @@
   "id": "{{ pluginId }}",
   "info": {
     "keywords": ["panel"],
-    "description": "{{ sentenceCase pluginDescription }}",
+    "description": "",
     "author": {
       "name": "{{ sentenceCase orgName }}"
     },

package/templates/scenes-app/src/plugin.json

@@ -9,7 +9,7 @@
     "keywords": [
       "app"
     ],
-    "description": "{{ sentenceCase pluginDescription }}",
+    "description": "",
     "author": {
       "name": "{{ sentenceCase orgName }}"
     },

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

@@ -1,17 +0,0 @@
-/*
- * ⚠️⚠️⚠️ THIS FILE WAS SCAFFOLDED BY `@grafana/create-plugin`. DO NOT EDIT THIS FILE DIRECTLY. ⚠️⚠️⚠️
- *
- * This file dynamically sets the public path at runtime based on the location of the plugin's AMD module.
- * It relies on the magic `module` which is defined by the AMD loader.
- * https://github.com/requirejs/requirejs/wiki/Differences-between-the-simplified-CommonJS-wrapper-and-standard-AMD-define#module
- *
- * We fallback to the plugin root so that older versions of Grafana will continue to load the plugin correctly.
- */
-
-// @ts-nocheck
-import amdMetaModule from 'amd-module';
-
-__webpack_public_path__ =
-  amdMetaModule && amdMetaModule.uri
-    ? amdMetaModule.uri.slice(0, amdMetaModule.uri.lastIndexOf('/') + 1)
-    : 'public/plugins/{{ pluginId }}/';