@grafana/create-plugin 5.0.0 → 5.1.0-canary.1030.f3736ae.0

package/dist/commands/generate.command.js

@@ -3,7 +3,7 @@ import chalk from 'chalk';
 import { mkdir, readdir, writeFile } from 'node:fs/promises';
 import path from 'node:path';
 import { EXTRA_TEMPLATE_VARIABLES, IS_DEV, PLUGIN_TYPES, TEMPLATE_PATHS } from '../constants.js';
-import { printError } from '../utils/utils.console.js';
+import { printError, printWarning } from '../utils/utils.console.js';
 import { directoryExists, getExportFileName, isFile } from '../utils/utils.files.js';
 import { getExportPath } from '../utils/utils.path.js';
 import { renderTemplateFromFile, getTemplateData } from '../utils/utils.templates.js';
@@ -21,6 +21,9 @@ export const generate = async (argv) => {
         printError(`**Aborting plugin scaffold. '${exportPath}' exists and contains files.**`);
         process.exit(1);
     }
+    if (answers.hasBackend && answers.pluginType === PLUGIN_TYPES.panel) {
+        printWarning(`Backend ignored as incompatible with plugin type: ${PLUGIN_TYPES.panel}.`);
+    }
     const actions = getTemplateActions({ templateData, exportPath });
     const failures = await generateFiles({ actions });
     const changes = [

package/dist/utils/utils.cli.js

@@ -1,4 +1,19 @@
 import minimist from 'minimist';
+import { printWarning } from './utils.console.js';
 export const args = process.argv.slice(2);
-export const argv = minimist(args, { alias: { f: 'force' } });
+export const argv = minimist(args, {
+    alias: {
+        f: 'force',
+        pluginType: 'plugin-type',
+        hasBackend: 'backend',
+        pluginName: 'plugin-name',
+        orgName: 'org-name',
+    },
+    boolean: ['force', 'hasBackend'],
+    string: ['pluginType', 'pluginName', 'orgName', 'feature-flags'],
+    unknown: (arg) => {
+        printWarning(`Ignoring unknown option: ${arg}.`);
+        return false;
+    },
+});
 export const commandName = argv._[0] || 'generate';

package/dist/utils/utils.console.js

@@ -24,6 +24,9 @@ export function printSuccessMessage(msg) {
 export function printError(error) {
     console.error(displayAsMarkdown(`\n❌ ${error}`));
 }
+export function printWarning(error) {
+    console.warn(displayAsMarkdown(`\n⚠️ ${error}`));
+}
 export async function confirmPrompt(message) {
     const question = await prompt({
         name: 'confirmPrompt',

package/dist/utils/utils.templates.js

@@ -73,7 +73,7 @@ export function getTemplateData(cliArgs) {
             ...EXTRA_TEMPLATE_VARIABLES,
             pluginId: normalizeId(cliArgs.pluginName, cliArgs.orgName, cliArgs.pluginType),
             pluginName: cliArgs.pluginName,
-            hasBackend: cliArgs.hasBackend,
+            hasBackend: cliArgs.pluginType !== PLUGIN_TYPES.panel && cliArgs.hasBackend,
             orgName: cliArgs.orgName,
             pluginType: cliArgs.pluginType,
             packageManagerName,

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/create-plugin",
-  "version": "5.0.0",
+  "version": "5.1.0-canary.1030.f3736ae.0",
   "repository": {
     "directory": "packages/create-plugin",
     "url": "https://github.com/grafana/plugin-tools"
@@ -87,5 +87,5 @@
   "engines": {
     "node": ">=20"
   },
-  "gitHead": "56c4ac2b94ab9d83be84be4379a90751359fe66e"
+  "gitHead": "f3736aeabe55a97fee65d72e197e0cd8440b1a3e"
 }

package/src/commands/generate.command.ts

@@ -4,7 +4,7 @@ import chalk from 'chalk';
 import { mkdir, readdir, writeFile } from 'node:fs/promises';
 import path from 'node:path';
 import { EXTRA_TEMPLATE_VARIABLES, IS_DEV, PLUGIN_TYPES, TEMPLATE_PATHS } from '../constants.js';
-import { printError } from '../utils/utils.console.js';
+import { printError, printWarning } from '../utils/utils.console.js';
 import { directoryExists, getExportFileName, isFile } from '../utils/utils.files.js';
 import { getExportPath } from '../utils/utils.path.js';
 import { renderTemplateFromFile, getTemplateData } from '../utils/utils.templates.js';
@@ -26,6 +26,10 @@ export const generate = async (argv: minimist.ParsedArgs) => {
     printError(`**Aborting plugin scaffold. '${exportPath}' exists and contains files.**`);
     process.exit(1);
   }
+  // This is only possible when a user passes both flags via the command line.
+  if (answers.hasBackend && answers.pluginType === PLUGIN_TYPES.panel) {
+    printWarning(`Backend ignored as incompatible with plugin type: ${PLUGIN_TYPES.panel}.`);
+  }
 
   const actions = getTemplateActions({ templateData, exportPath });
   const failures = await generateFiles({ actions });

package/src/utils/utils.cli.ts

@@ -1,7 +1,23 @@
 import minimist from 'minimist';
+import { printWarning } from './utils.console.js';
 
 export const args = process.argv.slice(2);
 
-export const argv = minimist(args, { alias: { f: 'force' } });
+export const argv = minimist(args, {
+  alias: {
+    f: 'force',
+    // these are aliased to make it easier to use but internally we always use the object keys
+    pluginType: 'plugin-type',
+    hasBackend: 'backend',
+    pluginName: 'plugin-name',
+    orgName: 'org-name',
+  },
+  boolean: ['force', 'hasBackend'],
+  string: ['pluginType', 'pluginName', 'orgName', 'feature-flags'],
+  unknown: (arg) => {
+    printWarning(`Ignoring unknown option: ${arg}.`);
+    return false;
+  },
+});
 
 export const commandName = argv._[0] || 'generate';

package/src/utils/utils.console.ts

@@ -32,6 +32,10 @@ export function printError(error: string) {
   console.error(displayAsMarkdown(`\n❌ ${error}`));
 }
 
+export function printWarning(error: string) {
+  console.warn(displayAsMarkdown(`\n⚠️ ${error}`));
+}
+
 export async function confirmPrompt(message: string): Promise<boolean> {
   const question: Record<string, boolean> = await prompt({
     name: 'confirmPrompt',

package/src/utils/utils.templates.ts

@@ -118,7 +118,8 @@ export function getTemplateData(cliArgs?: GenerateCliArgs): TemplateData {
       ...EXTRA_TEMPLATE_VARIABLES,
       pluginId: normalizeId(cliArgs.pluginName, cliArgs.orgName, cliArgs.pluginType),
       pluginName: cliArgs.pluginName,
-      hasBackend: cliArgs.hasBackend,
+      // check plugintype and hasBackend as they can both be passed via user input (cli args).
+      hasBackend: cliArgs.pluginType !== PLUGIN_TYPES.panel && cliArgs.hasBackend,
       orgName: cliArgs.orgName,
       pluginType: cliArgs.pluginType,
       packageManagerName,