@grafana/create-plugin 4.0.0 → 4.0.1-canary.746.8a86e72.0

package/dist/bin/run.js

@@ -1,13 +1,11 @@
 #!/usr/bin/env node
-import minimist from 'minimist';
 import { generate, update, migrate, version, provisioning } from '../commands/index.js';
 import { isUnsupportedPlatform } from '../utils/utils.os.js';
+import { argv, commandName } from '../utils/utils.cli.js';
 if (isUnsupportedPlatform()) {
     console.error("Unsupported operating system 'Windows' detected. Please use WSL with create-plugin. For more info visit: https://grafana.com/developers/plugin-tools/troubleshooting#i-am-getting-unsupported-operating-system-windows-detected-please-use-wsl-with-create-plugin");
     process.exit(1);
 }
-const args = process.argv.slice(2);
-const argv = minimist(args, { alias: { f: 'force' } });
 const commands = {
     migrate,
     generate,
@@ -15,5 +13,5 @@ const commands = {
     version,
     provisioning,
 };
-const command = commands[argv._[0]] || commands.generate;
+const command = commands[commandName] || 'generate';
 command(argv);

package/dist/types.js

@@ -0,0 +1 @@
+export {};

package/dist/utils/utils.cli.js

@@ -0,0 +1,4 @@
+import minimist from 'minimist';
+export const args = process.argv.slice(2);
+export const argv = minimist(args, { alias: { f: 'force' } });
+export const commandName = argv._[0] || 'generate';

package/dist/utils/utils.config.js

@@ -1,25 +1,43 @@
 import fs from 'node:fs';
 import path from 'node:path';
 import { getVersion } from './utils.version.js';
+import { commandName } from './utils.cli.js';
 export function getConfig() {
+    const rootConfig = getRootConfig();
+    const userConfig = getUserConfig();
+    return {
+        ...rootConfig,
+        ...userConfig,
+        version: rootConfig.version,
+        features: createFeatureFlags({
+            ...rootConfig.features,
+            ...userConfig.features,
+        }),
+    };
+}
+function getRootConfig() {
+    const defaultConfig = {
+        version: getVersion(),
+        features: createFeatureFlags(),
+    };
     try {
         const rootPath = path.resolve(process.cwd(), '.config/.cprc.json');
         const rootConfig = readRCFileSync(rootPath);
-        const userConfig = getUserConfig();
         return {
-            ...rootConfig,
-            ...userConfig,
-            version: rootConfig.version,
-            features: createFeatureFlags({
+            ...defaultConfig,
+            features: {
+                ...defaultConfig.features,
                 ...rootConfig.features,
-                ...userConfig.features,
-            }),
+            },
         };
     }
     catch (error) {
+        if (commandName === 'generate') {
+            return defaultConfig;
+        }
         return {
-            version: getVersion(),
-            features: createFeatureFlags(),
+            ...defaultConfig,
+            features: createDisabledFeatureFlags(),
         };
     }
 }
@@ -35,8 +53,13 @@ function getUserConfig() {
         };
     }
     catch (error) {
+        if (commandName === 'generate') {
+            return {
+                features: createFeatureFlags(),
+            };
+        }
         return {
-            features: createFeatureFlags(),
+            features: createDisabledFeatureFlags(),
         };
     }
 }
@@ -56,3 +79,9 @@ function createFeatureFlags(flags) {
         ...flags,
     };
 }
+function createDisabledFeatureFlags() {
+    return {
+        useReactRouterV6: false,
+        bundleGrafanaUI: false,
+    };
+}

package/dist/utils/utils.templates.js

@@ -2,14 +2,16 @@ import glob from 'glob';
 import path from 'node:path';
 import fs from 'node:fs';
 import mkdirp from 'mkdirp';
+import createDebug from 'debug';
 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, PLUGIN_TYPES } from '../constants.js';
-import { getPackageManagerWithFallback } from './utils.packageManager.js';
+import { getPackageManagerInstallCmd, getPackageManagerWithFallback } from './utils.packageManager.js';
 import { getExportFileName } from '../utils/utils.files.js';
 import { getVersion } from './utils.version.js';
 import { getConfig } from './utils.config.js';
+const debug = createDebug('templates');
 export function getTemplateFiles(pluginType, filter) {
     const commonFiles = glob.sync(`${TEMPLATE_PATHS.common}/**`, { dot: true });
     const pluginTypeSpecificFiles = glob.sync(`${TEMPLATE_PATHS[pluginType]}/**`, { dot: true });
@@ -56,8 +58,10 @@ export function getTemplateData() {
     const pluginJson = getPluginJson();
     const { features } = getConfig();
     const currentVersion = getVersion();
+    const useReactRouterV6 = features.useReactRouterV6 && pluginJson.type === PLUGIN_TYPES.app;
     const { packageManagerName, packageManagerVersion } = getPackageManagerWithFallback();
-    return {
+    const packageManagerInstallCmd = getPackageManagerInstallCmd(packageManagerName);
+    const templateData = {
         ...EXTRA_TEMPLATE_VARIABLES,
         pluginId: pluginJson.id,
         pluginName: pluginJson.name,
@@ -65,11 +69,16 @@ export function getTemplateData() {
         hasBackend: Boolean(pluginJson.backend),
         orgName: pluginJson.info?.author?.name,
         pluginType: pluginJson.type,
+        isAppType: pluginJson.type === PLUGIN_TYPES.app || pluginJson.type === PLUGIN_TYPES.scenes,
+        isNPM: packageManagerName === 'npm',
         packageManagerName,
         packageManagerVersion,
+        packageManagerInstallCmd,
         version: currentVersion,
         bundleGrafanaUI: features.bundleGrafanaUI,
-        useReactRouterV6: features.useReactRouterV6 && pluginJson.type === PLUGIN_TYPES.app,
-        reactRouterVersion: features.useReactRouterV6 ? '6.22.0' : '5.2.0',
+        useReactRouterV6: useReactRouterV6,
+        reactRouterVersion: useReactRouterV6 ? '6.22.0' : '5.2.0',
     };
+    debug('\nTemplate data:\n' + JSON.stringify(templateData, null, 2));
+    return templateData;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/create-plugin",
-  "version": "4.0.0",
+  "version": "4.0.1-canary.746.8a86e72.0",
   "repository": {
     "directory": "packages/create-plugin",
     "url": "https://github.com/grafana/plugin-tools"
@@ -48,6 +48,7 @@
     "boxen": "^7.1.1",
     "chalk": "^5.3.0",
     "change-case": "^5.4.0",
+    "debug": "^4.3.4",
     "enquirer": "^2.4.1",
     "find-up": "^5.0.0",
     "glob": "^7.1.7",
@@ -86,5 +87,5 @@
   "engines": {
     "node": ">=20"
   },
-  "gitHead": "92324b2132998a4d239118a61147fe4eecabd7bc"
+  "gitHead": "8a86e720cdec53c50202da391f38e9bf10737e61"
 }

package/src/bin/run.ts

@@ -3,6 +3,7 @@
 import minimist from 'minimist';
 import { generate, update, migrate, version, provisioning } from '../commands/index.js';
 import { isUnsupportedPlatform } from '../utils/utils.os.js';
+import { argv, commandName } from '../utils/utils.cli.js';
 
 // Exit early if operating system isn't supported.
 if (isUnsupportedPlatform()) {
@@ -12,8 +13,6 @@ if (isUnsupportedPlatform()) {
   process.exit(1);
 }
 
-const args = process.argv.slice(2);
-const argv = minimist(args, { alias: { f: 'force' } });
 const commands: Record<string, (argv: minimist.ParsedArgs) => void> = {
   migrate,
   generate,
@@ -21,6 +20,6 @@ const commands: Record<string, (argv: minimist.ParsedArgs) => void> = {
   version,
   provisioning,
 };
-const command = commands[argv._[0]] || commands.generate;
+const command = commands[commandName] || 'generate';
 
 command(argv);

package/src/commands/generate.command.ts

@@ -16,7 +16,7 @@ import { prettifyFiles } from '../utils/utils.prettifyFiles.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';
+import { CliArgs, TemplateData } from '../types.js';
 
 export const generate = async (argv: minimist.ParsedArgs) => {
   const answers = await promptUser(argv);
@@ -59,7 +59,7 @@ function getTemplateData(answers: CliArgs) {
   const { packageManagerName, packageManagerVersion } = getPackageManagerFromUserAgent();
   const packageManagerInstallCmd = getPackageManagerInstallCmd(packageManagerName);
   const isAppType = pluginType === PLUGIN_TYPES.app || pluginType === PLUGIN_TYPES.scenes;
-  const useReactRouterV6 = features.useReactRouterV6 && pluginType === PLUGIN_TYPES.app;
+  const useReactRouterV6 = features.useReactRouterV6 && pluginType === PLUGIN_TYPES.app; // We don't enable this by default yet for new scenes plugins.
   const templateData: TemplateData = {
     ...answers,
     pluginId,

package/src/types.ts

@@ -0,0 +1,24 @@
+import { PLUGIN_TYPES } from './constants.js';
+
+export type CliArgs = {
+  pluginName: string;
+  pluginDescription: string;
+  orgName: string;
+  pluginType: PLUGIN_TYPES;
+  hasBackend: boolean;
+  hasGithubWorkflows: boolean;
+  hasGithubLevitateWorkflow: boolean;
+};
+
+export type TemplateData = {
+  pluginId: string;
+  packageManagerName: string;
+  packageManagerInstallCmd: string;
+  packageManagerVersion: string;
+  isAppType: boolean;
+  isNPM: boolean;
+  version: string;
+  bundleGrafanaUI: boolean;
+  useReactRouterV6: boolean;
+  reactRouterVersion: string;
+};

package/src/utils/utils.cli.ts

@@ -0,0 +1,7 @@
+import minimist from 'minimist';
+
+export const args = process.argv.slice(2);
+
+export const argv = minimist(args, { alias: { f: 'force' } });
+
+export const commandName = argv._[0] || 'generate';

package/src/utils/utils.config.ts

@@ -1,6 +1,8 @@
 import fs from 'node:fs';
 import path from 'node:path';
 import { getVersion } from './utils.version.js';
+import { commandName } from './utils.cli.js';
+import { features } from 'node:process';
 
 type FeatureFlags = {
   bundleGrafanaUI: boolean;
@@ -19,24 +21,49 @@ type UserConfig = {
 };
 
 export function getConfig(): CreatePluginConfig {
+  const rootConfig = getRootConfig();
+  const userConfig = getUserConfig();
+
+  return {
+    ...rootConfig,
+    ...userConfig,
+    version: rootConfig!.version,
+    features: createFeatureFlags({
+      ...rootConfig!.features,
+      ...userConfig!.features,
+    }),
+  };
+}
+
+function getRootConfig(): CreatePluginConfig {
+  const defaultConfig = {
+    version: getVersion(),
+    features: createFeatureFlags(),
+  };
+
   try {
     const rootPath = path.resolve(process.cwd(), '.config/.cprc.json');
     const rootConfig = readRCFileSync(rootPath);
-    const userConfig = getUserConfig();
 
     return {
-      ...rootConfig,
-      ...userConfig,
-      version: rootConfig!.version,
-      features: createFeatureFlags({
+      ...defaultConfig,
+      features: {
+        ...defaultConfig.features,
         ...rootConfig!.features,
-        ...userConfig!.features,
-      }),
+      },
     };
+    // Most likely this happens because of no ".config/.cprc.json" (root configuration) file.
+    // (This can both happen for new scaffolds and for existing plugins that have not been updated yet.)
   } catch (error) {
+    // Scaffolding a new plugin
+    if (commandName === 'generate') {
+      return defaultConfig;
+    }
+
+    // Most probably updating an existing plugin
     return {
-      version: getVersion(),
-      features: createFeatureFlags(),
+      ...defaultConfig,
+      features: createDisabledFeatureFlags(),
     };
   }
 }
@@ -52,9 +79,19 @@ function getUserConfig(): UserConfig | undefined {
         ...userConfig!.features,
       }),
     };
+    // Most likely this happens because of no ".cprc.json" (user configuration) file.
+    // (This can both happen for new scaffolds and for existing plugins that have not been updated yet.)
   } catch (error) {
+    // Scaffolding a new plugin
+    if (commandName === 'generate') {
+      return {
+        features: createFeatureFlags(),
+      };
+    }
+
+    // Most probably updating an existing plugin
     return {
-      features: createFeatureFlags(),
+      features: createDisabledFeatureFlags(),
     };
   }
 }
@@ -69,9 +106,17 @@ function readRCFileSync(path: string): CreatePluginConfig | undefined {
 }
 
 function createFeatureFlags(flags?: FeatureFlags): FeatureFlags {
+  // Default values for new scaffoldings
   return {
     useReactRouterV6: true,
     bundleGrafanaUI: false,
     ...flags,
   };
 }
+
+function createDisabledFeatureFlags(): FeatureFlags {
+  return {
+    useReactRouterV6: false,
+    bundleGrafanaUI: false,
+  };
+}

package/src/utils/utils.templates.ts

@@ -2,15 +2,19 @@ import glob from 'glob';
 import path from 'node:path';
 import fs from 'node:fs';
 import mkdirp from 'mkdirp';
+import createDebug from 'debug';
 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, PLUGIN_TYPES } from '../constants.js';
-import { getPackageManagerWithFallback } from './utils.packageManager.js';
+import { TemplateData } from '../types.js';
+import { getPackageManagerInstallCmd, getPackageManagerWithFallback } from './utils.packageManager.js';
 import { getExportFileName } from '../utils/utils.files.js';
 import { getVersion } from './utils.version.js';
 import { getConfig } from './utils.config.js';
 
+const debug = createDebug('templates');
+
 /**
  *
  * @param pluginType - The type of the plugin to get template files for (plugin-specific templates override the common ones)
@@ -78,14 +82,15 @@ export function renderTemplateFromFile(templateFile: string, data?: any) {
   return renderHandlebarsTemplate(fs.readFileSync(templateFile).toString(), data);
 }
 
-export function getTemplateData() {
+export function getTemplateData(): TemplateData {
   const pluginJson = getPluginJson();
   const { features } = getConfig();
   const currentVersion = getVersion();
-
+  const useReactRouterV6 = features.useReactRouterV6 && pluginJson.type === PLUGIN_TYPES.app;
   const { packageManagerName, packageManagerVersion } = getPackageManagerWithFallback();
+  const packageManagerInstallCmd = getPackageManagerInstallCmd(packageManagerName);
 
-  return {
+  const templateData = {
     ...EXTRA_TEMPLATE_VARIABLES,
     pluginId: pluginJson.id,
     pluginName: pluginJson.name,
@@ -93,11 +98,18 @@ export function getTemplateData() {
     hasBackend: Boolean(pluginJson.backend),
     orgName: pluginJson.info?.author?.name,
     pluginType: pluginJson.type,
+    isAppType: pluginJson.type === PLUGIN_TYPES.app || pluginJson.type === PLUGIN_TYPES.scenes,
+    isNPM: packageManagerName === 'npm',
     packageManagerName,
     packageManagerVersion,
+    packageManagerInstallCmd,
     version: currentVersion,
     bundleGrafanaUI: features.bundleGrafanaUI,
-    useReactRouterV6: features.useReactRouterV6 && pluginJson.type === PLUGIN_TYPES.app,
-    reactRouterVersion: features.useReactRouterV6 ? '6.22.0' : '5.2.0',
+    useReactRouterV6: useReactRouterV6,
+    reactRouterVersion: useReactRouterV6 ? '6.22.0' : '5.2.0',
   };
+
+  debug('\nTemplate data:\n' + JSON.stringify(templateData, null, 2));
+
+  return templateData;
 }