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

package/dist/codemods/additions/scripts/i18n/tooling.js

@@ -1,121 +0,0 @@
-import * as recast from 'recast';
-import * as babelParser from 'recast/parsers/babel-ts.js';
-import { addDependenciesToPackageJson, additionsDebug } from '../../../utils.js';
-
-const { builders } = recast.types;
-function addI18nDependency(context) {
-  addDependenciesToPackageJson(context, { "@grafana/i18n": "^12.2.2" }, {});
-  additionsDebug("Added @grafana/i18n dependency version ^12.2.2");
-}
-function addSemverDependency(context) {
-  addDependenciesToPackageJson(context, { semver: "^7.6.0" }, { "@types/semver": "^7.5.0" });
-  additionsDebug("Added semver dependency");
-}
-function addI18nextCli(context) {
-  addDependenciesToPackageJson(context, {}, { "i18next-cli": "^1.1.1" });
-  const packageJsonRaw = context.getFile("package.json");
-  if (!packageJsonRaw) {
-    return;
-  }
-  try {
-    const packageJson = JSON.parse(packageJsonRaw);
-    if (!packageJson.scripts) {
-      packageJson.scripts = {};
-    }
-    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);
-  }
-}
-function updateEslintConfig(context) {
-  if (!context.doesFileExist("eslint.config.mjs")) {
-    additionsDebug("eslint.config.mjs not found, skipping");
-    return;
-  }
-  const eslintConfigRaw = context.getFile("eslint.config.mjs");
-  if (!eslintConfigRaw) {
-    return;
-  }
-  if (eslintConfigRaw.includes("@grafana/i18n/eslint-plugin")) {
-    additionsDebug("ESLint i18n rule already configured");
-    return;
-  }
-  try {
-    const ast = recast.parse(eslintConfigRaw, {
-      parser: babelParser
-    });
-    const imports = ast.program.body.filter((node) => node.type === "ImportDeclaration");
-    const lastImport = imports[imports.length - 1];
-    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 {
-      ast.program.body.unshift(pluginImport);
-    }
-    recast.visit(ast, {
-      visitCallExpression(path) {
-        if (path.node.callee.name === "defineConfig" && path.node.arguments[0]?.type === "ArrayExpression") {
-          const configArray = path.node.arguments[0];
-          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);
-  }
-}
-
-export { addI18nDependency, addI18nextCli, addSemverDependency, updateEslintConfig };

package/dist/codemods/additions/scripts/i18n/utils.js

@@ -1,83 +0,0 @@
-import { coerce, gte } from 'semver';
-import { additionsDebug } from '../../../utils.js';
-
-function checkReactVersion(context) {
-  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}.
-
-Please upgrade to React 18+ to use i18n support.
-Update your package.json to use "react": "^18.3.0" and "react-dom": "^18.3.0".`
-        );
-      }
-    }
-  } catch (error) {
-    if (error instanceof Error && error.message.includes("@grafana/i18n requires React")) {
-      throw error;
-    }
-    additionsDebug("Error checking React version:", error);
-  }
-}
-function checkNeedsBackwardCompatibility(context) {
-  const pluginJsonRaw = context.getFile("src/plugin.json");
-  if (!pluginJsonRaw) {
-    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 (currentVersion && minVersion && gte(currentVersion, minVersion)) {
-      return false;
-    }
-    return true;
-  } catch (error) {
-    additionsDebug("Error checking backward compatibility:", error);
-    return true;
-  }
-}
-function createLocaleFiles(context, locales) {
-  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;
-    }
-    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);
-  }
-}
-
-export { checkNeedsBackwardCompatibility, checkReactVersion, createLocaleFiles };

package/src/codemods/additions/scripts/i18n/README.md

@@ -1,161 +0,0 @@
-# I18n Addition
-
-Adds internationalization (i18n) support to a Grafana plugin.
-
-## Usage
-
-```bash
-npx @grafana/create-plugin add i18n --locales <locales>
-```
-
-## Requirements
-
-- **Grafana >= 11.0.0**: i18n is not supported for Grafana versions prior to 11.0.0. If your plugin's `grafanaDependency` is set to a version < 11.0.0, the script will automatically update it to `>=11.0.0` (it will not exit with an error).
-- **React >= 18**: The `@grafana/i18n` package requires React 18 or higher. If your plugin uses React < 18, the script will exit with an error and prompt you to upgrade.
-
-## Required Flags
-
-### `--locales`
-
-A comma-separated list of locale codes to support in your plugin.
-
-**Format:** Locale codes must follow the `xx-XX` pattern (e.g., `en-US`, `es-ES`, `sv-SE`)
-
-**Example:**
-
-```bash
-npx @grafana/create-plugin add i18n --locales en-US,es-ES,sv-SE
-```
-
-## What This Addition Does
-
-**Important:** This script sets up the infrastructure and configuration needed for translations. After running this script, you'll need to:
-
-1. Mark up your code with translation functions (`t()` and `<Trans>`)
-2. Run `npm run i18n-extract` to extract translatable strings
-3. Fill in the locale JSON files with translated strings
-
-This addition configures your plugin for internationalization by:
-
-1. **Updating `docker-compose.yaml`** - Adds the `localizationForPlugins` feature toggle to your local Grafana instance
-2. **Updating `src/plugin.json`** - Adds the `languages` array and updates `grafanaDependency`
-3. **Creating locale files** - Creates empty JSON files for each locale at `src/locales/{locale}/{pluginId}.json`
-4. **Adding dependencies** - Installs `@grafana/i18n` and optionally `semver` (for backward compatibility)
-5. **Updating ESLint config** - Adds i18n linting rules to catch untranslated strings
-6. **Initializing i18n in module.ts** - Adds `initPluginTranslations()` call to your plugin's entry point
-7. **Creating support files**:
-   - `i18next.config.ts` - Configuration for extracting translations
-   - `src/loadResources.ts` - (Only for Grafana < 12.1.0) Custom resource loader
-8. **Adding npm scripts** - Adds `i18n-extract` script to extract translations from your code
-
-## Backward Compatibility
-
-**Note:** i18n is not supported for Grafana versions prior to 11.0.0.
-
-The addition automatically detects your plugin's `grafanaDependency` version:
-
-### Grafana >= 12.1.0
-
-- Sets `grafanaDependency` to `>=12.1.0`
-- Grafana handles loading translations automatically
-- Simple initialization: `await initPluginTranslations(pluginJson.id)`
-- No `loadResources.ts` file needed
-- No `semver` dependency needed
-
-### Grafana 11.0.0 - 12.0.x
-
-- Keeps or sets `grafanaDependency` to `>=11.0.0`
-- Plugin handles loading translations
-- Creates `src/loadResources.ts` for custom resource loading
-- Adds runtime version check using `semver`
-- Initialization with loaders: `await initPluginTranslations(pluginJson.id, loaders)`
-
-## Running Multiple Times
-
-This addition can be run multiple times safely. It uses defensive programming to check if configurations already exist before adding them, preventing duplicates and overwrites:
-
-### Adding New Locales
-
-You can run the command again with additional locales to add them:
-
-```bash
-# First run
-npx @grafana/create-plugin add i18n --locales en-US
-
-# Later, add more locales
-npx @grafana/create-plugin add i18n --locales en-US,es-ES,sv-SE
-```
-
-The addition will:
-
-- Merge new locales into `plugin.json` without duplicates
-- Create only the new locale files (won't overwrite existing ones)
-- Skip updating files that already have i18n configured
-
-## Files Created
-
-```
-your-plugin/
-├── docker-compose.yaml              # Modified: adds localizationForPlugins toggle
-├── src/
-│   ├── plugin.json                  # Modified: adds languages array
-│   ├── module.ts                    # Modified: adds i18n initialization
-│   ├── loadResources.ts            # Created: (Grafana 11.x only) resource loader
-│   └── locales/
-│       ├── en-US/
-│       │   └── your-plugin-id.json # Created: empty translation file
-│       ├── es-ES/
-│       │   └── your-plugin-id.json # Created: empty translation file
-│       └── sv-SE/
-│           └── your-plugin-id.json # Created: empty translation file
-├── i18next.config.ts                # Created: extraction config
-├── eslint.config.mjs                # Modified: adds i18n linting rules
-└── package.json                     # Modified: adds dependencies and scripts
-```
-
-## Dependencies Added
-
-**Always:**
-
-- `@grafana/i18n` (v12.2.2) - i18n utilities and types
-- `i18next-cli` (dev) - Translation extraction tool
-
-**For Grafana 11.x only:**
-
-- `semver` - Runtime version checking
-- `@types/semver` (dev) - TypeScript types for semver
-
-## Next Steps
-
-After running this addition:
-
-1. **Use in code**: Import and use the translation functions to mark up your code:
-
-   ```typescript
-   import { t, Trans } from '@grafana/i18n';
-
-   // Use t() for simple strings
-   const title = t('components.myComponent.title', 'Default Title');
-
-   // Use Trans for JSX
-   <Trans i18nKey="components.myComponent.description">
-     This is a description
-   </Trans>
-   ```
-
-2. **Extract translations**: Run `npm run i18n-extract` to scan your code for translatable strings
-3. **Add translations**: Fill in your locale JSON files with translated strings
-
-## Debug Output
-
-Enable debug logging to see what the addition is doing:
-
-```bash
-DEBUG=create-plugin:additions npx @grafana/create-plugin add i18n --locales en-US,es-ES
-```
-
-## References
-
-- [Grafana i18n Documentation](https://grafana.com/developers/plugin-tools/how-to-guides/plugin-internationalization)
-- [Grafana 11.x i18n Documentation](https://grafana.com/developers/plugin-tools/how-to-guides/plugin-internationalization-grafana-11)
-- [Available Languages](https://github.com/grafana/grafana/blob/main/packages/grafana-i18n/src/constants.ts)

package/src/codemods/additions/scripts/i18n/code-generation.ts

@@ -1,158 +0,0 @@
-import * as recast from 'recast';
-import * as babelParser from 'recast/parsers/babel-ts.js';
-
-import type { Context } from '../../../context.js';
-import { additionsDebug } from '../../../utils.js';
-
-const { builders } = recast.types;
-
-export function addI18nInitialization(context: Context, needsBackwardCompatibility: boolean): void {
-  // Find module.ts or module.tsx
-  const moduleTsPath = context.doesFileExist('src/module.ts')
-    ? 'src/module.ts'
-    : context.doesFileExist('src/module.tsx')
-      ? 'src/module.tsx'
-      : null;
-
-  if (!moduleTsPath) {
-    additionsDebug('No module.ts or module.tsx found, skipping i18n initialization');
-    return;
-  }
-
-  const moduleContent = context.getFile(moduleTsPath);
-  if (!moduleContent) {
-    return;
-  }
-
-  // Defensive: check if i18n is already initialized
-  if (moduleContent.includes('initPluginTranslations')) {
-    additionsDebug('i18n already initialized in module file');
-    return;
-  }
-
-  try {
-    const ast = recast.parse(moduleContent, {
-      parser: babelParser,
-    });
-
-    const imports = [];
-
-    // Add necessary imports based on backward compatibility
-    imports.push(
-      builders.importDeclaration(
-        [builders.importSpecifier(builders.identifier('initPluginTranslations'))],
-        builders.literal('@grafana/i18n')
-      )
-    );
-
-    imports.push(
-      builders.importDeclaration(
-        [builders.importDefaultSpecifier(builders.identifier('pluginJson'))],
-        builders.literal('plugin.json')
-      )
-    );
-
-    if (needsBackwardCompatibility) {
-      imports.push(
-        builders.importDeclaration(
-          [builders.importSpecifier(builders.identifier('config'))],
-          builders.literal('@grafana/runtime')
-        )
-      );
-      imports.push(
-        builders.importDeclaration(
-          [builders.importDefaultSpecifier(builders.identifier('semver'))],
-          builders.literal('semver')
-        )
-      );
-      imports.push(
-        builders.importDeclaration(
-          [builders.importSpecifier(builders.identifier('loadResources'))],
-          builders.literal('./loadResources')
-        )
-      );
-    }
-
-    // Find the last import index (use consistent approach for both imports and initialization)
-    const lastImportIndex = ast.program.body.findLastIndex((node: any) => node.type === 'ImportDeclaration');
-
-    // Add imports after the last import statement
-    if (lastImportIndex !== -1) {
-      ast.program.body.splice(lastImportIndex + 1, 0, ...imports);
-    } else {
-      ast.program.body.unshift(...imports);
-    }
-
-    // Add i18n initialization code
-    const i18nInitCode = needsBackwardCompatibility
-      ? `// Before Grafana version 12.1.0 the plugin is responsible for loading translation resources
-// In Grafana version 12.1.0 and later Grafana is responsible for loading translation resources
-const loaders = semver.lt(config?.buildInfo?.version || '0.0.0', '12.1.0') ? [loadResources] : [];
-
-await initPluginTranslations(pluginJson.id, loaders);`
-      : `await initPluginTranslations(pluginJson.id);`;
-
-    // Parse the initialization code and insert it at the top level (after imports)
-    const initAst = recast.parse(i18nInitCode, {
-      parser: babelParser,
-    });
-
-    // Find the last import index again (after adding new imports)
-    const finalLastImportIndex = ast.program.body.findLastIndex((node: any) => node.type === 'ImportDeclaration');
-    if (finalLastImportIndex !== -1) {
-      ast.program.body.splice(finalLastImportIndex + 1, 0, ...initAst.program.body);
-    } else {
-      ast.program.body.unshift(...initAst.program.body);
-    }
-
-    const output = recast.print(ast, {
-      tabWidth: 2,
-      trailingComma: true,
-      lineTerminator: '\n',
-    }).code;
-
-    context.updateFile(moduleTsPath, output);
-    additionsDebug(`Updated ${moduleTsPath} with i18n initialization`);
-  } catch (error) {
-    additionsDebug('Error updating module file:', error);
-  }
-}
-
-export function createLoadResourcesFile(context: Context): void {
-  const loadResourcesPath = 'src/loadResources.ts';
-
-  // Defensive: skip if already exists
-  if (context.doesFileExist(loadResourcesPath)) {
-    additionsDebug('loadResources.ts already exists, skipping');
-    return;
-  }
-
-  const pluginJsonRaw = context.getFile('src/plugin.json');
-  if (!pluginJsonRaw) {
-    additionsDebug('Cannot create loadResources.ts without plugin.json');
-    return;
-  }
-
-  const loadResourcesContent = `import { LANGUAGES, ResourceLoader, Resources } from '@grafana/i18n';
-import pluginJson from 'plugin.json';
-
-const resources = LANGUAGES.reduce<Record<string, () => Promise<{ default: Resources }>>>((acc, lang) => {
-  acc[lang.code] = () => import(\`./locales/\${lang.code}/\${pluginJson.id}.json\`);
-  return acc;
-}, {});
-
-export const loadResources: ResourceLoader = async (resolvedLanguage: string) => {
-  try {
-    const translation = await resources[resolvedLanguage]();
-    return translation.default;
-  } catch (error) {
-    // This makes sure that the plugin doesn't crash when the resolved language in Grafana isn't supported by the plugin
-    console.error(\`The plugin '\${pluginJson.id}' doesn't support the language '\${resolvedLanguage}'\`, error);
-    return {};
-  }
-};
-`;
-
-  context.addFile(loadResourcesPath, loadResourcesContent);
-  additionsDebug('Created src/loadResources.ts for backward compatibility');
-}