@grafana/create-plugin 6.2.0-canary.2233.19097561440.0 → 6.2.0-canary.2283.19173715977.0

package/src/codemods/additions/manager.ts

@@ -1,145 +0,0 @@
-import type { AdditionModule, FlagDefinition } from '../types.js';
-import { additionsDebug, printChanges } from './utils.js';
-import defaultAdditions, { AdditionMeta } from './additions.js';
-import { flushChanges, formatFiles, installNPMDependencies } from '../utils.js';
-import { getConfig, isFeatureEnabled, setFeatureFlag } from '../../utils/utils.config.js';
-
-import { Context } from '../context.js';
-import { output } from '../../utils/utils.console.js';
-
-export type AdditionOptions = Record<string, any>;
-
-export function getAvailableAdditions(
-  additions: Record<string, AdditionMeta> = defaultAdditions.additions
-): Record<string, AdditionMeta> {
-  return additions;
-}
-
-export function getAdditionByName(
-  name: string,
-  additions: Record<string, AdditionMeta> = defaultAdditions.additions
-): AdditionMeta | undefined {
-  return additions[name];
-}
-
-async function loadAdditionModule(addition: AdditionMeta): Promise<AdditionModule | null> {
-  try {
-    const module = (await import(addition.scriptPath)) as AdditionModule;
-    return module;
-  } catch (error) {
-    additionsDebug('Failed to load addition module for "%s" from %s: %O', addition.name, addition.scriptPath, error);
-    return null;
-  }
-}
-
-export async function getAdditionFlags(addition: AdditionMeta): Promise<FlagDefinition[]> {
-  const module = await loadAdditionModule(addition);
-  return module?.flags || [];
-}
-
-export async function parseAdditionFlags(addition: AdditionMeta, argv: any): Promise<AdditionOptions> {
-  const module = await loadAdditionModule(addition);
-  if (module?.parseFlags) {
-    return module.parseFlags(argv);
-  }
-  return {};
-}
-
-async function validateAdditionOptions(addition: AdditionMeta, options: AdditionOptions): Promise<void> {
-  const flags = await getAdditionFlags(addition);
-
-  if (!flags || flags.length === 0) {
-    return;
-  }
-
-  const missingFlags: string[] = [];
-
-  for (const flag of flags) {
-    if (flag.required) {
-      const value = options[flag.name];
-      if (value === undefined || value === null || (Array.isArray(value) && value.length === 0)) {
-        missingFlags.push(flag.name);
-      }
-    }
-  }
-
-  if (missingFlags.length > 0) {
-    const flagDocs = flags.filter((f) => missingFlags.includes(f.name)).map((f) => `  --${f.name}: ${f.description}`);
-
-    throw new Error(
-      `Missing required flag${missingFlags.length > 1 ? 's' : ''}:\n\n` +
-        flagDocs.join('\n') +
-        `\n\nExample: npx @grafana/create-plugin add ${addition.name} --${missingFlags[0]}=value`
-    );
-  }
-}
-
-export async function runAdditionByName(additionName: string, argv: any): Promise<void> {
-  const addition = getAdditionByName(additionName);
-  if (!addition) {
-    const availableAdditions = getAvailableAdditions();
-    const additionsList = Object.keys(availableAdditions);
-    throw new Error(`Unknown addition: ${additionName}\n\nAvailable additions: ${additionsList.join(', ')}`);
-  }
-
-  const options = await parseAdditionFlags(addition, argv);
-  await validateAdditionOptions(addition, options);
-  await runAddition(addition, options);
-}
-
-export async function runAddition(addition: AdditionMeta, additionOptions: AdditionOptions = {}): Promise<void> {
-  const basePath = process.cwd();
-
-  // Check if the feature is already enabled
-  const config = getConfig();
-  if (isFeatureEnabled(config.features, addition.featureName)) {
-    output.log({
-      title: `Addition '${addition.name}' is already enabled`,
-      body: [`The feature flag '${addition.featureName}' is already set to true in .cprc.json.`, 'No changes needed.'],
-    });
-    return;
-  }
-
-  output.log({
-    title: `Running addition: ${addition.name}`,
-    body: [addition.description],
-  });
-
-  try {
-    const context = new Context(basePath);
-    const updatedContext = await executeAddition(addition, context, additionOptions);
-
-    additionsDebug(`context for "${addition.name} (${addition.scriptPath})":`);
-    additionsDebug('%O', updatedContext.listChanges());
-
-    await formatFiles(updatedContext);
-    flushChanges(updatedContext);
-    printChanges(updatedContext, addition.name, addition);
-
-    installNPMDependencies(updatedContext);
-
-    await setFeatureFlag(addition.featureName, true);
-    additionsDebug(`Set feature flag '${addition.featureName}' to true in .cprc.json`);
-
-    output.success({
-      title: `Successfully added ${addition.name} to your plugin.`,
-    });
-  } catch (error) {
-    if (error instanceof Error) {
-      throw new Error(`Error running addition "${addition.name} (${addition.scriptPath})": ${error.message}`);
-    }
-    throw error;
-  }
-}
-
-export async function executeAddition(
-  addition: AdditionMeta,
-  context: Context,
-  options: AdditionOptions = {}
-): Promise<Context> {
-  const module = await loadAdditionModule(addition);
-  if (!module) {
-    throw new Error(`Failed to load addition module for ${addition.name}`);
-  }
-  return module.default(context, options);
-}

package/src/codemods/additions/scripts/add-i18n.test.ts

@@ -1,347 +0,0 @@
-import { describe, expect, it } from 'vitest';
-
-import { Context } from '../../context.js';
-import migrate from './add-i18n.js';
-
-describe('add-i18n', () => {
-  it('should be idempotent', async () => {
-    const context = new Context('/virtual');
-
-    // Set up a minimal plugin structure
-    context.addFile(
-      'src/plugin.json',
-      JSON.stringify({
-        id: 'test-plugin',
-        type: 'panel',
-        name: 'Test Plugin',
-        dependencies: {
-          grafanaDependency: '>=11.0.0',
-        },
-      })
-    );
-    context.addFile('docker-compose.yaml', 'services:\n  grafana:\n    environment:\n      FOO: bar');
-    context.addFile('package.json', JSON.stringify({ dependencies: {}, devDependencies: {} }));
-    context.addFile(
-      'eslint.config.mjs',
-      'import { defineConfig } from "eslint/config";\nexport default defineConfig([]);'
-    );
-    context.addFile(
-      'src/module.ts',
-      'import { PanelPlugin } from "@grafana/data";\nexport const plugin = new PanelPlugin();'
-    );
-
-    const migrateWithOptions = (ctx: Context) => migrate(ctx, { locales: ['en-US'] });
-    await expect(migrateWithOptions).toBeIdempotent(context);
-  });
-
-  it('should add i18n support with a single locale (backward compatibility for Grafana < 12.1.0)', () => {
-    const context = new Context('/virtual');
-
-    // Set up a minimal plugin structure with Grafana 11.0.0 (needs backward compatibility)
-    context.addFile(
-      'src/plugin.json',
-      JSON.stringify({
-        id: 'test-plugin',
-        type: 'panel',
-        name: 'Test Plugin',
-        dependencies: {
-          grafanaDependency: '>=11.0.0',
-        },
-      })
-    );
-    context.addFile(
-      'docker-compose.yaml',
-      `services:
-  grafana:
-    environment:
-      FOO: bar`
-    );
-    context.addFile('package.json', JSON.stringify({ dependencies: {}, devDependencies: {}, scripts: {} }));
-    context.addFile(
-      'eslint.config.mjs',
-      'import { defineConfig } from "eslint/config";\nexport default defineConfig([]);'
-    );
-    context.addFile(
-      'src/module.ts',
-      'import { PanelPlugin } from "@grafana/data";\nexport const plugin = new PanelPlugin();'
-    );
-
-    const result = migrate(context, { locales: ['en-US'] });
-
-    // Check plugin.json was updated
-    const pluginJson = JSON.parse(result.getFile('src/plugin.json') || '{}');
-    expect(pluginJson.languages).toEqual(['en-US']);
-    // Should stay at 11.0.0 for backward compatibility
-    expect(pluginJson.dependencies.grafanaDependency).toBe('>=11.0.0');
-
-    // Check locale file was created with example translations
-    expect(result.doesFileExist('src/locales/en-US/test-plugin.json')).toBe(true);
-    const localeContent = result.getFile('src/locales/en-US/test-plugin.json');
-    const localeData = JSON.parse(localeContent || '{}');
-    expect(localeData).toHaveProperty('components');
-    expect(localeData).toHaveProperty('config');
-
-    // Check package.json was updated with dependencies
-    const packageJson = JSON.parse(result.getFile('package.json') || '{}');
-    expect(packageJson.dependencies['@grafana/i18n']).toBe('12.2.2');
-    expect(packageJson.dependencies['semver']).toBe('^7.6.0');
-    expect(packageJson.devDependencies['@types/semver']).toBe('^7.5.0');
-    expect(packageJson.devDependencies['i18next-cli']).toBeDefined();
-    expect(packageJson.scripts['i18n-extract']).toBe('i18next-cli extract --sync-primary');
-
-    // Check docker-compose.yaml was NOT updated (backward compat doesn't add feature toggle)
-    const dockerCompose = result.getFile('docker-compose.yaml');
-    expect(dockerCompose).not.toContain('localizationForPlugins');
-
-    // Check module.ts was updated with backward compatibility code
-    const moduleTs = result.getFile('src/module.ts');
-    expect(moduleTs).toContain('initPluginTranslations');
-    expect(moduleTs).toContain('semver');
-    expect(moduleTs).toContain('loadResources');
-
-    // Check loadResources.ts was created for backward compatibility
-    expect(result.doesFileExist('src/loadResources.ts')).toBe(true);
-    const loadResources = result.getFile('src/loadResources.ts');
-    expect(loadResources).toContain('ResourceLoader');
-
-    // Check i18next.config.ts was created
-    expect(result.doesFileExist('i18next.config.ts')).toBe(true);
-    const i18nextConfig = result.getFile('i18next.config.ts');
-    expect(i18nextConfig).toContain('defineConfig');
-    expect(i18nextConfig).toContain('pluginJson.id');
-  });
-
-  it('should add i18n support with multiple locales', () => {
-    const context = new Context('/virtual');
-
-    context.addFile(
-      'src/plugin.json',
-      JSON.stringify({
-        id: 'test-plugin',
-        type: 'panel',
-        name: 'Test Plugin',
-        dependencies: {
-          grafanaDependency: '>=11.0.0',
-        },
-      })
-    );
-    context.addFile(
-      'docker-compose.yaml',
-      `services:
-  grafana:
-    environment:
-      FOO: bar`
-    );
-    context.addFile('package.json', JSON.stringify({ dependencies: {}, devDependencies: {}, scripts: {} }));
-    context.addFile(
-      'eslint.config.mjs',
-      'import { defineConfig } from "eslint/config";\nexport default defineConfig([]);'
-    );
-    context.addFile(
-      'src/module.ts',
-      'import { PanelPlugin } from "@grafana/data";\nexport const plugin = new PanelPlugin();'
-    );
-
-    const result = migrate(context, { locales: ['en-US', 'es-ES', 'sv-SE'] });
-
-    // Check plugin.json has all locales
-    const pluginJson = JSON.parse(result.getFile('src/plugin.json') || '{}');
-    expect(pluginJson.languages).toEqual(['en-US', 'es-ES', 'sv-SE']);
-
-    // Check all locale files were created
-    expect(result.doesFileExist('src/locales/en-US/test-plugin.json')).toBe(true);
-    expect(result.doesFileExist('src/locales/es-ES/test-plugin.json')).toBe(true);
-    expect(result.doesFileExist('src/locales/sv-SE/test-plugin.json')).toBe(true);
-  });
-
-  it('should skip if i18n is already configured', () => {
-    const context = new Context('/virtual');
-
-    // Set up a plugin with i18n already configured
-    context.addFile(
-      'src/plugin.json',
-      JSON.stringify({
-        id: 'test-plugin',
-        type: 'panel',
-        name: 'Test Plugin',
-        languages: ['en-US'], // Already configured
-        dependencies: {
-          grafanaDependency: '>=12.1.0',
-        },
-      })
-    );
-    context.addFile(
-      'docker-compose.yaml',
-      `services:
-  grafana:
-    environment:
-      FOO: bar`
-    );
-    context.addFile('package.json', JSON.stringify({ dependencies: {}, devDependencies: {}, scripts: {} }));
-    context.addFile(
-      'eslint.config.mjs',
-      'import { defineConfig } from "eslint/config";\nexport default defineConfig([]);'
-    );
-    context.addFile(
-      'src/module.ts',
-      'import { PanelPlugin } from "@grafana/data";\nimport { i18n } from "@grafana/i18n";\nexport const plugin = new PanelPlugin();'
-    );
-
-    // Flush the context to simulate these files existing on "disk"
-    const initialChanges = Object.keys(context.listChanges()).length;
-
-    const result = migrate(context, { locales: ['es-ES'] });
-
-    // Should not add any NEW changes beyond the initial setup
-    const finalChanges = Object.keys(result.listChanges()).length;
-    expect(finalChanges).toBe(initialChanges);
-  });
-
-  it('should handle existing feature toggles in docker-compose.yaml (Grafana >= 12.1.0)', () => {
-    const context = new Context('/virtual');
-
-    context.addFile(
-      'src/plugin.json',
-      JSON.stringify({
-        id: 'test-plugin',
-        type: 'panel',
-        name: 'Test Plugin',
-        dependencies: {
-          grafanaDependency: '>=12.1.0',
-        },
-      })
-    );
-    context.addFile(
-      'docker-compose.yaml',
-      `services:
-  grafana:
-    environment:
-      GF_FEATURE_TOGGLES_ENABLE: someOtherFeature`
-    );
-    context.addFile('package.json', JSON.stringify({ dependencies: {}, devDependencies: {}, scripts: {} }));
-    context.addFile(
-      'eslint.config.mjs',
-      'import { defineConfig } from "eslint/config";\nexport default defineConfig([]);'
-    );
-    context.addFile(
-      'src/module.ts',
-      'import { PanelPlugin } from "@grafana/data";\nexport const plugin = new PanelPlugin();'
-    );
-
-    const result = migrate(context, { locales: ['en-US'] });
-
-    const dockerCompose = result.getFile('docker-compose.yaml');
-    expect(dockerCompose).toContain('someOtherFeature,localizationForPlugins');
-  });
-
-  it('should work with module.tsx instead of module.ts', () => {
-    const context = new Context('/virtual');
-
-    context.addFile(
-      'src/plugin.json',
-      JSON.stringify({
-        id: 'test-plugin',
-        type: 'panel',
-        name: 'Test Plugin',
-        dependencies: {
-          grafanaDependency: '>=11.0.0',
-        },
-      })
-    );
-    context.addFile(
-      'docker-compose.yaml',
-      `services:
-  grafana:
-    environment:
-      FOO: bar`
-    );
-    context.addFile('package.json', JSON.stringify({ dependencies: {}, devDependencies: {}, scripts: {} }));
-    context.addFile(
-      'eslint.config.mjs',
-      'import { defineConfig } from "eslint/config";\nexport default defineConfig([]);'
-    );
-    context.addFile(
-      'src/module.tsx',
-      'import { PanelPlugin } from "@grafana/data";\nexport const plugin = new PanelPlugin();'
-    );
-
-    const result = migrate(context, { locales: ['en-US'] });
-
-    const moduleTsx = result.getFile('src/module.tsx');
-    expect(moduleTsx).toContain('@grafana/i18n');
-  });
-
-  it('should not update grafanaDependency if it is already >= 12.1.0', () => {
-    const context = new Context('/virtual');
-
-    context.addFile(
-      'src/plugin.json',
-      JSON.stringify({
-        id: 'test-plugin',
-        type: 'panel',
-        name: 'Test Plugin',
-        dependencies: {
-          grafanaDependency: '>=13.0.0',
-        },
-      })
-    );
-    context.addFile(
-      'docker-compose.yaml',
-      `services:
-  grafana:
-    environment:
-      FOO: bar`
-    );
-    context.addFile('package.json', JSON.stringify({ dependencies: {}, devDependencies: {}, scripts: {} }));
-    context.addFile(
-      'eslint.config.mjs',
-      'import { defineConfig } from "eslint/config";\nexport default defineConfig([]);'
-    );
-    context.addFile(
-      'src/module.ts',
-      'import { PanelPlugin } from "@grafana/data";\nexport const plugin = new PanelPlugin();'
-    );
-
-    const result = migrate(context, { locales: ['en-US'] });
-
-    const pluginJson = JSON.parse(result.getFile('src/plugin.json') || '{}');
-    expect(pluginJson.dependencies.grafanaDependency).toBe('>=13.0.0');
-  });
-
-  it('should handle plugins without existing scripts in package.json', () => {
-    const context = new Context('/virtual');
-
-    context.addFile(
-      'src/plugin.json',
-      JSON.stringify({
-        id: 'test-plugin',
-        type: 'panel',
-        name: 'Test Plugin',
-        dependencies: {
-          grafanaDependency: '>=11.0.0',
-        },
-      })
-    );
-    context.addFile(
-      'docker-compose.yaml',
-      `services:
-  grafana:
-    environment:
-      FOO: bar`
-    );
-    context.addFile('package.json', JSON.stringify({ dependencies: {}, devDependencies: {} })); // No scripts field
-    context.addFile(
-      'eslint.config.mjs',
-      'import { defineConfig } from "eslint/config";\nexport default defineConfig([]);'
-    );
-    context.addFile(
-      'src/module.ts',
-      'import { PanelPlugin } from "@grafana/data";\nexport const plugin = new PanelPlugin();'
-    );
-
-    const result = migrate(context, { locales: ['en-US'] });
-
-    const packageJson = JSON.parse(result.getFile('package.json') || '{}');
-    expect(packageJson.scripts['i18n-extract']).toBe('i18next-cli extract --sync-primary');
-  });
-});