@grafana/create-plugin 6.2.0-canary.2233.18586197736.0 → 6.2.0-canary.2233.18936109308.0

package/src/commands/add.command.ts

@@ -1,61 +1,22 @@
-import { getAdditionByName, getAvailableAdditions, runAddition } from '../additions/manager.js';
+import { getAdditionFlags, getAvailableAdditions, runAdditionByName } from '../additions/manager.js';
 import { isGitDirectory, isGitDirectoryClean } from '../utils/utils.git.js';
 
 import { isPluginDirectory } from '../utils/utils.plugin.js';
 import minimist from 'minimist';
 import { output } from '../utils/utils.console.js';
-import { promptI18nOptions } from './add/prompts.js';
 
 export const add = async (argv: minimist.ParsedArgs) => {
   const subCommand = argv._[1];
 
   if (!subCommand) {
-    const availableAdditions = getAvailableAdditions();
-    const additionsList = Object.values(availableAdditions).map(
-      (addition) => `${addition.name} - ${addition.description}`
-    );
-
-    output.error({
-      title: 'No addition specified',
-      body: [
-        'Usage: npx @grafana/create-plugin add <addition-name>',
-        '',
-        'Available additions:',
-        ...output.bulletList(additionsList),
-      ],
-    });
+    await showAdditionsHelp();
     process.exit(1);
   }
 
   await performPreAddChecks(argv);
 
-  const addition = getAdditionByName(subCommand);
-
-  if (!addition) {
-    const availableAdditions = getAvailableAdditions();
-    const additionsList = Object.values(availableAdditions).map((addition) => addition.name);
-
-    output.error({
-      title: `Unknown addition: ${subCommand}`,
-      body: ['Available additions:', ...output.bulletList(additionsList)],
-    });
-    process.exit(1);
-  }
-
   try {
-    // Gather options based on the addition type
-    let options = {};
-
-    switch (addition.name) {
-      case 'i18n':
-        options = await promptI18nOptions();
-        break;
-      default:
-        break;
-    }
-
-    const commitChanges = argv.commit;
-    await runAddition(addition, options, { commitChanges });
+    await runAdditionByName(subCommand, argv, { commitChanges: argv.commit });
   } catch (error) {
     if (error instanceof Error) {
       output.error({
@@ -67,6 +28,34 @@ export const add = async (argv: minimist.ParsedArgs) => {
   }
 };
 
+async function showAdditionsHelp() {
+  const availableAdditions = getAvailableAdditions();
+  const additionsList = await Promise.all(
+    Object.values(availableAdditions).map(async (addition) => {
+      let info = `${addition.name} - ${addition.description}`;
+      const flags = await getAdditionFlags(addition);
+      if (flags.length > 0) {
+        const flagDocs = flags.map((flag) => {
+          const req = flag.required ? ' (required)' : ' (optional)';
+          return `  --${flag.name}: ${flag.description}${req}`;
+        });
+        info += '\n' + flagDocs.join('\n');
+      }
+      return info;
+    })
+  );
+
+  output.error({
+    title: 'No addition specified',
+    body: [
+      'Usage: npx @grafana/create-plugin add <addition-name> [options]',
+      '',
+      'Available additions:',
+      ...output.bulletList(additionsList),
+    ],
+  });
+}
+
 async function performPreAddChecks(argv: minimist.ParsedArgs) {
   if (!(await isGitDirectory()) && !argv.force) {
     output.error({

package/src/constants.ts

@@ -1,5 +1,5 @@
-import path from 'node:path';
 import { fileURLToPath } from 'node:url';
+import path from 'node:path';
 
 const __dirname = fileURLToPath(new URL('.', import.meta.url));
 
@@ -51,19 +51,11 @@ export const EXTRA_TEMPLATE_VARIABLES = {
 export const DEFAULT_FEATURE_FLAGS = {
   useReactRouterV6: true,
   bundleGrafanaUI: false,
-  usePlaywright: true,
   useExperimentalRspack: false,
   useExperimentalUpdates: true,
 };
 
-export const GRAFANA_FE_PACKAGES = [
-  '@grafana/data',
-  '@grafana/e2e-selectors',
-  '@grafana/e2e',
-  '@grafana/runtime',
-  '@grafana/schema',
-  '@grafana/ui',
-];
+export const GRAFANA_FE_PACKAGES = ['@grafana/data', '@grafana/runtime', '@grafana/schema', '@grafana/ui'];
 
 export const MIGRATION_CONFIG = {
   // Files that should be overriden during a migration.

package/src/types.ts

@@ -25,8 +25,6 @@ export type TemplateData = {
   useReactRouterV6: boolean;
   scenesVersion: string;
   reactRouterVersion: string;
-  usePlaywright: boolean;
-  useCypress: boolean;
   useExperimentalRspack: boolean;
   pluginExecutable?: string;
   frontendBundler: 'webpack' | 'rspack';

package/src/utils/utils.config.ts

@@ -1,11 +1,13 @@
-import fs from 'node:fs';
-import { writeFile } from 'node:fs/promises';
-import path from 'node:path';
-import { CURRENT_APP_VERSION } from './utils.version.js';
 import { argv, commandName } from './utils.cli.js';
+
+import { CURRENT_APP_VERSION } from './utils.version.js';
 import { DEFAULT_FEATURE_FLAGS } from '../constants.js';
+import fs from 'node:fs';
 import { output } from './utils.console.js';
 import { partitionArr } from './utils.helpers.js';
+import path from 'node:path';
+import { writeFile } from 'node:fs/promises';
+import { EOL } from 'node:os';
 
 export type FeatureFlags = {
   bundleGrafanaUI?: boolean;
@@ -13,7 +15,6 @@ export type FeatureFlags = {
   // 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;
-  usePlaywright?: boolean;
   useExperimentalRspack?: boolean;
   useExperimentalUpdates?: boolean;
 };
@@ -127,7 +128,7 @@ export async function setRootConfig(configOverride: Partial<CreatePluginConfig>
   const rootConfigPath = path.resolve(process.cwd(), '.config/.cprc.json');
   const updatedConfig = { ...rootConfig, ...configOverride };
 
-  await writeFile(rootConfigPath, JSON.stringify(updatedConfig, null, 2));
+  await writeFile(rootConfigPath, JSON.stringify(updatedConfig, null, 2) + EOL);
 
   return updatedConfig;
 }

package/src/utils/utils.templates.ts

@@ -1,27 +1,27 @@
-import { lt as semverLt } from 'semver';
-import { glob } from 'glob';
-import path from 'node:path';
-import fs from 'node:fs';
-import { filterOutCommonFiles, isFile, isFileStartingWith } from './utils.files.js';
-import { normalizeId, renderHandlebarsTemplate } from './utils.handlebars.js';
-import { getPluginJson } from './utils.plugin.js';
-import { debug } from './utils.cli.js';
 import {
-  TEMPLATE_PATHS,
+  DEFAULT_FEATURE_FLAGS,
   EXPORT_PATH_PREFIX,
   EXTRA_TEMPLATE_VARIABLES,
   PLUGIN_TYPES,
-  DEFAULT_FEATURE_FLAGS,
+  TEMPLATE_PATHS,
 } from '../constants.js';
 import { GenerateCliArgs, TemplateData } from '../types.js';
+import { filterOutCommonFiles, isFile, isFileStartingWith } from './utils.files.js';
 import {
+  getPackageManagerFromUserAgent,
   getPackageManagerInstallCmd,
   getPackageManagerWithFallback,
-  getPackageManagerFromUserAgent,
 } from './utils.packageManager.js';
-import { getExportFileName } from '../utils/utils.files.js';
-import { getGrafanaRuntimeVersion, CURRENT_APP_VERSION } from './utils.version.js';
+import { normalizeId, renderHandlebarsTemplate } from './utils.handlebars.js';
+
+import { CURRENT_APP_VERSION } from './utils.version.js';
+import { debug } from './utils.cli.js';
+import fs from 'node:fs';
 import { getConfig } from './utils.config.js';
+import { getExportFileName } from '../utils/utils.files.js';
+import { getPluginJson } from './utils.plugin.js';
+import { glob } from 'glob';
+import path from 'node:path';
 
 const templatesDebugger = debug.extend('templates');
 
@@ -95,11 +95,6 @@ export function renderTemplateFromFile(templateFile: string, data?: any) {
 export function getTemplateData(cliArgs?: GenerateCliArgs): TemplateData {
   const { features } = getConfig();
   const currentVersion = CURRENT_APP_VERSION;
-  const grafanaVersion = getGrafanaRuntimeVersion();
-  const usePlaywright = features.usePlaywright === true || isFile(path.join(process.cwd(), 'playwright.config.ts'));
-  //@grafana/e2e was deprecated in Grafana 11
-  const useCypress =
-    !usePlaywright && semverLt(grafanaVersion, '11.0.0') && fs.existsSync(path.join(process.cwd(), 'cypress'));
   const bundleGrafanaUI = features.bundleGrafanaUI ?? DEFAULT_FEATURE_FLAGS.bundleGrafanaUI;
   const getReactRouterVersion = () => (features.useReactRouterV6 ? '6.22.0' : '5.2.0');
   const isAppType = (pluginType: string) => pluginType === PLUGIN_TYPES.app || pluginType === PLUGIN_TYPES.scenes;
@@ -130,8 +125,6 @@ export function getTemplateData(cliArgs?: GenerateCliArgs): TemplateData {
       useReactRouterV6: features.useReactRouterV6 ?? DEFAULT_FEATURE_FLAGS.useReactRouterV6,
       reactRouterVersion: getReactRouterVersion(),
       scenesVersion: features.useReactRouterV6 ? '^6.10.4' : '^5.41.3',
-      usePlaywright,
-      useCypress,
       useExperimentalRspack: Boolean(features.useExperimentalRspack),
       frontendBundler,
     };
@@ -158,8 +151,6 @@ export function getTemplateData(cliArgs?: GenerateCliArgs): TemplateData {
       useReactRouterV6: features.useReactRouterV6 ?? DEFAULT_FEATURE_FLAGS.useReactRouterV6,
       reactRouterVersion: getReactRouterVersion(),
       scenesVersion: features.useReactRouterV6 ? '^6.10.4' : '^5.41.3',
-      usePlaywright,
-      useCypress,
       pluginExecutable: pluginJson.executable,
       useExperimentalRspack: Boolean(features.useExperimentalRspack),
       frontendBundler,

package/templates/common/_package.json

@@ -8,26 +8,22 @@
     "test:ci": "jest --passWithNoTests --maxWorkers 4",
     "typecheck": "tsc --noEmit",
     "lint": "eslint --cache .",
-    "lint:fix": "{{ packageManagerName }} run lint{{#if isNPM}} --{{/if}} --fix && prettier --write --list-different .",{{#if usePlaywright}}
-    "e2e": "playwright test",{{/if}}{{#if useCypress}}
-    "e2e": "{{ packageManagerName }} exec cypress install && {{ packageManagerName }} exec grafana-e2e run",
-    "e2e:update": "{{ packageManagerName }} exec cypress install && {{ packageManagerName }} exec grafana-e2e run --update-screenshots",{{/if}}
+    "lint:fix": "{{ packageManagerName }} run lint{{#if isNPM}} --{{/if}} --fix && prettier --write --list-different .",
+    "e2e": "playwright test",
     "server": "docker compose up --build",
     "sign": "npx --yes @grafana/sign-plugin@latest"
   },
   "author": "{{ sentenceCase orgName }}",
   "license": "Apache-2.0",
   "devDependencies": {
-{{#if useCypress}}    "@grafana/e2e": "^11.0.7",
-    "@grafana/e2e-selectors": "^12.2.0",{{/if}}
-    "@grafana/eslint-config": "^8.2.0",{{#if usePlaywright}}
-    "@grafana/plugin-e2e": "^2.2.0",{{/if}}
-    "@grafana/tsconfig": "^2.0.0",{{#if usePlaywright}}
-    "@playwright/test": "^1.52.0",{{/if}}{{#if useExperimentalRspack}}
+    "@grafana/eslint-config": "^8.2.0",
+    "@grafana/plugin-e2e": "^2.2.0",
+    "@grafana/tsconfig": "^2.0.0",
+    "@playwright/test": "^1.52.0",{{#if useExperimentalRspack}}
     "@rspack/core": "^1.3.0",
     "@rspack/cli": "^1.3.0",{{/if}}
     "@stylistic/eslint-plugin-ts": "^2.9.0",
-    "@swc/core": "^1.3.90",
+    "@swc/core": "1.13.20",
     "@swc/helpers": "^0.5.0",
     "@swc/jest": "^0.2.26",
     "@testing-library/jest-dom": "6.1.4",
@@ -56,8 +52,8 @@
     "replace-in-file-webpack-plugin": "^1.0.6",{{#if useExperimentalRspack}}
     "rspack-plugin-virtual-module": "^0.1.13",{{/if}}
     "sass": "1.63.2",
-    "sass-loader": "13.3.1",{{#if usePlaywright}}
-    "semver": "^7.6.3",{{/if}}
+    "sass-loader": "13.3.1",
+    "semver": "^7.6.3",
     "style-loader": "3.3.3",{{#unless useExperimentalRspack}}
     "swc-loader": "^0.2.3",{{/unless}}
     "terser-webpack-plugin": "^5.3.10",

package/templates/common/npmrc

@@ -10,6 +10,3 @@ public-hoist-pattern[]="*prettier*"
 # Hoist all types packages to the root for better TS support
 public-hoist-pattern[]="@types/*"
 public-hoist-pattern[]="*terser-webpack-plugin*"
-{{#unless usePlaywright}}
-# @grafana/e2e expects cypress to exist in the root of the node_modules directory
-public-hoist-pattern[]="*cypress*"{{/unless}}

package/templates/github/workflows/bundle-stats.yml

@@ -24,4 +24,4 @@ jobs:
         with:
           persist-credentials: false
 
-      - uses: grafana/plugin-actions/bundle-size@main # zizmor: ignore[unpinned-uses] provided by grafana
+      - uses: grafana/plugin-actions/bundle-size@v1.0.2

package/templates/github/workflows/ci.yml

@@ -146,7 +146,7 @@ jobs:
 
       - name: Resolve Grafana E2E versions
         id: resolve-versions
-        uses: grafana/plugin-actions/e2e-version@main # zizmor: ignore[unpinned-uses] provided by grafana
+        uses: grafana/plugin-actions/e2e-version@v1.1.2
 
   playwright-tests:
     needs: [resolve-versions, build]
@@ -197,7 +197,7 @@ jobs:
           ANONYMOUS_AUTH_ENABLED=false DEVELOPMENT=false GRAFANA_VERSION=$\{{ matrix.GRAFANA_IMAGE.VERSION }} GRAFANA_IMAGE=$\{{ matrix.GRAFANA_IMAGE.NAME }} docker compose up -d
 
       - name: Wait for grafana server
-        uses: grafana/plugin-actions/wait-for-grafana@main # zizmor: ignore[unpinned-uses] provided by grafana
+        uses: grafana/plugin-actions/wait-for-grafana@v1.0.2
         with:
           url: http://localhost:3000/login
 
@@ -209,7 +209,7 @@ jobs:
         run: {{ packageManagerName }} run e2e
 
       - name: Upload e2e test summary
-        uses: grafana/plugin-actions/playwright-gh-pages/upload-report-artifacts@main # zizmor: ignore[unpinned-uses] provided by grafana
+        uses: grafana/plugin-actions/playwright-gh-pages/upload-report-artifacts@v1.0.1
         if: $\{{ always() && !cancelled() }}
         with:
           upload-report: false
@@ -247,7 +247,7 @@ jobs:
           # required for playwright-gh-pages
           persist-credentials: true
       - name: Publish report
-        uses: grafana/plugin-actions/playwright-gh-pages/deploy-report-pages@main # zizmor: ignore[unpinned-uses] provided by grafana
+        uses: grafana/plugin-actions/playwright-gh-pages/deploy-report-pages@v1.0.1
         with:
           github-token: $\{{ secrets.GITHUB_TOKEN }}
 

package/templates/github/workflows/cp-update.yml

@@ -18,7 +18,7 @@ jobs:
   release:
     runs-on: ubuntu-latest
     steps:
-      - uses: grafana/plugin-actions/create-plugin-update@main # zizmor: ignore[unpinned-uses] provided by grafana
+      - uses: grafana/plugin-actions/create-plugin-update@v1.1.0
         # Uncomment to use a fine-grained personal access token instead of default github token
         # (For more info on how to generate the token see https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens)
         # with:

package/templates/github/workflows/is-compatible.yml

@@ -36,7 +36,7 @@ jobs:
           echo "modulets=${MODULETS}" >> $GITHUB_OUTPUT
 
       - name: Compatibility check
-        uses: grafana/plugin-actions/is-compatible@main
+        uses: grafana/plugin-actions/is-compatible@v1.0.2
         with:
           module: $\{{ steps.find-module-ts.outputs.modulets }}
           comment-pr: "no"

package/templates/github/workflows/release.yml

@@ -20,7 +20,7 @@ jobs:
         with:
           persist-credentials: false
 
-      - uses: grafana/plugin-actions/build-plugin@main # zizmor: ignore[unpinned-uses] provided by grafana
+      - uses: grafana/plugin-actions/build-plugin@v1.0.2
         # Uncomment to enable plugin signing
         # (For more info on how to generate the access policy token see https://grafana.com/developers/plugin-tools/publish-a-plugin/sign-a-plugin#generate-an-access-policy-token)
         #with:

package/dist/commands/add/prompts.js

@@ -1,72 +0,0 @@
-import Enquirer from 'enquirer';
-import { output } from '../../utils/utils.console.js';
-
-const COMMON_LOCALES = [
-  { name: "en-US", message: "English (US)" },
-  { name: "es-ES", message: "Spanish (Spain)" },
-  { name: "fr-FR", message: "French (France)" },
-  { name: "de-DE", message: "German (Germany)" },
-  { name: "zh-Hans", message: "Chinese (Simplified)" },
-  { name: "pt-BR", message: "Portuguese (Brazil)" },
-  { name: "sv-SE", message: "Swedish (Sweden)" },
-  { name: "nl-NL", message: "Dutch (Netherlands)" },
-  { name: "ja-JP", message: "Japanese (Japan)" },
-  { name: "it-IT", message: "Italian (Italy)" }
-];
-async function promptI18nOptions() {
-  const enquirer = new Enquirer();
-  output.log({
-    title: "Configure internationalization (i18n) for your plugin",
-    body: [
-      "Select the locales you want to support. At least one locale must be selected.",
-      "Use space to select, enter to continue."
-    ]
-  });
-  const localeChoices = COMMON_LOCALES.map((locale) => ({
-    name: locale.name,
-    message: locale.message,
-    value: locale.name
-  }));
-  let selectedLocales = [];
-  try {
-    const result = await enquirer.prompt({
-      type: "multiselect",
-      name: "locales",
-      message: "Select locales to support:",
-      choices: localeChoices,
-      initial: [0],
-      // Pre-select en-US by default
-      validate(value) {
-        if (value.length === 0) {
-          return "At least one locale must be selected";
-        }
-        return true;
-      }
-    });
-    selectedLocales = result.locales;
-  } catch (error) {
-    output.warning({ title: "Addition cancelled by user." });
-    process.exit(0);
-  }
-  try {
-    const addMoreResult = await enquirer.prompt({
-      type: "input",
-      name: "additionalLocales",
-      message: 'Enter additional locale codes (comma-separated, e.g., "ko-KR,ru-RU") or press enter to skip:'
-    });
-    const additionalLocalesInput = addMoreResult.additionalLocales;
-    if (additionalLocalesInput && additionalLocalesInput.trim()) {
-      const additionalLocales = additionalLocalesInput.split(",").map((locale) => locale.trim()).filter((locale) => locale.length > 0 && !selectedLocales.includes(locale));
-      selectedLocales.push(...additionalLocales);
-    }
-  } catch (error) {
-  }
-  output.log({
-    title: `Selected locales: ${selectedLocales.join(", ")}`
-  });
-  return {
-    locales: selectedLocales
-  };
-}
-
-export { promptI18nOptions };

package/src/commands/add/prompts.ts

@@ -1,93 +0,0 @@
-import Enquirer from 'enquirer';
-import { output } from '../../utils/utils.console.js';
-
-// Common locales supported by Grafana
-// Reference: https://github.com/grafana/grafana/blob/main/packages/grafana-i18n/src/constants.ts
-const COMMON_LOCALES = [
-  { name: 'en-US', message: 'English (US)' },
-  { name: 'es-ES', message: 'Spanish (Spain)' },
-  { name: 'fr-FR', message: 'French (France)' },
-  { name: 'de-DE', message: 'German (Germany)' },
-  { name: 'zh-Hans', message: 'Chinese (Simplified)' },
-  { name: 'pt-BR', message: 'Portuguese (Brazil)' },
-  { name: 'sv-SE', message: 'Swedish (Sweden)' },
-  { name: 'nl-NL', message: 'Dutch (Netherlands)' },
-  { name: 'ja-JP', message: 'Japanese (Japan)' },
-  { name: 'it-IT', message: 'Italian (Italy)' },
-];
-
-export type I18nOptions = {
-  locales: string[];
-};
-
-export async function promptI18nOptions(): Promise<I18nOptions> {
-  const enquirer = new Enquirer();
-
-  output.log({
-    title: 'Configure internationalization (i18n) for your plugin',
-    body: [
-      'Select the locales you want to support. At least one locale must be selected.',
-      'Use space to select, enter to continue.',
-    ],
-  });
-
-  const localeChoices = COMMON_LOCALES.map((locale) => ({
-    name: locale.name,
-    message: locale.message,
-    value: locale.name,
-  }));
-
-  let selectedLocales: string[] = [];
-
-  try {
-    const result = (await enquirer.prompt({
-      type: 'multiselect',
-      name: 'locales',
-      message: 'Select locales to support:',
-      choices: localeChoices,
-      initial: [0], // Pre-select en-US by default
-      validate(value: string[]) {
-        if (value.length === 0) {
-          return 'At least one locale must be selected';
-        }
-        return true;
-      },
-    } as any)) as { locales: string[] };
-
-    selectedLocales = result.locales;
-  } catch (error) {
-    // User cancelled the prompt
-    output.warning({ title: 'Addition cancelled by user.' });
-    process.exit(0);
-  }
-
-  // Ask if they want to add additional locales
-  try {
-    const addMoreResult = (await enquirer.prompt({
-      type: 'input',
-      name: 'additionalLocales',
-      message: 'Enter additional locale codes (comma-separated, e.g., "ko-KR,ru-RU") or press enter to skip:',
-    } as any)) as { additionalLocales: string };
-
-    const additionalLocalesInput = addMoreResult.additionalLocales;
-
-    if (additionalLocalesInput && additionalLocalesInput.trim()) {
-      const additionalLocales = additionalLocalesInput
-        .split(',')
-        .map((locale: string) => locale.trim())
-        .filter((locale: string) => locale.length > 0 && !selectedLocales.includes(locale));
-
-      selectedLocales.push(...additionalLocales);
-    }
-  } catch (error) {
-    // User cancelled, just continue with what we have
-  }
-
-  output.log({
-    title: `Selected locales: ${selectedLocales.join(', ')}`,
-  });
-
-  return {
-    locales: selectedLocales,
-  };
-}