@grafana/create-plugin 6.1.13-canary.2313.19498365291.0 → 6.1.14

package/CHANGELOG.md

@@ -1,3 +1,27 @@
+# v6.1.14 (Wed Nov 19 2025)
+
+#### 🐛 Bug Fix
+
+- Create plugin: Update go templates [#2313](https://github.com/grafana/plugin-tools/pull/2313) ([@jackw](https://github.com/jackw))
+
+#### Authors: 1
+
+- Jack Westbrook ([@jackw](https://github.com/jackw))
+
+---
+
+# 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

package/dist/migrations/migrations.js

@@ -31,6 +31,11 @@ var defaultMigrations = {
       version: "6.1.11",
       description: "Fix webpack variable replacement in nested plugins files.",
       migrationScript: "./scripts/006-webpack-nested-fix.js"
+    },
+    "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.",
+      migrationScript: "./scripts/007-remove-testing-library-types.js"
     }
   }
 };

package/dist/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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/create-plugin",
-  "version": "6.1.13-canary.2313.19498365291.0",
+  "version": "6.1.14",
   "repository": {
     "directory": "packages/create-plugin",
     "url": "https://github.com/grafana/plugin-tools"
@@ -60,5 +60,5 @@
   "engines": {
     "node": ">=20"
   },
-  "gitHead": "83e8a2139d028c44ece9ff50c8c614dc2eb79493"
+  "gitHead": "9216fe4caf37b8ccc977c987f0364d114241c8fb"
 }

package/src/migrations/migrations.ts

@@ -45,5 +45,11 @@ export default {
       description: 'Fix webpack variable replacement in nested plugins files.',
       migrationScript: './scripts/006-webpack-nested-fix.js',
     },
+    '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.',
+      migrationScript: './scripts/007-remove-testing-library-types.js',
+    },
   },
 } as Migrations;

package/src/migrations/scripts/007-remove-testing-library-types.test.ts

@@ -0,0 +1,137 @@
+import { describe, expect, it } from 'vitest';
+import migrate from './007-remove-testing-library-types.js';
+import { Context } from '../context.js';
+
+describe('006-remove-testing-library-types', () => {
+  it('should create setupTests.d.ts, remove types package, and add @testing-library/jest-dom when file does not exist', () => {
+    const context = new Context('/virtual');
+
+    context.addFile(
+      'package.json',
+      JSON.stringify({
+        devDependencies: {
+          '@types/testing-library__jest-dom': '^6.0.0',
+          '@testing-library/jest-dom': '6.0.0',
+          '@testing-library/react': '14.0.0',
+        },
+      })
+    );
+
+    const result = migrate(context);
+    const setupTestsContent = result.getFile('./.config/types/setupTests.d.ts');
+    expect(setupTestsContent).toBe("import '@testing-library/jest-dom';\n");
+
+    const packageJson = JSON.parse(result.getFile('package.json') || '{}');
+    expect(packageJson.devDependencies).toEqual({
+      '@testing-library/jest-dom': '6.0.0',
+      '@testing-library/react': '14.0.0',
+    });
+  });
+
+  it('should add import to existing setupTests.d.ts, remove types package, and add @testing-library/jest-dom if missing', () => {
+    const context = new Context('/virtual');
+
+    const existingContent = '// Some other type declarations\n';
+    context.addFile('./.config/types/setupTests.d.ts', existingContent);
+    context.addFile(
+      'package.json',
+      JSON.stringify({
+        devDependencies: {
+          '@types/testing-library__jest-dom': '^6.0.0',
+          '@testing-library/jest-dom': '6.1.4',
+          '@testing-library/react': '14.0.0',
+        },
+      })
+    );
+
+    const result = migrate(context);
+    const setupTestsContent = result.getFile('./.config/types/setupTests.d.ts');
+    expect(setupTestsContent).toBe(`import '@testing-library/jest-dom';\n${existingContent}`);
+
+    const packageJson = JSON.parse(result.getFile('package.json') || '{}');
+    expect(packageJson.devDependencies).toEqual({
+      '@testing-library/jest-dom': '6.1.4',
+      '@testing-library/react': '14.0.0',
+    });
+  });
+
+  it('should not modify setupTests.d.ts if import already exists', () => {
+    const context = new Context('/virtual');
+
+    const existingContent = "// Other content\nimport 'react';\nimport '@testing-library/jest-dom';\n";
+    context.addFile('./.config/types/setupTests.d.ts', existingContent);
+    context.addFile(
+      'package.json',
+      JSON.stringify({
+        devDependencies: {
+          '@types/testing-library__jest-dom': '^6.0.0',
+          '@testing-library/jest-dom': '6.1.4',
+          '@testing-library/react': '14.0.0',
+        },
+      })
+    );
+
+    const result = migrate(context);
+
+    const setupTestsContent = result.getFile('./.config/types/setupTests.d.ts');
+    expect(setupTestsContent).toBe(existingContent);
+
+    const packageJson = JSON.parse(result.getFile('package.json') || '{}');
+    expect(packageJson.devDependencies).toEqual({
+      '@testing-library/jest-dom': '6.1.4',
+      '@testing-library/react': '14.0.0',
+    });
+  });
+
+  it('should not modify anything if @testing-library/jest-dom is not greater than 6.0.0', () => {
+    const context = new Context('/virtual');
+    const packageJsonContent = JSON.stringify({
+      devDependencies: { '@testing-library/jest-dom': '5.14.2' },
+    });
+    context.addFile('package.json', packageJsonContent);
+
+    const result = migrate(context);
+    expect(result.getFile('package.json')).toEqual(packageJsonContent);
+  });
+
+  it('should handle package.json without the types package', () => {
+    const context = new Context('/virtual');
+
+    context.addFile(
+      'package.json',
+      JSON.stringify({
+        devDependencies: {
+          '@testing-library/react': '14.0.0',
+          '@testing-library/jest-dom': '6.1.4',
+        },
+      })
+    );
+
+    const result = migrate(context);
+    const setupTestsContent = result.getFile('./.config/types/setupTests.d.ts');
+    expect(setupTestsContent).toBe("import '@testing-library/jest-dom';\n");
+
+    const packageJson = JSON.parse(result.getFile('package.json') || '{}');
+    expect(packageJson.devDependencies).toEqual({
+      '@testing-library/jest-dom': '6.1.4',
+      '@testing-library/react': '14.0.0',
+    });
+  });
+
+  it('should be idempotent', async () => {
+    const context = new Context('/virtual');
+
+    context.addFile(
+      'package.json',
+      JSON.stringify({
+        devDependencies: {
+          '@types/testing-library__jest-dom': '^6.0.0',
+          '@testing-library/jest-dom': '6.1.4',
+          '@testing-library/react': '14.0.0',
+        },
+      })
+    );
+
+    await expect(migrate).toBeIdempotent(context);
+  });
+});

package/src/migrations/scripts/007-remove-testing-library-types.ts

@@ -0,0 +1,25 @@
+import type { Context } from '../context.js';
+import { removeDependenciesFromPackageJson, isVersionGreater } from '../utils.js';
+
+export default function migrate(context: 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';\n${setupTestsContent}`
+          );
+        }
+      } else {
+        context.addFile('./.config/types/setupTests.d.ts', "import '@testing-library/jest-dom';\n");
+      }
+
+      removeDependenciesFromPackageJson(context, [], ['@types/testing-library__jest-dom']);
+    }
+  }
+
+  return context;
+}

package/templates/common/.config/types/setupTests.d.ts

@@ -0,0 +1 @@
+import '@testing-library/jest-dom';

package/templates/common/_package.json

@@ -33,7 +33,6 @@
     "@types/react": "^18.3.0",
     "@types/react-dom": "^18.3.0",{{#if isAppType}}{{#unless useReactRouterV6}}
     "@types/react-router-dom": "^{{ reactRouterVersion }}",{{/unless}}{{/if}}
-    "@types/testing-library__jest-dom": "5.14.8",
     "@typescript-eslint/eslint-plugin": "^8.3.0",
     "@typescript-eslint/parser": "^8.3.0",{{#unless useExperimentalRspack}}
     "copy-webpack-plugin": "^11.0.0",{{/unless}}