@grafana/create-plugin 4.0.1 → 4.0.2-canary.754.d15fa36.0

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, PLUGIN_TYPES, TEMPLATE_PATHS } from '../constants.js';
+import { DEFAULT_FEATURE_FLAGS, 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';
@@ -47,7 +47,7 @@ function getTemplateData(answers) {
     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 === true && pluginType === PLUGIN_TYPES.app;
     const templateData = {
         ...answers,
         pluginId,
@@ -57,7 +57,7 @@ function getTemplateData(answers) {
         isAppType,
         isNPM: packageManagerName === 'npm',
         version: currentVersion,
-        bundleGrafanaUI: features.bundleGrafanaUI,
+        bundleGrafanaUI: features.bundleGrafanaUI ?? DEFAULT_FEATURE_FLAGS.bundleGrafanaUI,
         useReactRouterV6,
         reactRouterVersion: useReactRouterV6 ? '6.22.0' : '5.2.0',
     };

package/dist/constants.js

@@ -31,6 +31,10 @@ export const EXTRA_TEMPLATE_VARIABLES = {
     grafanaVersion: '10.0.3',
     grafanaImage: 'grafana-enterprise',
 };
+export const DEFAULT_FEATURE_FLAGS = {
+    useReactRouterV6: true,
+    bundleGrafanaUI: false,
+};
 export const GRAFANA_FE_PACKAGES = [
     '@grafana/data',
     '@grafana/e2e-selectors',

package/dist/utils/tests/utils.config.test.js

@@ -0,0 +1,94 @@
+import fs from 'fs/promises';
+import path from 'path';
+import { vi } from 'vitest';
+import os from 'os';
+import { getVersion } from '../utils.version.js';
+import { getConfig } from '../utils.config.js';
+import { DEFAULT_FEATURE_FLAGS } from '../../constants.js';
+const mocks = vi.hoisted(() => {
+    return {
+        commandName: 'generate',
+    };
+});
+vi.mock('../utils.cli.js', async () => mocks);
+const tmpDir = path.join(os.tmpdir(), 'cp-test-config');
+describe('getConfig', () => {
+    beforeEach(async () => {
+        await fs.mkdir(tmpDir, { recursive: true });
+    });
+    afterEach(async () => {
+        await fs.rm(tmpDir, { recursive: true, force: true });
+    });
+    describe('Command: Generate', () => {
+        beforeEach(() => {
+            mocks.commandName = 'generate';
+        });
+        it('should give back a default config', async () => {
+            const config = getConfig(tmpDir);
+            expect(config).toEqual({
+                version: getVersion(),
+                features: DEFAULT_FEATURE_FLAGS,
+            });
+        });
+    });
+    describe('Command: Update', () => {
+        beforeEach(() => {
+            mocks.commandName = 'update';
+        });
+        it('should give back the correct config when there are no config files at all', async () => {
+            const config = getConfig();
+            expect(config).toEqual({
+                version: getVersion(),
+                features: {},
+            });
+        });
+        it('should give back the correct config when there is no user config', async () => {
+            const rootConfigPath = path.join(tmpDir, '.config', '.cprc.json');
+            const rootConfig = {
+                version: '1.0.0',
+                features: {},
+            };
+            await fs.mkdir(path.dirname(rootConfigPath), { recursive: true });
+            await fs.writeFile(rootConfigPath, JSON.stringify(rootConfig));
+            const config = getConfig(tmpDir);
+            expect(config).toEqual({
+                version: rootConfig.version,
+                features: {},
+            });
+        });
+        it('should give back the correct config when there is no root config', async () => {
+            const userConfigPath = path.join(tmpDir, '.cprc.json');
+            const userConfig = {
+                features: {
+                    useReactRouterV6: true,
+                    bundleGrafanaUI: true,
+                },
+            };
+            await fs.writeFile(userConfigPath, JSON.stringify(userConfig));
+            const config = getConfig(tmpDir);
+            expect(config).toEqual({
+                version: getVersion(),
+                features: userConfig.features,
+            });
+        });
+        it('should give back the correct config when config files exist', async () => {
+            const rootConfigPath = path.join(tmpDir, '.config', '.cprc.json');
+            const userConfigPath = path.join(tmpDir, '.cprc.json');
+            const rootConfig = {
+                version: '1.0.0',
+                features: {},
+            };
+            const userConfig = {
+                features: {
+                    useReactRouterV6: false,
+                    bundleGrafanaUI: false,
+                },
+            };
+            await fs.mkdir(path.dirname(rootConfigPath), { recursive: true });
+            await fs.writeFile(rootConfigPath, JSON.stringify(rootConfig));
+            await fs.writeFile(userConfigPath, JSON.stringify(userConfig));
+            const config = getConfig(tmpDir);
+            expect(config).toEqual({ ...rootConfig, ...userConfig });
+        });
+    });
+});

package/dist/utils/utils.config.js

@@ -2,64 +2,49 @@ 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();
+import { DEFAULT_FEATURE_FLAGS } from '../constants.js';
+export function getConfig(workDir = process.cwd()) {
+    const rootConfig = getRootConfig(workDir);
+    const userConfig = getUserConfig(workDir);
     return {
         ...rootConfig,
         ...userConfig,
         version: rootConfig.version,
         features: createFeatureFlags({
-            ...rootConfig.features,
-            ...userConfig.features,
+            ...(rootConfig.features ?? {}),
+            ...(userConfig.features ?? {}),
         }),
     };
 }
-function getRootConfig() {
-    const defaultConfig = {
-        version: getVersion(),
-        features: createFeatureFlags(),
-    };
+function getRootConfig(workDir = process.cwd()) {
     try {
-        const rootPath = path.resolve(process.cwd(), '.config/.cprc.json');
+        const rootPath = path.resolve(workDir, '.config/.cprc.json');
         const rootConfig = readRCFileSync(rootPath);
         return {
-            ...defaultConfig,
-            features: {
-                ...defaultConfig.features,
-                ...rootConfig.features,
-            },
+            version: getVersion(),
+            ...rootConfig,
+            features: rootConfig.features ?? {},
         };
     }
     catch (error) {
-        if (commandName === 'generate') {
-            return defaultConfig;
-        }
         return {
-            ...defaultConfig,
-            features: createDisabledFeatureFlags(),
+            version: getVersion(),
+            features: {},
         };
     }
 }
-function getUserConfig() {
+function getUserConfig(workDir = process.cwd()) {
     try {
-        const userPath = path.resolve(process.cwd(), '.cprc.json');
+        const userPath = path.resolve(workDir, '.cprc.json');
         const userConfig = readRCFileSync(userPath);
         return {
             ...userConfig,
-            features: createFeatureFlags({
-                ...userConfig.features,
-            }),
+            features: userConfig.features ?? {},
         };
     }
     catch (error) {
-        if (commandName === 'generate') {
-            return {
-                features: createFeatureFlags(),
-            };
-        }
         return {
-            features: createDisabledFeatureFlags(),
+            features: {},
         };
     }
 }
@@ -73,15 +58,8 @@ function readRCFileSync(path) {
     }
 }
 function createFeatureFlags(flags) {
-    return {
-        useReactRouterV6: true,
-        bundleGrafanaUI: false,
-        ...flags,
-    };
-}
-function createDisabledFeatureFlags() {
-    return {
-        useReactRouterV6: false,
-        bundleGrafanaUI: false,
-    };
+    if (commandName === 'generate') {
+        return DEFAULT_FEATURE_FLAGS;
+    }
+    return flags ?? {};
 }

package/dist/utils/utils.templates.js

@@ -6,7 +6,7 @@ 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 { TEMPLATE_PATHS, EXPORT_PATH_PREFIX, EXTRA_TEMPLATE_VARIABLES, PLUGIN_TYPES, DEFAULT_FEATURE_FLAGS, } from '../constants.js';
 import { getPackageManagerInstallCmd, getPackageManagerWithFallback } from './utils.packageManager.js';
 import { getExportFileName } from '../utils/utils.files.js';
 import { getVersion } from './utils.version.js';
@@ -58,7 +58,7 @@ export function getTemplateData() {
     const pluginJson = getPluginJson();
     const { features } = getConfig();
     const currentVersion = getVersion();
-    const useReactRouterV6 = features.useReactRouterV6 && pluginJson.type === PLUGIN_TYPES.app;
+    const useReactRouterV6 = features.useReactRouterV6 === true && pluginJson.type === PLUGIN_TYPES.app;
     const { packageManagerName, packageManagerVersion } = getPackageManagerWithFallback();
     const packageManagerInstallCmd = getPackageManagerInstallCmd(packageManagerName);
     const templateData = {
@@ -75,7 +75,7 @@ export function getTemplateData() {
         packageManagerVersion,
         packageManagerInstallCmd,
         version: currentVersion,
-        bundleGrafanaUI: features.bundleGrafanaUI,
+        bundleGrafanaUI: features.bundleGrafanaUI ?? DEFAULT_FEATURE_FLAGS.bundleGrafanaUI,
         useReactRouterV6: useReactRouterV6,
         reactRouterVersion: useReactRouterV6 ? '6.22.0' : '5.2.0',
     };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/create-plugin",
-  "version": "4.0.1",
+  "version": "4.0.2-canary.754.d15fa36.0",
   "repository": {
     "directory": "packages/create-plugin",
     "url": "https://github.com/grafana/plugin-tools"
@@ -87,5 +87,5 @@
   "engines": {
     "node": ">=20"
   },
-  "gitHead": "45850137a2d1d8ae98ac2463db65324ed100d5de"
+  "gitHead": "d15fa36c7d1ea6e13a4700ef9f127d7f1c346b16"
 }

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, PLUGIN_TYPES, TEMPLATE_PATHS } from '../constants.js';
+import { DEFAULT_FEATURE_FLAGS, 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';
@@ -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; // We don't enable this by default yet for new scenes plugins.
+  const useReactRouterV6 = features.useReactRouterV6 === true && pluginType === PLUGIN_TYPES.app; // We don't enable this by default yet for new scenes plugins.
   const templateData: TemplateData = {
     ...answers,
     pluginId,
@@ -69,7 +69,7 @@ function getTemplateData(answers: CliArgs) {
     isAppType,
     isNPM: packageManagerName === 'npm',
     version: currentVersion,
-    bundleGrafanaUI: features.bundleGrafanaUI,
+    bundleGrafanaUI: features.bundleGrafanaUI ?? DEFAULT_FEATURE_FLAGS.bundleGrafanaUI,
     useReactRouterV6,
     reactRouterVersion: useReactRouterV6 ? '6.22.0' : '5.2.0',
   };

package/src/constants.ts

@@ -47,6 +47,11 @@ export const EXTRA_TEMPLATE_VARIABLES = {
   grafanaImage: 'grafana-enterprise',
 };
 
+export const DEFAULT_FEATURE_FLAGS = {
+  useReactRouterV6: true,
+  bundleGrafanaUI: false,
+};
+
 export const GRAFANA_FE_PACKAGES = [
   '@grafana/data',
   '@grafana/e2e-selectors',

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

@@ -0,0 +1,119 @@
+import fs from 'fs/promises';
+import path from 'path';
+import { vi } from 'vitest';
+import os from 'os';
+import { getVersion } from '../utils.version.js';
+import { getConfig, UserConfig, CreatePluginConfig } from '../utils.config.js';
+import { DEFAULT_FEATURE_FLAGS } from '../../constants.js';
+
+const mocks = vi.hoisted(() => {
+  return {
+    commandName: 'generate',
+  };
+});
+
+vi.mock('../utils.cli.js', async () => mocks);
+
+const tmpDir = path.join(os.tmpdir(), 'cp-test-config');
+
+describe('getConfig', () => {
+  beforeEach(async () => {
+    // Create temporary directory for testing
+    await fs.mkdir(tmpDir, { recursive: true });
+  });
+
+  afterEach(async () => {
+    // Clean up temporary directory
+    await fs.rm(tmpDir, { recursive: true, force: true });
+  });
+
+  describe('Command: Generate', () => {
+    beforeEach(() => {
+      mocks.commandName = 'generate';
+    });
+
+    it('should give back a default config', async () => {
+      const config = getConfig(tmpDir);
+
+      expect(config).toEqual({
+        version: getVersion(),
+        features: DEFAULT_FEATURE_FLAGS,
+      });
+    });
+  });
+
+  describe('Command: Update', () => {
+    beforeEach(() => {
+      mocks.commandName = 'update';
+    });
+
+    it('should give back the correct config when there are no config files at all', async () => {
+      const config = getConfig();
+
+      expect(config).toEqual({
+        version: getVersion(),
+        features: {},
+      });
+    });
+
+    it('should give back the correct config when there is no user config', async () => {
+      const rootConfigPath = path.join(tmpDir, '.config', '.cprc.json');
+      const rootConfig: CreatePluginConfig = {
+        version: '1.0.0',
+        features: {},
+      };
+
+      await fs.mkdir(path.dirname(rootConfigPath), { recursive: true });
+      await fs.writeFile(rootConfigPath, JSON.stringify(rootConfig));
+
+      const config = getConfig(tmpDir);
+
+      expect(config).toEqual({
+        version: rootConfig.version,
+        features: {},
+      });
+    });
+
+    it('should give back the correct config when there is no root config', async () => {
+      const userConfigPath = path.join(tmpDir, '.cprc.json');
+      const userConfig: UserConfig = {
+        features: {
+          useReactRouterV6: true,
+          bundleGrafanaUI: true,
+        },
+      };
+
+      await fs.writeFile(userConfigPath, JSON.stringify(userConfig));
+
+      const config = getConfig(tmpDir);
+
+      expect(config).toEqual({
+        version: getVersion(),
+        features: userConfig.features,
+      });
+    });
+
+    it('should give back the correct config when config files exist', async () => {
+      const rootConfigPath = path.join(tmpDir, '.config', '.cprc.json');
+      const userConfigPath = path.join(tmpDir, '.cprc.json');
+      const rootConfig: CreatePluginConfig = {
+        version: '1.0.0',
+        features: {},
+      };
+      const userConfig: UserConfig = {
+        features: {
+          useReactRouterV6: false,
+          bundleGrafanaUI: false,
+        },
+      };
+
+      await fs.mkdir(path.dirname(rootConfigPath), { recursive: true });
+      await fs.writeFile(rootConfigPath, JSON.stringify(rootConfig));
+      await fs.writeFile(userConfigPath, JSON.stringify(userConfig));
+
+      const config = getConfig(tmpDir);
+
+      expect(config).toEqual({ ...rootConfig, ...userConfig });
+    });
+  });
+});

package/src/utils/utils.config.ts

@@ -2,95 +2,73 @@ import fs from 'node:fs';
 import path from 'node:path';
 import { getVersion } from './utils.version.js';
 import { commandName } from './utils.cli.js';
+import { DEFAULT_FEATURE_FLAGS } from '../constants.js';
 
-type FeatureFlags = {
-  bundleGrafanaUI: boolean;
+export type FeatureFlags = {
+  bundleGrafanaUI?: boolean;
 
   // If set to true, the plugin will be scaffolded with React Router v6. Defaults to true.
   // (Attention! We always scaffold new projects with React Router v6, so if you are changing this to `false` manually you will need to make changes to the React code as well.)
-  useReactRouterV6: boolean;
+  useReactRouterV6?: boolean;
 };
 
-type CreatePluginConfig = UserConfig & {
+export type CreatePluginConfig = UserConfig & {
   version: string;
 };
 
-type UserConfig = {
+export type UserConfig = {
   features: FeatureFlags;
 };
 
-export function getConfig(): CreatePluginConfig {
-  const rootConfig = getRootConfig();
-  const userConfig = getUserConfig();
+export function getConfig(workDir = process.cwd()): CreatePluginConfig {
+  const rootConfig = getRootConfig(workDir);
+  const userConfig = getUserConfig(workDir);
 
   return {
     ...rootConfig,
     ...userConfig,
     version: rootConfig!.version,
     features: createFeatureFlags({
-      ...rootConfig!.features,
-      ...userConfig!.features,
+      ...(rootConfig!.features ?? {}),
+      ...(userConfig!.features ?? {}),
     }),
   };
 }
 
-function getRootConfig(): CreatePluginConfig {
-  const defaultConfig = {
-    version: getVersion(),
-    features: createFeatureFlags(),
-  };
-
+function getRootConfig(workDir = process.cwd()): CreatePluginConfig {
   try {
-    const rootPath = path.resolve(process.cwd(), '.config/.cprc.json');
+    const rootPath = path.resolve(workDir, '.config/.cprc.json');
     const rootConfig = readRCFileSync(rootPath);
 
     return {
-      ...defaultConfig,
-      features: {
-        ...defaultConfig.features,
-        ...rootConfig!.features,
-      },
+      version: getVersion(),
+      ...rootConfig,
+      features: rootConfig!.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 {
-      ...defaultConfig,
-      features: createDisabledFeatureFlags(),
+      version: getVersion(),
+      features: {},
     };
   }
 }
 
-function getUserConfig(): UserConfig | undefined {
+function getUserConfig(workDir = process.cwd()): UserConfig | undefined {
   try {
-    const userPath = path.resolve(process.cwd(), '.cprc.json');
+    const userPath = path.resolve(workDir, '.cprc.json');
     const userConfig = readRCFileSync(userPath);
 
     return {
       ...userConfig,
-      features: createFeatureFlags({
-        ...userConfig!.features,
-      }),
+      features: 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: createDisabledFeatureFlags(),
+      features: {},
     };
   }
 }
@@ -106,16 +84,9 @@ function readRCFileSync(path: string): CreatePluginConfig | undefined {
 
 function createFeatureFlags(flags?: FeatureFlags): FeatureFlags {
   // Default values for new scaffoldings
-  return {
-    useReactRouterV6: true,
-    bundleGrafanaUI: false,
-    ...flags,
-  };
-}
+  if (commandName === 'generate') {
+    return DEFAULT_FEATURE_FLAGS;
+  }
 
-function createDisabledFeatureFlags(): FeatureFlags {
-  return {
-    useReactRouterV6: false,
-    bundleGrafanaUI: false,
-  };
+  return flags ?? {};
 }

package/src/utils/utils.templates.ts

@@ -6,7 +6,13 @@ 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 {
+  TEMPLATE_PATHS,
+  EXPORT_PATH_PREFIX,
+  EXTRA_TEMPLATE_VARIABLES,
+  PLUGIN_TYPES,
+  DEFAULT_FEATURE_FLAGS,
+} from '../constants.js';
 import { TemplateData } from '../types.js';
 import { getPackageManagerInstallCmd, getPackageManagerWithFallback } from './utils.packageManager.js';
 import { getExportFileName } from '../utils/utils.files.js';
@@ -86,7 +92,7 @@ export function getTemplateData(): TemplateData {
   const pluginJson = getPluginJson();
   const { features } = getConfig();
   const currentVersion = getVersion();
-  const useReactRouterV6 = features.useReactRouterV6 && pluginJson.type === PLUGIN_TYPES.app;
+  const useReactRouterV6 = features.useReactRouterV6 === true && pluginJson.type === PLUGIN_TYPES.app;
   const { packageManagerName, packageManagerVersion } = getPackageManagerWithFallback();
   const packageManagerInstallCmd = getPackageManagerInstallCmd(packageManagerName);
 
@@ -104,7 +110,7 @@ export function getTemplateData(): TemplateData {
     packageManagerVersion,
     packageManagerInstallCmd,
     version: currentVersion,
-    bundleGrafanaUI: features.bundleGrafanaUI,
+    bundleGrafanaUI: features.bundleGrafanaUI ?? DEFAULT_FEATURE_FLAGS.bundleGrafanaUI,
     useReactRouterV6: useReactRouterV6,
     reactRouterVersion: useReactRouterV6 ? '6.22.0' : '5.2.0',
   };