@grafana/create-plugin 6.5.0-canary.2320.20268447181.0 → 6.5.0

package/src/codemods/additions/scripts/i18n/index.ts

@@ -1,102 +0,0 @@
-import * as v from 'valibot';
-
-import type { Context } from '../../../context.js';
-import { additionsDebug } from '../../../utils.js';
-import { updateDockerCompose, updatePluginJson, createI18nextConfig, ensureI18nextExternal } from './config-updates.js';
-import { addI18nInitialization, createLoadResourcesFile } from './code-generation.js';
-import { updateEslintConfig, addI18nDependency, addSemverDependency, addI18nextCli } from './tooling.js';
-import { checkNeedsBackwardCompatibility, createLocaleFiles, checkReactVersion } from './utils.js';
-
-/**
- * I18n addition schema using Valibot
- * Adds internationalization support to a plugin
- */
-export const schema = v.object(
-  {
-    locales: v.pipe(
-      v.union([v.string(), v.array(v.string())]),
-      v.transform((input) => {
-        // Handle both string (from CLI) and array (from tests)
-        return typeof input === 'string' ? input.split(',').map((s) => s.trim()) : input;
-      }),
-      v.array(
-        v.pipe(
-          v.string(),
-          v.regex(/^[a-z]{2}-[A-Z]{2}$/, 'Locale must be in format xx-XX (e.g., en-US, es-ES, sv-SE)')
-        ),
-        'Please provide a comma-separated list of all supported locales, e.g., "en-US,es-ES,sv-SE"'
-      ),
-      v.minLength(1, 'Please provide a comma-separated list of all supported locales, e.g., "en-US,es-ES,sv-SE"')
-    ),
-  },
-  'Please provide a comma-separated list of all supported locales, e.g., "en-US,es-ES,sv-SE"'
-);
-
-type I18nOptions = v.InferOutput<typeof schema>;
-
-export default function i18nAddition(context: Context, options: I18nOptions): Context {
-  const { locales } = options;
-
-  additionsDebug('Adding i18n support with locales:', locales);
-
-  // Check React version early - @grafana/i18n requires React 18+
-  checkReactVersion(context);
-
-  // Determine if we need backward compatibility (Grafana < 12.1.0)
-  const needsBackwardCompatibility = checkNeedsBackwardCompatibility(context);
-  additionsDebug('Needs backward compatibility:', needsBackwardCompatibility);
-
-  // 1. Update docker-compose.yaml with feature toggle
-  updateDockerCompose(context);
-
-  // 2. Update plugin.json with languages and grafanaDependency
-  updatePluginJson(context, locales, needsBackwardCompatibility);
-
-  // 3. Create locale folders and files
-  createLocaleFiles(context, locales);
-
-  // 4. Add @grafana/i18n dependency
-  addI18nDependency(context);
-
-  // 5. Add semver dependency for backward compatibility
-  if (needsBackwardCompatibility) {
-    addSemverDependency(context);
-  }
-
-  // 6. Update eslint.config.mjs if needed
-  updateEslintConfig(context);
-
-  // 7. Add i18n initialization to module file
-  addI18nInitialization(context, needsBackwardCompatibility);
-
-  // 8. Create loadResources.ts for backward compatibility
-  if (needsBackwardCompatibility) {
-    createLoadResourcesFile(context);
-  }
-
-  // 9. Add i18next-cli as dev dependency and add script
-  addI18nextCli(context);
-
-  // 10. Create i18next.config.ts
-  createI18nextConfig(context);
-
-  // 11. Ensure i18next is in externals array
-  try {
-    ensureI18nextExternal(context);
-  } catch (error) {
-    additionsDebug(`Error ensuring i18next external: ${error instanceof Error ? error.message : String(error)}`);
-  }
-
-  // Success message with next steps
-  additionsDebug('\n✅ i18n support has been successfully added to your plugin!\n');
-  additionsDebug('Next steps:');
-  additionsDebug('1. Follow the instructions to translate your source code:');
-  additionsDebug(
-    '   https://grafana.com/developers/plugin-tools/how-to-guides/plugin-internationalization-grafana-11#determine-the-text-to-translate'
-  );
-  additionsDebug('2. Run the i18n-extract script to scan your code for translatable strings:');
-  additionsDebug('   npm run i18n-extract  (or yarn/pnpm run i18n-extract)');
-  additionsDebug('3. Fill in your locale JSON files with translated strings\n');
-
-  return context;
-}

package/src/codemods/additions/scripts/i18n/tooling.test.ts

@@ -1,80 +0,0 @@
-import { describe, expect, it } from 'vitest';
-
-import { Context } from '../../../context.js';
-import { updateEslintConfig } from './tooling.js';
-
-describe('tooling', () => {
-  describe('updateEslintConfig', () => {
-    it('should add correct ESLint config with proper rules and options', () => {
-      const context = new Context('/virtual');
-
-      context.addFile(
-        'eslint.config.mjs',
-        'import { defineConfig } from "eslint/config";\nexport default defineConfig([]);'
-      );
-
-      updateEslintConfig(context);
-
-      const eslintConfig = context.getFile('eslint.config.mjs');
-
-      // Check correct import (recast uses double quotes)
-      expect(eslintConfig).toContain('import grafanaI18nPlugin from "@grafana/i18n/eslint-plugin"');
-
-      // Check plugin registration
-      expect(eslintConfig).toContain('"@grafana/i18n": grafanaI18nPlugin');
-
-      // Check rules are present
-      expect(eslintConfig).toContain('"@grafana/i18n/no-untranslated-strings"');
-      expect(eslintConfig).toContain('"@grafana/i18n/no-translation-top-level"');
-
-      // Check rule configuration
-      expect(eslintConfig).toContain('"error"');
-      expect(eslintConfig).toContain('calleesToIgnore');
-      expect(eslintConfig).toContain('"^css$"');
-      expect(eslintConfig).toContain('"use[A-Z].*"');
-
-      // Check config name
-      expect(eslintConfig).toContain('name: "grafana/i18n-rules"');
-    });
-
-    it('should not add ESLint config if already present', () => {
-      const context = new Context('/virtual');
-
-      context.addFile(
-        'eslint.config.mjs',
-        'import { defineConfig } from "eslint/config";\nimport grafanaI18nPlugin from "@grafana/i18n/eslint-plugin";\nexport default defineConfig([]);'
-      );
-
-      const originalContent = context.getFile('eslint.config.mjs');
-
-      updateEslintConfig(context);
-
-      // The ESLint config should remain unchanged
-      const eslintConfig = context.getFile('eslint.config.mjs');
-      expect(eslintConfig).toBe(originalContent);
-      expect(eslintConfig).toContain('@grafana/i18n/eslint-plugin');
-      // Should not have duplicate imports or configs
-      const importCount = (eslintConfig?.match(/@grafana\/i18n\/eslint-plugin/g) || []).length;
-      expect(importCount).toBe(1);
-    });
-
-    it('should handle missing eslint.config.mjs gracefully', () => {
-      const context = new Context('/virtual');
-      // No eslint.config.mjs file
-
-      expect(() => {
-        updateEslintConfig(context);
-      }).not.toThrow();
-    });
-
-    it('should handle empty eslint.config.mjs gracefully', () => {
-      const context = new Context('/virtual');
-
-      context.addFile('eslint.config.mjs', '');
-
-      expect(() => {
-        updateEslintConfig(context);
-      }).not.toThrow();
-    });
-  });
-});

package/src/codemods/additions/scripts/i18n/tooling.ts

@@ -1,150 +0,0 @@
-import * as recast from 'recast';
-import * as babelParser from 'recast/parsers/babel-ts.js';
-
-import type { Context } from '../../../context.js';
-import { addDependenciesToPackageJson, additionsDebug } from '../../../utils.js';
-
-const { builders } = recast.types;
-
-export function addI18nDependency(context: Context): void {
-  addDependenciesToPackageJson(context, { '@grafana/i18n': '^12.2.2' }, {});
-  additionsDebug('Added @grafana/i18n dependency version ^12.2.2');
-}
-
-export function addSemverDependency(context: Context): void {
-  // Add semver as regular dependency and @types/semver as dev dependency
-  addDependenciesToPackageJson(context, { semver: '^7.6.0' }, { '@types/semver': '^7.5.0' });
-  additionsDebug('Added semver dependency');
-}
-
-export function addI18nextCli(context: Context): void {
-  // Add i18next-cli as dev dependency
-  addDependenciesToPackageJson(context, {}, { 'i18next-cli': '^1.1.1' });
-
-  // Add i18n-extract script to package.json
-  const packageJsonRaw = context.getFile('package.json');
-  if (!packageJsonRaw) {
-    return;
-  }
-
-  try {
-    const packageJson = JSON.parse(packageJsonRaw);
-
-    if (!packageJson.scripts) {
-      packageJson.scripts = {};
-    }
-
-    // Defensive: only add if not already present
-    if (!packageJson.scripts['i18n-extract']) {
-      packageJson.scripts['i18n-extract'] = 'i18next-cli extract --sync-primary';
-      context.updateFile('package.json', JSON.stringify(packageJson, null, 2));
-      additionsDebug('Added i18n-extract script to package.json');
-    } else {
-      additionsDebug('i18n-extract script already exists, skipping');
-    }
-  } catch (error) {
-    additionsDebug('Error adding i18n-extract script:', error);
-  }
-}
-
-export function updateEslintConfig(context: Context): void {
-  if (!context.doesFileExist('eslint.config.mjs')) {
-    additionsDebug('eslint.config.mjs not found, skipping');
-    return;
-  }
-
-  const eslintConfigRaw = context.getFile('eslint.config.mjs');
-  if (!eslintConfigRaw) {
-    return;
-  }
-
-  // Defensive: check if @grafana/i18n eslint plugin is already configured
-  if (eslintConfigRaw.includes('@grafana/i18n/eslint-plugin')) {
-    additionsDebug('ESLint i18n rule already configured');
-    return;
-  }
-
-  try {
-    const ast = recast.parse(eslintConfigRaw, {
-      parser: babelParser,
-    });
-
-    // Find the import section and add the plugin import
-    const imports = ast.program.body.filter((node: any) => node.type === 'ImportDeclaration');
-    const lastImport = imports[imports.length - 1];
-
-    // Always create the plugin import
-    const pluginImport = builders.importDeclaration(
-      [builders.importDefaultSpecifier(builders.identifier('grafanaI18nPlugin'))],
-      builders.literal('@grafana/i18n/eslint-plugin')
-    );
-
-    if (lastImport) {
-      const lastImportIndex = ast.program.body.indexOf(lastImport);
-      ast.program.body.splice(lastImportIndex + 1, 0, pluginImport);
-    } else {
-      // No imports found, insert at the beginning
-      ast.program.body.unshift(pluginImport);
-    }
-
-    // Find the defineConfig array and add the plugin config
-    recast.visit(ast, {
-      visitCallExpression(path: any) {
-        if (path.node.callee.name === 'defineConfig' && path.node.arguments[0]?.type === 'ArrayExpression') {
-          const configArray = path.node.arguments[0];
-
-          // Add the grafana i18n config object
-          const i18nConfig = builders.objectExpression([
-            builders.property('init', builders.identifier('name'), builders.literal('grafana/i18n-rules')),
-            builders.property(
-              'init',
-              builders.identifier('plugins'),
-              builders.objectExpression([
-                builders.property('init', builders.literal('@grafana/i18n'), builders.identifier('grafanaI18nPlugin')),
-              ])
-            ),
-            builders.property(
-              'init',
-              builders.identifier('rules'),
-              builders.objectExpression([
-                builders.property(
-                  'init',
-                  builders.literal('@grafana/i18n/no-untranslated-strings'),
-                  builders.arrayExpression([
-                    builders.literal('error'),
-                    builders.objectExpression([
-                      builders.property(
-                        'init',
-                        builders.identifier('calleesToIgnore'),
-                        builders.arrayExpression([builders.literal('^css$'), builders.literal('use[A-Z].*')])
-                      ),
-                    ]),
-                  ])
-                ),
-                builders.property(
-                  'init',
-                  builders.literal('@grafana/i18n/no-translation-top-level'),
-                  builders.literal('error')
-                ),
-              ])
-            ),
-          ]);
-
-          configArray.elements.push(i18nConfig);
-        }
-        this.traverse(path);
-      },
-    });
-
-    const output = recast.print(ast, {
-      tabWidth: 2,
-      trailingComma: true,
-      lineTerminator: '\n',
-    }).code;
-
-    context.updateFile('eslint.config.mjs', output);
-    additionsDebug('Updated eslint.config.mjs with i18n linting rules');
-  } catch (error) {
-    additionsDebug('Error updating eslint.config.mjs:', error);
-  }
-}

package/src/codemods/additions/scripts/i18n/utils.test.ts

@@ -1,133 +0,0 @@
-import { describe, expect, it } from 'vitest';
-
-import { Context } from '../../../context.js';
-import { checkReactVersion } from './utils.js';
-
-describe('utils', () => {
-  describe('checkReactVersion', () => {
-    it('should throw error if React < 18 in dependencies', () => {
-      const context = new Context('/virtual');
-
-      context.addFile(
-        'package.json',
-        JSON.stringify({
-          dependencies: {
-            react: '^17.0.2',
-            'react-dom': '^17.0.2',
-          },
-        })
-      );
-
-      expect(() => {
-        checkReactVersion(context);
-      }).toThrow('@grafana/i18n requires React 18 or higher');
-    });
-
-    it('should throw error if React 17 in devDependencies', () => {
-      const context = new Context('/virtual');
-
-      context.addFile(
-        'package.json',
-        JSON.stringify({
-          devDependencies: {
-            react: '^17.0.2',
-            'react-dom': '^17.0.2',
-          },
-        })
-      );
-
-      expect(() => {
-        checkReactVersion(context);
-      }).toThrow('@grafana/i18n requires React 18 or higher');
-    });
-
-    it('should throw error if React 17 in peerDependencies', () => {
-      const context = new Context('/virtual');
-
-      context.addFile(
-        'package.json',
-        JSON.stringify({
-          peerDependencies: {
-            react: '^17.0.2',
-            'react-dom': '^17.0.2',
-          },
-        })
-      );
-
-      expect(() => {
-        checkReactVersion(context);
-      }).toThrow('@grafana/i18n requires React 18 or higher');
-    });
-
-    it('should continue if React >= 18', () => {
-      const context = new Context('/virtual');
-
-      context.addFile(
-        'package.json',
-        JSON.stringify({
-          dependencies: {
-            react: '^18.3.0',
-            'react-dom': '^18.3.0',
-          },
-        })
-      );
-
-      expect(() => {
-        checkReactVersion(context);
-      }).not.toThrow();
-    });
-
-    it('should continue if React version cannot be determined (no package.json)', () => {
-      const context = new Context('/virtual');
-      // No package.json file
-
-      expect(() => {
-        checkReactVersion(context);
-      }).not.toThrow();
-    });
-
-    it('should continue if React version cannot be determined (no React dependency)', () => {
-      const context = new Context('/virtual');
-
-      context.addFile('package.json', JSON.stringify({})); // No React dependency
-
-      expect(() => {
-        checkReactVersion(context);
-      }).not.toThrow();
-    });
-
-    it('should handle version ranges correctly', () => {
-      const context = new Context('/virtual');
-
-      context.addFile(
-        'package.json',
-        JSON.stringify({
-          dependencies: {
-            react: '~18.1.0',
-          },
-        })
-      );
-
-      expect(() => {
-        checkReactVersion(context);
-      }).not.toThrow();
-    });
-
-    it('should handle React 19', () => {
-      const context = new Context('/virtual');
-
-      context.addFile(
-        'package.json',
-        JSON.stringify({
-          dependencies: {
-            react: '^19.0.0',
-          },
-        })
-      );
-
-      expect(() => {
-        checkReactVersion(context);
-      }).not.toThrow();
-    });
-  });
-});

package/src/codemods/additions/scripts/i18n/utils.ts

@@ -1,106 +0,0 @@
-import { coerce, gte } from 'semver';
-
-import type { Context } from '../../../context.js';
-import { additionsDebug } from '../../../utils.js';
-
-/**
- * Checks if React version is >= 18
- * @throws Error if React < 18 (since @grafana/i18n requires React 18+)
- */
-export function checkReactVersion(context: Context): void {
-  const packageJsonRaw = context.getFile('package.json');
-  if (!packageJsonRaw) {
-    return;
-  }
-
-  try {
-    const packageJson = JSON.parse(packageJsonRaw);
-    const reactVersion =
-      packageJson.dependencies?.react || packageJson.devDependencies?.react || packageJson.peerDependencies?.react;
-
-    if (reactVersion) {
-      const reactVersionStr = reactVersion.replace(/[^0-9.]/g, '');
-      const reactVersionCoerced = coerce(reactVersionStr);
-
-      if (reactVersionCoerced && !gte(reactVersionCoerced, '18.0.0')) {
-        throw new Error(
-          `@grafana/i18n requires React 18 or higher. Your plugin is using React ${reactVersion}.\n\n` +
-            `Please upgrade to React 18+ to use i18n support.\n` +
-            `Update your package.json to use "react": "^18.3.0" and "react-dom": "^18.3.0".`
-        );
-      }
-    }
-  } catch (error) {
-    // If it's our version check error, re-throw it
-    if (error instanceof Error && error.message.includes('@grafana/i18n requires React')) {
-      throw error;
-    }
-    // Otherwise, just log and continue (can't determine React version)
-    additionsDebug('Error checking React version:', error);
-  }
-}
-
-export function checkNeedsBackwardCompatibility(context: Context): boolean {
-  const pluginJsonRaw = context.getFile('src/plugin.json');
-  if (!pluginJsonRaw) {
-    // Default to backward compat for safety when plugin.json is missing
-    return true;
-  }
-
-  try {
-    const pluginJson = JSON.parse(pluginJsonRaw);
-    const currentGrafanaDep = pluginJson.dependencies?.grafanaDependency;
-
-    if (!currentGrafanaDep) {
-      additionsDebug(
-        'Warning: grafanaDependency is missing from plugin.json. Assuming backward compatibility mode is needed.'
-      );
-      return true;
-    }
-
-    const minVersion = coerce('12.1.0');
-    const currentVersion = coerce(currentGrafanaDep.replace(/^[><=]+/, ''));
-
-    // If current version is less than 12.1.0, we need backward compatibility
-    if (currentVersion && minVersion && gte(currentVersion, minVersion)) {
-      return false; // Already >= 12.1.0, no backward compat needed
-    }
-    return true; // < 12.1.0, needs backward compat
-  } catch (error) {
-    additionsDebug('Error checking backward compatibility:', error);
-    return true; // Default to backward compat on error
-  }
-}
-
-export function createLocaleFiles(context: Context, locales: string[]): void {
-  // Get plugin ID from plugin.json
-  const pluginJsonRaw = context.getFile('src/plugin.json');
-  if (!pluginJsonRaw) {
-    additionsDebug('Cannot create locale files without plugin.json');
-    return;
-  }
-
-  try {
-    const pluginJson = JSON.parse(pluginJsonRaw);
-    const pluginId = pluginJson.id;
-
-    if (!pluginId) {
-      additionsDebug('No plugin ID found in plugin.json');
-      return;
-    }
-
-    // Create locale files for each locale (defensive: only if not already present)
-    for (const locale of locales) {
-      const localePath = `src/locales/${locale}/${pluginId}.json`;
-
-      if (!context.doesFileExist(localePath)) {
-        context.addFile(localePath, JSON.stringify({}, null, 2));
-        additionsDebug(`Created ${localePath}`);
-      } else {
-        additionsDebug(`${localePath} already exists, skipping`);
-      }
-    }
-  } catch (error) {
-    additionsDebug('Error creating locale files:', error);
-  }
-}