@grafana/create-plugin 7.4.0 → 7.5.0-canary.2614.25786572918.0

package/CONTRIBUTING.md

@@ -109,8 +109,6 @@ Note that certain files are intentionally named differently (e.g. npmrc, package
 
 ### Migrations
 
-> **Note:** Migrations are currently behind the `--experimental-updates` flag and are not enabled by default.
-
 Migrations are scripts that update a particular aspect of a project created with create-plugin. When users run `@grafana/create-plugin@latest update`, the command compares their project's version against the running package version and executes any necessary migrations to bring their project up to date.
 
 ```js

package/dist/codemods/migrations/migrations.js

@@ -48,6 +48,18 @@ var defaultMigrations = [
     version: "7.3.2",
     description: "Harden bundle-stats/bundle-size workflow permissions: contents permission was set to write but only read access is required; restricted to read for least-privilege.",
     scriptPath: import.meta.resolve("./scripts/008-bundle-stats-permissions.js")
+  },
+  {
+    name: "009-remove-tsconfig-baseurl",
+    version: "7.4.1",
+    description: "Fix TypeScript 6 compatibility: baseUrl is deprecated in TS6 (error TS5101) and must be replaced with an equivalent paths entry to preserve non-relative import resolution.",
+    scriptPath: import.meta.resolve("./scripts/009-remove-tsconfig-baseurl.js")
+  },
+  {
+    name: "010-ts-node-nodenext",
+    version: "7.4.1",
+    description: "Fix ts-node compatibility with the latest @grafana/tsconfig: outdated module/moduleResolution/target overrides break TypeScript 5/6 builds, replaced with nodenext/nodenext/es2022.",
+    scriptPath: import.meta.resolve("./scripts/010-ts-node-nodenext.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/009-remove-tsconfig-baseurl.js

@@ -0,0 +1,24 @@
+import { applyEdits, modify } from 'jsonc-parser';
+
+function migrate(context) {
+  if (!context.doesFileExist(".config/tsconfig.json")) {
+    return context;
+  }
+  const content = context.getFile(".config/tsconfig.json") || "";
+  if (!content.includes('"baseUrl"')) {
+    return context;
+  }
+  const formattingOptions = { formattingOptions: { insertSpaces: true, tabSize: 2 } };
+  const contentWithoutBaseUrl = applyEdits(
+    content,
+    modify(content, ["compilerOptions", "baseUrl"], void 0, formattingOptions)
+  );
+  const contentWithPaths = applyEdits(
+    contentWithoutBaseUrl,
+    modify(contentWithoutBaseUrl, ["compilerOptions", "paths", "*"], ["../src/*"], formattingOptions)
+  );
+  context.updateFile(".config/tsconfig.json", contentWithPaths);
+  return context;
+}
+
+export { migrate as default };

package/dist/codemods/migrations/scripts/010-ts-node-nodenext.js

@@ -0,0 +1,33 @@
+import { applyEdits, modify } from 'jsonc-parser';
+
+const TSCONFIG_PATH = ".config/tsconfig.json";
+const FORMATTING_OPTIONS = {
+  formattingOptions: { insertSpaces: true, tabSize: 2 }
+};
+const UPDATES = [
+  { key: "module", oldValue: "commonjs", newValue: "nodenext" },
+  { key: "moduleResolution", newValue: "nodenext" },
+  { key: "target", oldValue: "es5", newValue: "es2022" }
+];
+function migrate(context) {
+  if (!context.doesFileExist(TSCONFIG_PATH)) {
+    return context;
+  }
+  const original = context.getFile(TSCONFIG_PATH) || "";
+  let next = original;
+  for (const { key, oldValue, newValue } of UPDATES) {
+    if (oldValue !== void 0) {
+      const oldPattern = `"${key}": "${oldValue}"`;
+      if (!next.includes(oldPattern)) {
+        continue;
+      }
+    }
+    next = applyEdits(next, modify(next, ["ts-node", "compilerOptions", key], newValue, FORMATTING_OPTIONS));
+  }
+  if (next !== original) {
+    context.updateFile(TSCONFIG_PATH, next);
+  }
+  return context;
+}
+
+export { migrate as default };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/create-plugin",
-  "version": "7.4.0",
+  "version": "7.5.0-canary.2614.25786572918.0",
   "repository": {
     "directory": "packages/create-plugin",
     "url": "https://github.com/grafana/plugin-tools"
@@ -55,5 +55,5 @@
   "engines": {
     "node": ">=20"
   },
-  "gitHead": "d9190314df0893842f12e33bbdfb7d39c3a704cc"
+  "gitHead": "01b24eb05e3f0b58fcff5d895015a9783b53a92f"
 }

package/src/codemods/migrations/migrations.ts

@@ -57,6 +57,20 @@ export default [
       'Harden bundle-stats/bundle-size workflow permissions: contents permission was set to write but only read access is required; restricted to read for least-privilege.',
     scriptPath: import.meta.resolve('./scripts/008-bundle-stats-permissions.js'),
   },
+  {
+    name: '009-remove-tsconfig-baseurl',
+    version: '7.4.1',
+    description:
+      'Fix TypeScript 6 compatibility: baseUrl is deprecated in TS6 (error TS5101) and must be replaced with an equivalent paths entry to preserve non-relative import resolution.',
+    scriptPath: import.meta.resolve('./scripts/009-remove-tsconfig-baseurl.js'),
+  },
+  {
+    name: '010-ts-node-nodenext',
+    version: '7.4.1',
+    description:
+      'Fix ts-node compatibility with the latest @grafana/tsconfig: outdated module/moduleResolution/target overrides break TypeScript 5/6 builds, replaced with nodenext/nodenext/es2022.',
+    scriptPath: import.meta.resolve('./scripts/010-ts-node-nodenext.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/009-remove-tsconfig-baseurl.test.ts

@@ -0,0 +1,91 @@
+import { describe, expect, it } from 'vitest';
+import { parse } from 'jsonc-parser';
+import migrate from './009-remove-tsconfig-baseurl.js';
+import { Context } from '../../context.js';
+
+const SCAFFOLD_TSCONFIG = `/*
+ * ⚠️⚠️⚠️ THIS FILE WAS SCAFFOLDED BY \`@grafana/create-plugin\`. DO NOT EDIT THIS FILE DIRECTLY. ⚠️⚠️⚠️
+ */
+{
+  "compilerOptions": {
+    "alwaysStrict": true,
+    "rootDir": "../src",
+    "baseUrl": "../src",
+    "typeRoots": ["../node_modules/@types"],
+    "resolveJsonModule": true
+  },
+  "extends": "@grafana/tsconfig"
+}
+`;
+
+describe('008-remove-tsconfig-baseurl', () => {
+  it('should remove baseUrl and add paths catch-all, preserving comment header and rootDir', () => {
+    const context = new Context('/virtual');
+    context.addFile('.config/tsconfig.json', SCAFFOLD_TSCONFIG);
+
+    const result = migrate(context);
+    const content = result.getFile('.config/tsconfig.json') || '';
+    const config = parse(content) as { compilerOptions: Record<string, unknown> };
+
+    expect(config.compilerOptions['baseUrl']).toBeUndefined();
+    expect(config.compilerOptions['paths']).toEqual({ '*': ['../src/*'] });
+    expect(config.compilerOptions['rootDir']).toBe('../src');
+    expect(content).toContain('DO NOT EDIT THIS FILE DIRECTLY');
+  });
+
+  it('should be idempotent', async () => {
+    const context = new Context('/virtual');
+    context.addFile('.config/tsconfig.json', SCAFFOLD_TSCONFIG);
+
+    await expect(migrate).toBeIdempotent(context);
+  });
+
+  it('should not modify file when baseUrl is already absent', () => {
+    const context = new Context('/virtual');
+    const content = `{
+  "compilerOptions": {
+    "rootDir": "../src",
+    "paths": { "*": ["../src/*"] }
+  }
+}
+`;
+    context.addFile('.config/tsconfig.json', content);
+
+    const result = migrate(context);
+
+    expect(result.getFile('.config/tsconfig.json')).toBe(content);
+  });
+
+  it('should not modify anything when .config/tsconfig.json does not exist', () => {
+    const context = new Context('/virtual');
+
+    const result = migrate(context);
+
+    expect(result.hasChanges()).toBe(false);
+  });
+
+  it('should merge paths["*"] into an existing paths object without overwriting other entries', () => {
+    const context = new Context('/virtual');
+    context.addFile(
+      '.config/tsconfig.json',
+      `{
+  "compilerOptions": {
+    "rootDir": "../src",
+    "baseUrl": "../src",
+    "paths": {
+      "@components/*": ["../src/components/*"]
+    }
+  }
+}
+`
+    );
+
+    const result = migrate(context);
+    const content = result.getFile('.config/tsconfig.json') || '';
+    const config = parse(content) as { compilerOptions: { paths: Record<string, string[]> } };
+
+    expect(config.compilerOptions.paths['@components/*']).toEqual(['../src/components/*']);
+    expect(config.compilerOptions.paths['*']).toEqual(['../src/*']);
+    expect(config.compilerOptions).not.toHaveProperty('baseUrl');
+  });
+});

package/src/codemods/migrations/scripts/009-remove-tsconfig-baseurl.ts

@@ -0,0 +1,32 @@
+import { modify, applyEdits } from 'jsonc-parser';
+import type { Context } from '../../context.js';
+
+export default function migrate(context: Context) {
+  if (!context.doesFileExist('.config/tsconfig.json')) {
+    return context;
+  }
+
+  const content = context.getFile('.config/tsconfig.json') || '';
+
+  if (!content.includes('"baseUrl"')) {
+    return context;
+  }
+
+  const formattingOptions = { formattingOptions: { insertSpaces: true, tabSize: 2 } };
+
+  // applyEdits accepts Edit[] and modify returns Edit[], but both modify calls must operate on
+  // the same base string to produce correct offsets. Chaining them sequentially is safer since
+  // removing baseUrl shifts positions in compilerOptions before we add paths.
+  const contentWithoutBaseUrl = applyEdits(
+    content,
+    modify(content, ['compilerOptions', 'baseUrl'], undefined, formattingOptions)
+  );
+  const contentWithPaths = applyEdits(
+    contentWithoutBaseUrl,
+    modify(contentWithoutBaseUrl, ['compilerOptions', 'paths', '*'], ['../src/*'], formattingOptions)
+  );
+
+  context.updateFile('.config/tsconfig.json', contentWithPaths);
+
+  return context;
+}

package/src/codemods/migrations/scripts/010-ts-node-nodenext.test.ts

@@ -0,0 +1,109 @@
+import { describe, expect, it } from 'vitest';
+import migrate from './010-ts-node-nodenext.js';
+import { Context } from '../../context.js';
+
+const SCAFFOLDED_TSCONFIG = `/*
+ * ⚠️⚠️⚠️ THIS FILE WAS SCAFFOLDED BY \`@grafana/create-plugin\`. DO NOT EDIT THIS FILE DIRECTLY. ⚠️⚠️⚠️
+ *
+ * In order to extend the configuration follow the steps in
+ * https://grafana.com/developers/plugin-tools/how-to-guides/extend-configurations#extend-the-typescript-config
+ */
+{
+  "compilerOptions": {
+    "alwaysStrict": true,
+    "declaration": false,
+    "rootDir": "../src",
+    "paths": {
+      "*": ["../src/*"]
+    },
+    "typeRoots": ["../node_modules/@types"],
+    "resolveJsonModule": true
+  },
+  "ts-node": {
+    "compilerOptions": {
+      "module": "commonjs",
+      "moduleResolution": "node",
+      "target": "es5",
+      "esModuleInterop": true
+    },
+    "transpileOnly": true
+  },
+  "include": ["../src", "./types"],
+  "extends": "@grafana/tsconfig"
+}
+`;
+
+describe('009-ts-node-nodenext', () => {
+  it('should update module, moduleResolution, and target inside ts-node compilerOptions', () => {
+    const context = new Context('/virtual');
+    context.addFile('.config/tsconfig.json', SCAFFOLDED_TSCONFIG);
+
+    const result = migrate(context);
+    const updated = result.getFile('.config/tsconfig.json') || '';
+
+    expect(updated).toContain('"module": "nodenext"');
+    expect(updated).toContain('"moduleResolution": "nodenext"');
+    expect(updated).toContain('"target": "es2022"');
+    expect(updated).not.toContain('"module": "commonjs"');
+    expect(updated).not.toContain('"moduleResolution": "node"');
+    expect(updated).not.toContain('"target": "es5"');
+  });
+
+  it('should preserve the JSONC comment header', () => {
+    const context = new Context('/virtual');
+    context.addFile('.config/tsconfig.json', SCAFFOLDED_TSCONFIG);
+
+    const result = migrate(context);
+    const updated = result.getFile('.config/tsconfig.json') || '';
+
+    expect(updated).toContain('THIS FILE WAS SCAFFOLDED BY');
+    expect(updated.startsWith('/*')).toBe(true);
+  });
+
+  it('should be idempotent', async () => {
+    const context = new Context('/virtual');
+    context.addFile('.config/tsconfig.json', SCAFFOLDED_TSCONFIG);
+
+    await expect(migrate).toBeIdempotent(context);
+  });
+
+  it('should be a no-op when the file is already migrated', () => {
+    const alreadyMigrated = SCAFFOLDED_TSCONFIG.replace('"module": "commonjs"', '"module": "nodenext"')
+      .replace('"moduleResolution": "node"', '"moduleResolution": "nodenext"')
+      .replace('"target": "es5"', '"target": "es2022"');
+
+    const context = new Context('/virtual');
+    context.addFile('.config/tsconfig.json', alreadyMigrated);
+
+    const result = migrate(context);
+
+    expect(result.getFile('.config/tsconfig.json')).toBe(alreadyMigrated);
+  });
+
+  it('should be a no-op when .config/tsconfig.json does not exist', () => {
+    const context = new Context('/virtual');
+
+    const result = migrate(context);
+
+    expect(result.hasChanges()).toBe(false);
+  });
+
+  it('should leave user-customised module/target untouched but always force moduleResolution to nodenext', () => {
+    const partiallyCustomised = SCAFFOLDED_TSCONFIG.replace('"target": "es5"', '"target": "es2020"').replace(
+      '"moduleResolution": "node"',
+      '"moduleResolution": "bundler"'
+    );
+
+    const context = new Context('/virtual');
+    context.addFile('.config/tsconfig.json', partiallyCustomised);
+
+    const result = migrate(context);
+    const updated = result.getFile('.config/tsconfig.json') || '';
+
+    expect(updated).toContain('"module": "nodenext"');
+    expect(updated).toContain('"moduleResolution": "nodenext"');
+    expect(updated).toContain('"target": "es2020"');
+    expect(updated).not.toContain('"moduleResolution": "bundler"');
+    expect(updated).not.toContain('"target": "es2022"');
+  });
+});

package/src/codemods/migrations/scripts/010-ts-node-nodenext.ts

@@ -0,0 +1,39 @@
+import { applyEdits, modify } from 'jsonc-parser';
+import type { Context } from '../../context.js';
+
+const TSCONFIG_PATH = '.config/tsconfig.json';
+
+const FORMATTING_OPTIONS = {
+  formattingOptions: { insertSpaces: true, tabSize: 2 },
+};
+
+const UPDATES: Array<{ key: string; oldValue?: string; newValue: string }> = [
+  { key: 'module', oldValue: 'commonjs', newValue: 'nodenext' },
+  { key: 'moduleResolution', newValue: 'nodenext' },
+  { key: 'target', oldValue: 'es5', newValue: 'es2022' },
+];
+
+export default function migrate(context: Context) {
+  if (!context.doesFileExist(TSCONFIG_PATH)) {
+    return context;
+  }
+
+  const original = context.getFile(TSCONFIG_PATH) || '';
+  let next = original;
+
+  for (const { key, oldValue, newValue } of UPDATES) {
+    if (oldValue !== undefined) {
+      const oldPattern = `"${key}": "${oldValue}"`;
+      if (!next.includes(oldPattern)) {
+        continue;
+      }
+    }
+    next = applyEdits(next, modify(next, ['ts-node', 'compilerOptions', key], newValue, FORMATTING_OPTIONS));
+  }
+
+  if (next !== original) {
+    context.updateFile(TSCONFIG_PATH, next);
+  }
+
+  return context;
+}

package/templates/common/.config/tsconfig.json

@@ -9,15 +9,17 @@
     "alwaysStrict": true,
     "declaration": false,
     "rootDir": "../src",
-    "baseUrl": "../src",
+    "paths": {
+      "*": ["../src/*"]
+    },
     "typeRoots": ["../node_modules/@types"],
     "resolveJsonModule": true
   },
   "ts-node": {
     "compilerOptions": {
-      "module": "commonjs",
-      "moduleResolution": "node",
-      "target": "es5",
+      "module": "nodenext",
+      "moduleResolution": "nodenext",
+      "target": "es2022",
       "esModuleInterop": true
     },
     "transpileOnly": true