@grafana/create-plugin 6.1.1 → 6.2.0-canary.2233.18644853669.0

package/src/commands/add/prompts.ts

@@ -0,0 +1,93 @@
+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,
+  };
+}

package/src/commands/add.command.ts

@@ -0,0 +1,108 @@
+import { getAdditionByName, getAvailableAdditions, runAddition } 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),
+      ],
+    });
+    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 });
+  } catch (error) {
+    if (error instanceof Error) {
+      output.error({
+        title: 'Addition failed',
+        body: [error.message],
+      });
+    }
+    process.exit(1);
+  }
+};
+
+async function performPreAddChecks(argv: minimist.ParsedArgs) {
+  if (!(await isGitDirectory()) && !argv.force) {
+    output.error({
+      title: 'You are not inside a git directory',
+      body: [
+        `In order to proceed please run ${output.formatCode('git init')} in the root of your project and commit your changes.`,
+        `(This check is necessary to make sure that the changes are easy to revert and don't interfere with any changes you currently have.`,
+        `In case you want to proceed as is please use the ${output.formatCode('--force')} flag.)`,
+      ],
+    });
+
+    process.exit(1);
+  }
+
+  if (!(await isGitDirectoryClean()) && !argv.force) {
+    output.error({
+      title: 'Please clean your repository working tree before adding features.',
+      body: [
+        'Commit your changes or stash them.',
+        `(This check is necessary to make sure that the changes are easy to revert and don't mess with any changes you currently have.`,
+        `In case you want to proceed as is please use the ${output.formatCode('--force')} flag.)`,
+      ],
+    });
+
+    process.exit(1);
+  }
+
+  if (!isPluginDirectory() && !argv.force) {
+    output.error({
+      title: 'Are you inside a plugin directory?',
+      body: [
+        `We couldn't find a "src/plugin.json" file under your current directory.`,
+        `(Please make sure to run this command from the root of your plugin folder. In case you want to proceed as is please use the ${output.formatCode('--force')} flag.)`,
+      ],
+    });
+
+    process.exit(1);
+  }
+}

package/src/commands/index.ts

@@ -3,3 +3,4 @@ export * from './update.command.js';
 export * from './migrate.command.js';
 export * from './version.command.js';
 export * from './provisioning.command.js';
+export * from './add.command.js';

package/templates/common/_package.json

@@ -19,7 +19,7 @@
   "license": "Apache-2.0",
   "devDependencies": {
 {{#if useCypress}}    "@grafana/e2e": "^11.0.7",
-    "@grafana/e2e-selectors": "^12.1.1",{{/if}}
+    "@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}}