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

package/CHANGELOG.md

@@ -1,3 +1,20 @@
+# v6.5.0 (Wed Dec 17 2025)
+
+:tada: This release contains work from a new contributor! :tada:
+
+Thank you, Joonseo Lee ([@joonseolee](https://github.com/joonseolee)), for all your work!
+
+#### 🚀 Enhancement
+
+- feat: add dependabot config for plugins [#2248](https://github.com/grafana/plugin-tools/pull/2248) ([@joonseolee](https://github.com/joonseolee) [@jackw](https://github.com/jackw))
+
+#### Authors: 2
+
+- Jack Westbrook ([@jackw](https://github.com/jackw))
+- Joonseo Lee ([@joonseolee](https://github.com/joonseolee))
+
+---
+
 # v6.4.4 (Fri Dec 12 2025)
 
 #### 🐛 Bug Fix

package/dist/codemods/additions/additions.js

@@ -1,8 +1,8 @@
 var defaultAdditions = [
   {
-    name: "i18n",
-    description: "Adds internationalization (i18n) support to the plugin",
-    scriptPath: import.meta.resolve("./scripts/i18n/index.js")
+    name: "example-addition",
+    description: "Adds an example addition to the plugin",
+    scriptPath: import.meta.resolve("./scripts/example-addition.js")
   }
 ];
 

package/dist/codemods/utils.js

@@ -205,6 +205,6 @@ function sortObjectByKeys(obj) {
   return Object.keys(obj).sort().reduce((acc, key) => ({ ...acc, [key]: obj[key] }), {});
 }
 const migrationsDebug = debug.extend("migrations");
-const additionsDebug = debug.extend("additions");
+debug.extend("additions");
 
-export { addDependenciesToPackageJson, additionsDebug, flushChanges, formatFiles, installNPMDependencies, isVersionGreater, migrationsDebug, printChanges, readJsonFile, removeDependenciesFromPackageJson };
+export { addDependenciesToPackageJson, flushChanges, formatFiles, installNPMDependencies, isVersionGreater, migrationsDebug, printChanges, readJsonFile, removeDependenciesFromPackageJson };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/create-plugin",
-  "version": "6.5.0-canary.2320.20268376971.0",
+  "version": "6.5.0",
   "repository": {
     "directory": "packages/create-plugin",
     "url": "https://github.com/grafana/plugin-tools"
@@ -56,5 +56,5 @@
   "engines": {
     "node": ">=20"
   },
-  "gitHead": "47d4c2ff4f55df3a644771982994d0c85ec7d96d"
+  "gitHead": "a143221c100f1402e6f430997383830439749d40"
 }

package/src/codemods/AGENTS.md

@@ -5,24 +5,17 @@ This guide provides specific instructions for working with migrations and additi
 ## Agent Behavior
 
 - Refer to current migrations and additions typescript files found in @./additions/scripts and @./migrations/scripts
+- When creating a new migration add it to the exported migrations object in @./migrations/migrations.ts
 - Always refer to @./context.ts to know what methods are available on the context class
 - Always check for file existence using the @./context.ts class before attempting to do anything with it
 - Never write files with any 3rd party npm library. Use the context for all file operations
-- Always return the context for the next migration/addition
+- Always return the context for the next migration
 - Test thoroughly using the provided utils in @./test-utils.ts where necessary
-- Never attempt to read or write files outside the current working directory
-
-## Migrations
-
-Migrations are automatically run during `create-plugin update` to keep plugins compatible with newer versions of the tooling. They are forced upon developers to ensure compatibility and are versioned based on the create-plugin version. Migrations primarily target configuration files or files that are scaffolded by create-plugin.
-
-### Migration Behavior
-
-- When creating a new migration add it to the exported migrations object in @./migrations/migrations.ts
 - Each migration must be idempotent and must include a test case that uses the `.toBeIdempotent` custom matcher found in @../../vitest.setup.ts
 - Keep migrations focused on one task
+- Never attempt to read or write files outside the current working directory
 
-### Migration Naming Conventions
+## Naming Conventions
 
 - Each migration lives under @./migrations/scripts
 - Migration filenames follow the format: `NNN-migration-title` where migration-title is, at the most, a three word summary of what the migration does and NNN is the next number in sequence based on the current file name in @./migrations/scripts
@@ -30,16 +23,3 @@ Migrations are automatically run during `create-plugin update` to keep plugins c
   - `NNN-migration-title.ts` - main migration logic
   - `NNN-migration-title.test.ts` - migration logic tests
 - Each migration should export a default function named "migrate"
-
-## Additions
-
-Additions are optional features that developers choose to add via `create-plugin add`. They are not versioned and can be run at any time to enhance a plugin with new capabilities.
-
-### Addition Behavior
-
-- Additions add new features or capabilities to a plugin (e.g., i18n support, testing frameworks, etc.)
-- It should be safe to run multiple times
-- Always use defensive programming: check if features already exist before adding them
-- Use `additionsDebug()` for logging to help with troubleshooting
-- If the addition accepts user input, export a `schema` object using `valibot` for input validation
-- Each addition should export a default function that takes `(context: Context, options?: T)` and returns `Context`

package/src/codemods/additions/additions.ts

@@ -2,8 +2,8 @@ import { Codemod } from '../types.js';
 
 export default [
   {
-    name: 'i18n',
-    description: 'Adds internationalization (i18n) support to the plugin',
-    scriptPath: import.meta.resolve('./scripts/i18n/index.js'),
+    name: 'example-addition',
+    description: 'Adds an example addition to the plugin',
+    scriptPath: import.meta.resolve('./scripts/example-addition.js'),
   },
 ] satisfies Codemod[];

package/templates/panel/src/plugin.json

@@ -19,7 +19,7 @@
     "updated": "%TODAY%"
   },
   "dependencies": {
-    "grafanaDependency": ">=11.5.0",
+    "grafanaDependency": ">=10.4.0",
     "plugins": []
   }
 }

package/dist/codemods/additions/scripts/i18n/code-generation.js

@@ -1,122 +0,0 @@
-import * as recast from 'recast';
-import * as babelParser from 'recast/parsers/babel-ts.js';
-import { additionsDebug } from '../../../utils.js';
-
-const { builders } = recast.types;
-function addI18nInitialization(context, needsBackwardCompatibility) {
-  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;
-  }
-  if (moduleContent.includes("initPluginTranslations")) {
-    additionsDebug("i18n already initialized in module file");
-    return;
-  }
-  try {
-    const ast = recast.parse(moduleContent, {
-      parser: babelParser
-    });
-    const imports = [];
-    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")
-        )
-      );
-    }
-    const lastImportIndex = ast.program.body.findLastIndex((node) => node.type === "ImportDeclaration");
-    if (lastImportIndex !== -1) {
-      ast.program.body.splice(lastImportIndex + 1, 0, ...imports);
-    } else {
-      ast.program.body.unshift(...imports);
-    }
-    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);`;
-    const initAst = recast.parse(i18nInitCode, {
-      parser: babelParser
-    });
-    const finalLastImportIndex = ast.program.body.findLastIndex((node) => 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);
-  }
-}
-function createLoadResourcesFile(context) {
-  const loadResourcesPath = "src/loadResources.ts";
-  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");
-}
-
-export { addI18nInitialization, createLoadResourcesFile };

package/dist/codemods/additions/scripts/i18n/config-updates.js

@@ -1,250 +0,0 @@
-import { coerce, gte } from 'semver';
-import { parseDocument, stringify } from 'yaml';
-import * as recast from 'recast';
-import * as typeScriptParser from 'recast/parsers/typescript.js';
-import { additionsDebug } from '../../../utils.js';
-
-const { builders } = recast.types;
-function updateDockerCompose(context) {
-  if (!context.doesFileExist("docker-compose.yaml")) {
-    additionsDebug("docker-compose.yaml not found, skipping");
-    return;
-  }
-  const composeContent = context.getFile("docker-compose.yaml");
-  if (!composeContent) {
-    return;
-  }
-  try {
-    const composeDoc = parseDocument(composeContent);
-    const currentEnv = composeDoc.getIn(["services", "grafana", "environment"]);
-    if (!currentEnv) {
-      additionsDebug("No environment section found in docker-compose.yaml, skipping");
-      return;
-    }
-    if (typeof currentEnv === "object") {
-      const envMap = currentEnv;
-      const toggleValue = envMap.get("GF_FEATURE_TOGGLES_ENABLE");
-      if (toggleValue) {
-        const toggleStr = toggleValue.toString();
-        if (toggleStr.includes("localizationForPlugins")) {
-          additionsDebug("localizationForPlugins already in GF_FEATURE_TOGGLES_ENABLE");
-          return;
-        }
-        composeDoc.setIn(
-          ["services", "grafana", "environment", "GF_FEATURE_TOGGLES_ENABLE"],
-          `${toggleStr},localizationForPlugins`
-        );
-      } else {
-        composeDoc.setIn(["services", "grafana", "environment", "GF_FEATURE_TOGGLES_ENABLE"], "localizationForPlugins");
-      }
-      context.updateFile("docker-compose.yaml", stringify(composeDoc));
-      additionsDebug("Updated docker-compose.yaml with localizationForPlugins feature toggle");
-    }
-  } catch (error) {
-    additionsDebug("Error updating docker-compose.yaml:", error);
-  }
-}
-function updatePluginJson(context, locales, needsBackwardCompatibility) {
-  if (!context.doesFileExist("src/plugin.json")) {
-    additionsDebug("src/plugin.json not found, skipping");
-    return;
-  }
-  const pluginJsonRaw = context.getFile("src/plugin.json");
-  if (!pluginJsonRaw) {
-    return;
-  }
-  try {
-    const pluginJson = JSON.parse(pluginJsonRaw);
-    const existingLanguages = Array.isArray(pluginJson.languages) ? pluginJson.languages : [];
-    const mergedLanguages = [.../* @__PURE__ */ new Set([...existingLanguages, ...locales])];
-    pluginJson.languages = mergedLanguages;
-    if (!pluginJson.dependencies) {
-      pluginJson.dependencies = {};
-    }
-    const currentGrafanaDep = pluginJson.dependencies.grafanaDependency || ">=11.0.0";
-    const targetVersion = needsBackwardCompatibility ? "11.0.0" : "12.1.0";
-    const minVersion = coerce(targetVersion);
-    const currentVersion = coerce(currentGrafanaDep.replace(/^[><=]+/, ""));
-    if (!currentVersion || !minVersion || !gte(currentVersion, minVersion)) {
-      pluginJson.dependencies.grafanaDependency = `>=${targetVersion}`;
-      additionsDebug(`Updated grafanaDependency to >=${targetVersion}`);
-    }
-    context.updateFile("src/plugin.json", JSON.stringify(pluginJson, null, 2));
-    additionsDebug("Updated src/plugin.json with languages:", locales);
-  } catch (error) {
-    additionsDebug("Error updating src/plugin.json:", error);
-  }
-}
-function createI18nextConfig(context) {
-  if (context.doesFileExist("i18next.config.ts")) {
-    additionsDebug("i18next.config.ts already exists, skipping");
-    return;
-  }
-  const pluginJsonRaw = context.getFile("src/plugin.json");
-  if (!pluginJsonRaw) {
-    additionsDebug("Cannot create i18next.config.ts 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;
-    }
-    const i18nextConfig = `import { defineConfig } from 'i18next-cli';
-import pluginJson from './src/plugin.json';
-
-export default defineConfig({
-  locales: pluginJson.languages,
-  extract: {
-    input: ['src/**/*.{tsx,ts}'],
-    output: 'src/locales/{{language}}/{{namespace}}.json',
-    defaultNS: pluginJson.id,
-    functions: ['t', '*.t'],
-    transComponents: ['Trans'],
-  },
-});
-`;
-    context.addFile("i18next.config.ts", i18nextConfig);
-    additionsDebug("Created i18next.config.ts");
-  } catch (error) {
-    additionsDebug("Error creating i18next.config.ts:", error);
-  }
-}
-function addI18nextToExternalsArray(externalsArray) {
-  const hasI18next = externalsArray.elements.some((element) => {
-    if (element && (element.type === "Literal" || element.type === "StringLiteral") && typeof element.value === "string") {
-      return element.value === "i18next";
-    }
-    return false;
-  });
-  if (hasI18next) {
-    additionsDebug("'i18next' already in externals array");
-    return false;
-  }
-  externalsArray.elements.push(builders.literal("i18next"));
-  additionsDebug("Added 'i18next' to externals array");
-  return true;
-}
-function ensureI18nextExternal(context) {
-  try {
-    additionsDebug("Checking for externals configuration...");
-    const externalsPath = ".config/bundler/externals.ts";
-    if (context.doesFileExist(externalsPath)) {
-      additionsDebug(`Found ${externalsPath}, checking for i18next...`);
-      const externalsContent = context.getFile(externalsPath);
-      if (externalsContent) {
-        try {
-          const ast = recast.parse(externalsContent, {
-            parser: typeScriptParser
-          });
-          let hasChanges = false;
-          recast.visit(ast, {
-            visitVariableDeclarator(path) {
-              const { node } = path;
-              if (node.id.type === "Identifier" && node.id.name === "externals" && node.init && node.init.type === "ArrayExpression") {
-                additionsDebug("Found externals array in externals.ts");
-                if (addI18nextToExternalsArray(node.init)) {
-                  hasChanges = true;
-                }
-              }
-              return this.traverse(path);
-            }
-          });
-          if (hasChanges) {
-            const output = recast.print(ast, {
-              tabWidth: 2,
-              trailingComma: true,
-              lineTerminator: "\n"
-            });
-            context.updateFile(externalsPath, output.code);
-            additionsDebug(`Updated ${externalsPath} with i18next external`);
-          }
-          return;
-        } catch (error) {
-          additionsDebug(`Error updating ${externalsPath}:`, error);
-        }
-      }
-    }
-    const webpackConfigPath = ".config/webpack/webpack.config.ts";
-    additionsDebug(`Checking for ${webpackConfigPath}...`);
-    if (context.doesFileExist(webpackConfigPath)) {
-      additionsDebug(`Found ${webpackConfigPath}, checking for inline externals...`);
-      const webpackContent = context.getFile(webpackConfigPath);
-      if (webpackContent) {
-        try {
-          const ast = recast.parse(webpackContent, {
-            parser: typeScriptParser
-          });
-          let hasChanges = false;
-          let foundExternals = false;
-          recast.visit(ast, {
-            visitObjectExpression(path) {
-              const { node } = path;
-              const properties = node.properties;
-              if (properties) {
-                for (const prop of properties) {
-                  if (prop && (prop.type === "Property" || prop.type === "ObjectProperty")) {
-                    const key = "key" in prop ? prop.key : null;
-                    const value = "value" in prop ? prop.value : null;
-                    if (key && key.type === "Identifier" && key.name === "externals" && value && value.type === "ArrayExpression") {
-                      foundExternals = true;
-                      additionsDebug("Found externals property in webpack.config.ts");
-                      if (addI18nextToExternalsArray(value)) {
-                        hasChanges = true;
-                      }
-                    }
-                  }
-                }
-              }
-              return this.traverse(path);
-            },
-            visitProperty(path) {
-              const { node } = path;
-              if (node.key && node.key.type === "Identifier" && node.key.name === "externals" && node.value && node.value.type === "ArrayExpression") {
-                if (!foundExternals) {
-                  foundExternals = true;
-                  additionsDebug("Found externals property in webpack.config.ts (via visitProperty)");
-                }
-                if (addI18nextToExternalsArray(node.value)) {
-                  hasChanges = true;
-                }
-              }
-              return this.traverse(path);
-            }
-          });
-          if (!foundExternals) {
-            additionsDebug("No externals property found in webpack.config.ts");
-          }
-          if (hasChanges) {
-            const output = recast.print(ast, {
-              tabWidth: 2,
-              trailingComma: true,
-              lineTerminator: "\n"
-            });
-            context.updateFile(webpackConfigPath, output.code);
-            additionsDebug(`Updated ${webpackConfigPath} with i18next external`);
-          } else if (foundExternals) {
-            additionsDebug("i18next already present in externals, no changes needed");
-          }
-          return;
-        } catch (error) {
-          additionsDebug(`Error updating ${webpackConfigPath}:`, error);
-          additionsDebug(`Error details: ${error instanceof Error ? error.message : String(error)}`);
-        }
-      } else {
-        additionsDebug(`File ${webpackConfigPath} exists but content is empty`);
-      }
-    } else {
-      additionsDebug(`File ${webpackConfigPath} does not exist`);
-    }
-    additionsDebug("No externals configuration found, skipping i18next external check");
-  } catch (error) {
-    additionsDebug(
-      `Unexpected error in ensureI18nextExternal: ${error instanceof Error ? error.message : String(error)}`
-    );
-  }
-}
-
-export { createI18nextConfig, ensureI18nextExternal, updateDockerCompose, updatePluginJson };

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

@@ -1,64 +0,0 @@
-import * as v from 'valibot';
-import { additionsDebug } from '../../../utils.js';
-import { updateDockerCompose, updatePluginJson, createI18nextConfig, ensureI18nextExternal } from './config-updates.js';
-import { addI18nInitialization, createLoadResourcesFile } from './code-generation.js';
-import { addI18nDependency, addSemverDependency, updateEslintConfig, addI18nextCli } from './tooling.js';
-import { checkReactVersion, checkNeedsBackwardCompatibility, createLocaleFiles } from './utils.js';
-
-const schema = v.object(
-  {
-    locales: v.pipe(
-      v.union([v.string(), v.array(v.string())]),
-      v.transform((input) => {
-        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"'
-);
-function i18nAddition(context, options) {
-  const { locales } = options;
-  additionsDebug("Adding i18n support with locales:", locales);
-  checkReactVersion(context);
-  const needsBackwardCompatibility = checkNeedsBackwardCompatibility(context);
-  additionsDebug("Needs backward compatibility:", needsBackwardCompatibility);
-  updateDockerCompose(context);
-  updatePluginJson(context, locales, needsBackwardCompatibility);
-  createLocaleFiles(context, locales);
-  addI18nDependency(context);
-  if (needsBackwardCompatibility) {
-    addSemverDependency(context);
-  }
-  updateEslintConfig(context);
-  addI18nInitialization(context, needsBackwardCompatibility);
-  if (needsBackwardCompatibility) {
-    createLoadResourcesFile(context);
-  }
-  addI18nextCli(context);
-  createI18nextConfig(context);
-  try {
-    ensureI18nextExternal(context);
-  } catch (error) {
-    additionsDebug(`Error ensuring i18next external: ${error instanceof Error ? error.message : String(error)}`);
-  }
-  additionsDebug("\n\u2705 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;
-}
-
-export { i18nAddition as default, schema };