@grafana/create-plugin 6.2.0-canary.2233.19424871609.0 → 6.2.0-canary.2233.19500011348.0

package/CHANGELOG.md

@@ -1,3 +1,27 @@
+# v6.1.13 (Wed Nov 19 2025)
+
+#### 🐛 Bug Fix
+
+- Create Plugin: remove types/testing-library__jest-dom [#2250](https://github.com/grafana/plugin-tools/pull/2250) ([@jackw](https://github.com/jackw))
+
+#### Authors: 1
+
+- Jack Westbrook ([@jackw](https://github.com/jackw))
+
+---
+
+# v6.1.12 (Mon Nov 17 2025)
+
+#### 🐛 Bug Fix
+
+- Create Plugin: fix replacing version and plugin id in nested plugins [#2287](https://github.com/grafana/plugin-tools/pull/2287) ([@jackw](https://github.com/jackw))
+
+#### Authors: 1
+
+- Jack Westbrook ([@jackw](https://github.com/jackw))
+
+---
+
 # v6.1.11 (Fri Nov 14 2025)
 
 #### 🐛 Bug Fix

package/dist/codemods/additions/additions.js

@@ -1,7 +1,7 @@
 var defaultAdditions = [
   {
     name: "example-addition",
-    description: "Example addition demonstrating Valibot schema with type inference",
+    description: "Adds an example addition to the plugin",
     scriptPath: import.meta.resolve("./scripts/example-addition.js")
   }
 ];

package/dist/codemods/additions/scripts/example-addition.js

@@ -21,7 +21,7 @@ function exampleAddition(context, options) {
     packageJson.scripts["example-script"] = `echo "Running ${featureName}"`;
     context.updateFile("./package.json", JSON.stringify(packageJson, null, 2));
   }
-  addDependenciesToPackageJson(context, {}, { "example-dev-dep": "^1.0.0" });
+  addDependenciesToPackageJson(context, {}, { "@types/node": "^20.0.0" });
   if (!context.doesFileExist(`./src/features/${featureName}.ts`)) {
     const featureCode = `export const ${featureName} = {
   name: '${featureName}',

package/dist/codemods/migrations/migrations.js

@@ -30,6 +30,18 @@ var defaultMigrations = [
     version: "6.1.9",
     description: "Update React and ReactDOM 18.x versions to ^18.3.0 to surface React 19 compatibility issues.",
     scriptPath: import.meta.resolve("./scripts/005-react-18-3.js")
+  },
+  {
+    name: "006-webpack-nested-fix",
+    version: "6.1.11",
+    description: "Fix webpack variable replacement in nested plugins files.",
+    scriptPath: import.meta.resolve("./scripts/006-webpack-nested-fix.js")
+  },
+  {
+    name: "007-remove-testing-library-types",
+    version: "6.1.13",
+    description: "Add setupTests.d.ts for @testing-library/jest-dom types and remove @types/testing-library__jest-dom npm package.",
+    scriptPath: import.meta.resolve("./scripts/007-remove-testing-library-types.js")
   }
   // Do not use LEGACY_UPDATE_CUTOFF_VERSION for new migrations. It is only used above to force migrations to run
   // for those written before the switch to updates as migrations.

package/dist/codemods/migrations/scripts/004-eslint9-flat-config.js

@@ -4,7 +4,7 @@ import { parse } from 'jsonc-parser';
 import minimist from 'minimist';
 import { resolve, dirname, relative } from 'node:path';
 import * as recast from 'recast';
-import { addDependenciesToPackageJson } from '../../utils.js';
+import { addDependenciesToPackageJson, migrationsDebug } from '../../utils.js';
 
 const { builders } = recast.types;
 const legacyKeysToCopy = ["rules", "settings"];
@@ -317,7 +317,7 @@ function getIgnorePaths(context) {
         }
       }
     } catch (error) {
-      console.log("Error parsing package.json: %s", error);
+      migrationsDebug("Error parsing package.json: %s", error);
     }
   }
   return Array.from(result);

package/dist/codemods/migrations/scripts/006-webpack-nested-fix.js

@@ -0,0 +1,80 @@
+import { join } from 'node:path';
+import * as recast from 'recast';
+import * as typeScriptParser from 'recast/parsers/typescript.js';
+
+const { builders } = recast.types;
+function migrate(context) {
+  const webpackConfigPath = join(".config", "webpack", "webpack.config.ts");
+  if (!context.doesFileExist(webpackConfigPath)) {
+    return context;
+  }
+  const webpackConfigContent = context.getFile(webpackConfigPath);
+  if (!webpackConfigContent) {
+    return context;
+  }
+  let hasChanges = false;
+  const ast = recast.parse(webpackConfigContent, {
+    parser: typeScriptParser
+  });
+  recast.visit(ast, {
+    visitNewExpression(path) {
+      const { node } = path;
+      if (node.callee.type === "Identifier" && node.callee.name === "ReplaceInFileWebpackPlugin" && node.arguments.length > 0) {
+        const firstArg = node.arguments[0];
+        if (firstArg.type === "ArrayExpression" && firstArg.elements) {
+          firstArg.elements.forEach((element) => {
+            if (element && element.type === "ObjectExpression") {
+              const changed = transformFilesProperty(element);
+              if (changed) {
+                hasChanges = true;
+              }
+            }
+          });
+        }
+      }
+      return this.traverse(path);
+    }
+  });
+  if (hasChanges) {
+    const output = recast.print(ast, {
+      tabWidth: 2,
+      trailingComma: true,
+      lineTerminator: "\n"
+    });
+    context.updateFile(webpackConfigPath, output.code);
+  }
+  return context;
+}
+function transformFilesProperty(objectExpression) {
+  const properties = objectExpression.properties;
+  if (!properties) {
+    return false;
+  }
+  const filesPropertyIndex = properties.findIndex(
+    (prop) => (prop.type === "Property" || prop.type === "ObjectProperty") && prop.key.type === "Identifier" && prop.key.name === "files"
+  );
+  if (filesPropertyIndex === -1) {
+    return false;
+  }
+  const filesProperty = properties[filesPropertyIndex];
+  if (filesProperty.type !== "Property" && filesProperty.type !== "ObjectProperty" || !("value" in filesProperty)) {
+    return false;
+  }
+  if (filesProperty.value.type === "ArrayExpression" && filesProperty.value.elements.length === 2) {
+    const elements = filesProperty.value.elements;
+    const values = elements.map((el) => el?.type === "Literal" || el?.type === "StringLiteral" ? el?.value : null).filter((v) => v !== null);
+    if (values.length === 2 && values.includes("plugin.json") && values.includes("README.md")) {
+      properties.splice(filesPropertyIndex, 1);
+      const testProperty = builders.property(
+        "init",
+        builders.identifier("test"),
+        builders.arrayExpression([builders.literal(/(^|\/)plugin\.json$/), builders.literal(/(^|\/)README\.md$/)])
+      );
+      properties.splice(filesPropertyIndex, 0, testProperty);
+      return true;
+    }
+  }
+  return false;
+}
+
+export { migrate as default };

package/dist/codemods/migrations/scripts/007-remove-testing-library-types.js

@@ -0,0 +1,25 @@
+import { isVersionGreater, removeDependenciesFromPackageJson } from '../../utils.js';
+
+function migrate(context) {
+  if (context.doesFileExist("package.json")) {
+    const packageJson = JSON.parse(context.getFile("package.json") || "{}");
+    if (isVersionGreater(packageJson.devDependencies["@testing-library/jest-dom"], "6.0.0", true)) {
+      if (context.doesFileExist("./.config/types/setupTests.d.ts")) {
+        const setupTestsContent = context.getFile("./.config/types/setupTests.d.ts");
+        if (!setupTestsContent?.includes("@testing-library/jest-dom")) {
+          context.updateFile(
+            "./.config/types/setupTests.d.ts",
+            `import '@testing-library/jest-dom';
+${setupTestsContent}`
+          );
+        }
+      } else {
+        context.addFile("./.config/types/setupTests.d.ts", "import '@testing-library/jest-dom';\n");
+      }
+      removeDependenciesFromPackageJson(context, [], ["@types/testing-library__jest-dom"]);
+    }
+  }
+  return context;
+}
+
+export { migrate as default };

package/dist/codemods/runner.js

@@ -1,7 +1,6 @@
 import { Context } from './context.js';
 import { formatFiles, flushChanges, printChanges, installNPMDependencies } from './utils.js';
 import { parseAndValidateOptions } from './schema-parser.js';
-import { output } from '../utils/utils.console.js';
 
 async function runCodemod(codemod, options) {
   const codemodModule = await import(codemod.scriptPath);
@@ -15,10 +14,6 @@ async function runCodemod(codemod, options) {
   const basePath = process.cwd();
   const context = new Context(basePath);
   try {
-    output.log({
-      title: `Running ${codemod.name}`,
-      body: [codemod.description]
-    });
     const updatedContext = await codemodModule.default(context, codemodOptions);
     await formatFiles(updatedContext);
     flushChanges(updatedContext);

package/dist/codemods/utils.js

@@ -6,6 +6,7 @@ import { output } from '../utils/utils.console.js';
 import { getPackageManagerWithFallback, getPackageManagerSilentInstallCmd } from '../utils/utils.packageManager.js';
 import { execSync } from 'node:child_process';
 import { gte, gt, clean, coerce } from 'semver';
+import { debug } from '../utils/utils.cli.js';
 
 function printChanges(context, key, description) {
   const changes = context.listChanges();
@@ -203,5 +204,7 @@ function cleanSemver(version) {
 function sortObjectByKeys(obj) {
   return Object.keys(obj).sort().reduce((acc, key) => ({ ...acc, [key]: obj[key] }), {});
 }
+const migrationsDebug = debug.extend("migrations");
+debug.extend("additions");
 
-export { addDependenciesToPackageJson, flushChanges, formatFiles, installNPMDependencies, isVersionGreater, printChanges, readJsonFile, removeDependenciesFromPackageJson };
+export { addDependenciesToPackageJson, flushChanges, formatFiles, installNPMDependencies, isVersionGreater, migrationsDebug, printChanges, readJsonFile, removeDependenciesFromPackageJson };

package/dist/commands/add.command.js

@@ -19,10 +19,6 @@ const add = async (argv) => {
 
 Available additions: ${additionsList.join(", ")}`);
     }
-    output.log({
-      title: `Running addition: ${addition.name}`,
-      body: [addition.description]
-    });
     const { _, $0, ...codemodOptions } = argv;
     await runCodemod(addition, codemodOptions);
     output.success({

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/create-plugin",
-  "version": "6.2.0-canary.2233.19424871609.0",
+  "version": "6.2.0-canary.2233.19500011348.0",
   "repository": {
     "directory": "packages/create-plugin",
     "url": "https://github.com/grafana/plugin-tools"
@@ -25,6 +25,7 @@
     "typecheck": "tsc --noEmit"
   },
   "dependencies": {
+    "@babel/parser": "^7.28.5",
     "@ivanmaxlogiudice/gitignore": "^0.0.2",
     "chalk": "^5.3.0",
     "change-case": "^5.4.0",
@@ -60,5 +61,5 @@
   "engines": {
     "node": ">=20"
   },
-  "gitHead": "0b0b05e102a885fb4fb16588c6cfbd0f0b69392f"
+  "gitHead": "da5c19b22694d6591958bc7f4404eac423253c3c"
 }

package/src/codemods/additions/additions.test.ts

@@ -1,12 +1,17 @@
+import { existsSync } from 'node:fs';
+import { fileURLToPath } from 'node:url';
 import defaultAdditions from './additions.js';
 
 describe('additions json', () => {
-  // as addition scripts are imported dynamically when add is run we assert the path is valid
+  // As addition scripts are imported dynamically when add is run we assert the path is valid
+  // Vitest 4 reimplemented its workers, which caused the previous dynamic import tests to fail.
+  // This test now only asserts that the addition script source file exists.
   defaultAdditions.forEach((addition) => {
     it(`should have a valid addition script path for ${addition.name}`, () => {
-      expect(async () => {
-        await import(addition.scriptPath);
-      }).not.toThrow();
+      // import.meta.resolve() returns a file:// URL, convert to path
+      const filePath = fileURLToPath(addition.scriptPath);
+      const sourceFilePath = filePath.replace('.js', '.ts');
+      expect(existsSync(sourceFilePath)).toBe(true);
     });
   });
 });

package/src/codemods/additions/additions.ts

@@ -3,7 +3,7 @@ import { Codemod } from '../types.js';
 export default [
   {
     name: 'example-addition',
-    description: 'Example addition demonstrating Valibot schema with type inference',
+    description: 'Adds an example addition to the plugin',
     scriptPath: import.meta.resolve('./scripts/example-addition.js'),
   },
 ] satisfies Codemod[];

package/src/codemods/additions/scripts/example-addition.test.ts

@@ -23,7 +23,7 @@ describe('example-addition', () => {
     const result = migrate(context, { featureName: 'myFeature', enabled: false, frameworks: ['react'] });
 
     const packageJson = JSON.parse(result.getFile('package.json') || '{}');
-    expect(packageJson.devDependencies['example-dev-dep']).toBe('^1.0.0');
+    expect(packageJson.devDependencies['@types/node']).toBe('^20.0.0');
   });
 
   it('should create feature TypeScript file with options', () => {

package/src/codemods/additions/scripts/example-addition.ts

@@ -34,7 +34,7 @@ export default function exampleAddition(context: Context, options: ExampleOption
     context.updateFile('./package.json', JSON.stringify(packageJson, null, 2));
   }
 
-  addDependenciesToPackageJson(context, {}, { 'example-dev-dep': '^1.0.0' });
+  addDependenciesToPackageJson(context, {}, { '@types/node': '^20.0.0' });
 
   if (!context.doesFileExist(`./src/features/${featureName}.ts`)) {
     const featureCode = `export const ${featureName} = {

package/src/codemods/migrations/manager.test.ts

@@ -9,7 +9,7 @@ import { setRootConfig } from '../../utils/utils.config.js';
 import { vi } from 'vitest';
 
 vi.mock('../utils.js', async (importOriginal) => {
-  const actual = (await importOriginal()) as any;
+  const actual: typeof import('../utils.js') = await importOriginal();
   return {
     ...actual,
     flushChanges: vi.fn(),

package/src/codemods/migrations/migrations.ts

@@ -37,6 +37,19 @@ export default [
     description: 'Update React and ReactDOM 18.x versions to ^18.3.0 to surface React 19 compatibility issues.',
     scriptPath: import.meta.resolve('./scripts/005-react-18-3.js'),
   },
+  {
+    name: '006-webpack-nested-fix',
+    version: '6.1.11',
+    description: 'Fix webpack variable replacement in nested plugins files.',
+    scriptPath: import.meta.resolve('./scripts/006-webpack-nested-fix.js'),
+  },
+  {
+    name: '007-remove-testing-library-types',
+    version: '6.1.13',
+    description:
+      'Add setupTests.d.ts for @testing-library/jest-dom types and remove @types/testing-library__jest-dom npm package.',
+    scriptPath: import.meta.resolve('./scripts/007-remove-testing-library-types.js'),
+  },
   // Do not use LEGACY_UPDATE_CUTOFF_VERSION for new migrations. It is only used above to force migrations to run
   // for those written before the switch to updates as migrations.
 ] satisfies Migration[];

package/src/codemods/migrations/scripts/004-eslint9-flat-config.ts

@@ -6,8 +6,7 @@ import minimist from 'minimist';
 import { dirname, relative, resolve } from 'node:path';
 import * as recast from 'recast';
 import type { Context } from '../../context.js';
-import { addDependenciesToPackageJson } from '../../utils.js';
-// migrationsDebug removed - was from deleted migrations/utils.js
+import { addDependenciesToPackageJson, migrationsDebug } from '../../utils.js';
 
 type Imports = Map<string, { name?: string; bindings?: string[] }>;
 
@@ -407,7 +406,7 @@ function getIgnorePaths(context: Context): string[] {
         }
       }
     } catch (error) {
-      console.log('Error parsing package.json: %s', error);
+      migrationsDebug('Error parsing package.json: %s', error);
     }
   }
 

package/src/codemods/migrations/scripts/006-webpack-nested-fix.test.ts

@@ -0,0 +1,169 @@
+import migrate from './006-webpack-nested-fix.js';
+import { createDefaultContext } from '../../test-utils.js';
+
+describe('Migration - webpack nested fix', () => {
+  test('should transform files property to test property', () => {
+    const context = createDefaultContext();
+
+    const webpackConfigContent = `
+import ReplaceInFileWebpackPlugin from 'replace-in-file-webpack-plugin';
+
+const config = {
+  plugins: [
+    new ReplaceInFileWebpackPlugin([
+      {
+        dir: 'dist',
+        files: ['plugin.json', 'README.md'],
+        rules: [
+          { search: /VERSION/g, replace: '1.0.0' }
+        ]
+      }
+    ])
+  ]
+};
+`;
+
+    context.addFile('.config/webpack/webpack.config.ts', webpackConfigContent);
+
+    const updatedContext = migrate(context);
+    const webpackConfig = updatedContext.getFile('.config/webpack/webpack.config.ts');
+
+    expect(webpackConfig).toContain('test: [/(^|\\/)plugin\\.json$/, /(^|\\/)README\\.md$/]');
+    expect(webpackConfig).not.toContain('files:');
+    expect(webpackConfig).toContain('dir:');
+    expect(webpackConfig).toContain('rules:');
+  });
+
+  test('should not transform if files array has different values', () => {
+    const context = createDefaultContext();
+
+    const webpackConfigContent = `
+import ReplaceInFileWebpackPlugin from 'replace-in-file-webpack-plugin';
+
+const config = {
+  plugins: [
+    new ReplaceInFileWebpackPlugin([
+      {
+        dir: 'dist',
+        files: ['custom.json', 'other.md'],
+        rules: []
+      }
+    ])
+  ]
+};
+`;
+
+    context.addFile('.config/webpack/webpack.config.ts', webpackConfigContent);
+
+    const updatedContext = migrate(context);
+    const webpackConfig = updatedContext.getFile('.config/webpack/webpack.config.ts');
+
+    expect(webpackConfig).toBe(webpackConfigContent);
+  });
+
+  test('should not transform if already using test property', () => {
+    const context = createDefaultContext();
+
+    const webpackConfigContent = `
+import ReplaceInFileWebpackPlugin from 'replace-in-file-webpack-plugin';
+
+const config = {
+  plugins: [
+    new ReplaceInFileWebpackPlugin([
+      {
+        dir: 'dist',
+        test: [/(^|\\/)plugin\\.json$/, /(^|\\/)README\\.md$/],
+        rules: []
+      }
+    ])
+  ]
+};
+`;
+
+    context.addFile('.config/webpack/webpack.config.ts', webpackConfigContent);
+
+    const updatedContext = migrate(context);
+    const webpackConfig = updatedContext.getFile('.config/webpack/webpack.config.ts');
+
+    expect(webpackConfig).toBe(webpackConfigContent);
+  });
+
+  test('should handle multiple ReplaceInFileWebpackPlugin instances', () => {
+    const context = createDefaultContext();
+
+    const webpackConfigContent = `
+import ReplaceInFileWebpackPlugin from 'replace-in-file-webpack-plugin';
+
+const config = {
+  plugins: [
+    new ReplaceInFileWebpackPlugin([
+      {
+        dir: 'dist',
+        files: ['plugin.json', 'README.md'],
+        rules: [],
+      }
+    ]),
+    new ReplaceInFileWebpackPlugin([
+      {
+        dir: 'other',
+        files: ['custom.json'],
+        rules: [],
+      }
+    ])
+  ]
+};
+`;
+
+    const expectedConfig = `
+import ReplaceInFileWebpackPlugin from 'replace-in-file-webpack-plugin';
+
+const config = {
+  plugins: [
+    new ReplaceInFileWebpackPlugin([
+      {
+        dir: 'dist',
+        test: [/(^|\\/)plugin\\.json$/, /(^|\\/)README\\.md$/],
+        rules: [],
+      }
+    ]),
+    new ReplaceInFileWebpackPlugin([
+      {
+        dir: 'other',
+        files: ['custom.json'],
+        rules: [],
+      }
+    ])
+  ]
+};
+`;
+
+    context.addFile('.config/webpack/webpack.config.ts', webpackConfigContent);
+    const updatedContext = migrate(context);
+    const webpackConfig = updatedContext.getFile('.config/webpack/webpack.config.ts');
+    expect(webpackConfig).toBe(expectedConfig);
+  });
+
+  test('should be idempotent', () => {
+    const context = createDefaultContext();
+
+    const webpackConfigContent = `
+import ReplaceInFileWebpackPlugin from 'replace-in-file-webpack-plugin';
+
+const config = {
+  plugins: [
+    new ReplaceInFileWebpackPlugin([
+      {
+        dir: 'dist',
+        files: ['plugin.json', 'README.md'],
+        rules: []
+      }
+    ])
+  ]
+};
+`;
+
+    context.addFile('.config/webpack/webpack.config.ts', webpackConfigContent);
+
+    expect(migrate).toBeIdempotent(context);
+  });
+});

package/src/codemods/migrations/scripts/006-webpack-nested-fix.ts

@@ -0,0 +1,117 @@
+import { join } from 'node:path';
+import * as recast from 'recast';
+import * as typeScriptParser from 'recast/parsers/typescript.js';
+import type { Context } from '../../context.js';
+
+const { builders } = recast.types;
+
+export default function migrate(context: Context): Context {
+  const webpackConfigPath = join('.config', 'webpack', 'webpack.config.ts');
+  if (!context.doesFileExist(webpackConfigPath)) {
+    return context;
+  }
+
+  const webpackConfigContent = context.getFile(webpackConfigPath);
+  if (!webpackConfigContent) {
+    return context;
+  }
+
+  let hasChanges = false;
+  const ast = recast.parse(webpackConfigContent, {
+    parser: typeScriptParser,
+  });
+
+  recast.visit(ast, {
+    visitNewExpression(path) {
+      const { node } = path;
+
+      // Check if this is a ReplaceInFileWebpackPlugin constructor
+      if (
+        node.callee.type === 'Identifier' &&
+        node.callee.name === 'ReplaceInFileWebpackPlugin' &&
+        node.arguments.length > 0
+      ) {
+        const firstArg = node.arguments[0];
+
+        // The first argument should be an array of config objects
+        if (firstArg.type === 'ArrayExpression' && firstArg.elements) {
+          firstArg.elements.forEach((element) => {
+            if (element && element.type === 'ObjectExpression') {
+              const changed = transformFilesProperty(element);
+              if (changed) {
+                hasChanges = true;
+              }
+            }
+          });
+        }
+      }
+
+      return this.traverse(path);
+    },
+  });
+
+  // Only update the file if we made changes
+  if (hasChanges) {
+    const output = recast.print(ast, {
+      tabWidth: 2,
+      trailingComma: true,
+      lineTerminator: '\n',
+    });
+    context.updateFile(webpackConfigPath, output.code);
+  }
+
+  return context;
+}
+
+function transformFilesProperty(objectExpression: recast.types.namedTypes.ObjectExpression): boolean {
+  const properties = objectExpression.properties;
+  if (!properties) {
+    return false;
+  }
+
+  // Find the 'files' property
+  const filesPropertyIndex = properties.findIndex(
+    (prop) =>
+      (prop.type === 'Property' || prop.type === 'ObjectProperty') &&
+      prop.key.type === 'Identifier' &&
+      prop.key.name === 'files'
+  );
+
+  if (filesPropertyIndex === -1) {
+    return false;
+  }
+
+  const filesProperty = properties[filesPropertyIndex];
+
+  // Type guard: ensure it's a Property or ObjectProperty (which have a value)
+  if ((filesProperty.type !== 'Property' && filesProperty.type !== 'ObjectProperty') || !('value' in filesProperty)) {
+    return false;
+  }
+
+  // Check if it's an array with the expected values
+  if (filesProperty.value.type === 'ArrayExpression' && filesProperty.value.elements.length === 2) {
+    const elements = filesProperty.value.elements;
+    const values = elements
+      .map((el) => (el?.type === 'Literal' || el?.type === 'StringLiteral' ? el?.value : null))
+      .filter((v) => v !== null);
+
+    // Only transform if it matches the exact pattern we're looking for
+    if (values.length === 2 && values.includes('plugin.json') && values.includes('README.md')) {
+      // Remove the 'files' property
+      properties.splice(filesPropertyIndex, 1);
+
+      // Add the 'test' property with regex array
+      const testProperty = builders.property(
+        'init',
+        builders.identifier('test'),
+        builders.arrayExpression([builders.literal(/(^|\/)plugin\.json$/), builders.literal(/(^|\/)README\.md$/)])
+      );
+
+      // Insert at the same position
+      properties.splice(filesPropertyIndex, 0, testProperty);
+      return true;
+    }
+  }
+
+  return false;
+}