@grafana/create-plugin 6.2.0-canary.2233.19133609453.0 → 6.2.0-canary.2233.19368311379.0

package/templates/common/_package.json

@@ -16,7 +16,7 @@
   "author": "{{ sentenceCase orgName }}",
   "license": "Apache-2.0",
   "devDependencies": {
-    "@grafana/eslint-config": "^8.2.0",
+    "@grafana/eslint-config": "^9.0.0",
     "@grafana/plugin-e2e": "^3.0.1",
     "@grafana/tsconfig": "^2.0.1",
     "@playwright/test": "^1.52.0",{{#if useExperimentalRspack}}
@@ -29,7 +29,9 @@
     "@testing-library/jest-dom": "6.1.4",
     "@testing-library/react": "14.0.0",
     "@types/jest": "^29.5.0",
-    "@types/node": "^20.8.7",{{#if isAppType}}{{#unless useReactRouterV6}}
+    "@types/node": "^20.8.7",
+    "@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",
@@ -40,7 +42,7 @@
     "eslint-config-prettier": "^8.8.0",
     "eslint-plugin-jsdoc": "^51.2.3",
     "eslint-plugin-react": "^7.37.5",
-    "eslint-plugin-react-hooks": "^5.2.0",
+    "eslint-plugin-react-hooks": "^7.0.0",
     "eslint-webpack-plugin": "^5.0.0",{{#unless useExperimentalRspack}}
     "fork-ts-checker-webpack-plugin": "^8.0.0",{{/unless}}
     "glob": "^10.2.7",
@@ -77,8 +79,8 @@
     "@grafana/ui": "^12.2.1",
     "@grafana/schema": "^12.2.1",{{#if_eq pluginType "scenesapp" }}
     "@grafana/scenes": "{{ scenesVersion }}",{{/if_eq}}
-    "react": "18.2.0",
-    "react-dom": "18.2.0"{{#if isAppType}},
+    "react": "^18.3.0",
+    "react-dom": "^18.3.0"{{#if isAppType}},
     "react-router-dom": "^{{ reactRouterVersion }}",
     "rxjs": "7.8.2"{{/if}}
   },

package/templates/github/workflows/bundle-stats.yml

@@ -20,7 +20,7 @@ jobs:
 
     steps:
       - name: Checkout repository
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
         with:
           persist-credentials: false
 

package/templates/github/workflows/ci.yml

@@ -25,16 +25,16 @@ jobs:
     env:
       GRAFANA_ACCESS_POLICY_TOKEN: $\{{ secrets.GRAFANA_ACCESS_POLICY_TOKEN }}
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
         with:
           persist-credentials: false
 {{#if_eq packageManagerName "pnpm"}}
       # pnpm action uses the packageManager field in package.json to
       # understand which version to install.
-      - uses: pnpm/action-setup@v3
+      - uses: pnpm/action-setup@v4
 {{/if_eq}}
       - name: Setup Node.js environment
-        uses: actions/setup-node@v4
+        uses: actions/setup-node@v6
         with:
           node-version: '22'
           cache: '{{ packageManagerName }}'
@@ -61,7 +61,7 @@ jobs:
 
       - name: Setup Go environment
         if: steps.check-for-backend.outputs.has-backend == 'true'
-        uses: actions/setup-go@v5
+        uses: actions/setup-go@v6
         with:
           go-version: '1.22'
 
@@ -122,7 +122,7 @@ jobs:
           ARCHIVE: $\{{ steps.metadata.outputs.archive }}
 
       - name: Archive Build
-        uses: actions/upload-artifact@v4
+        uses: actions/upload-artifact@v5
         with:
           name: $\{{ steps.metadata.outputs.plugin-id }}-$\{{ steps.metadata.outputs.plugin-version }}
           path: $\{{ steps.metadata.outputs.plugin-id }}
@@ -140,7 +140,7 @@ jobs:
       matrix: $\{{ steps.resolve-versions.outputs.matrix }}
     steps:
       - name: Checkout
-        uses: actions/checkout@v4
+        uses: actions/checkout@v5
         with:
           persist-credentials: false
 
@@ -162,12 +162,12 @@ jobs:
     name: e2e test $\{{ matrix.GRAFANA_IMAGE.name }}@$\{{ matrix.GRAFANA_IMAGE.VERSION }}
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
         with:
           persist-credentials: false
 
       - name: Download plugin
-        uses: actions/download-artifact@v4
+        uses: actions/download-artifact@v6
         with:
           path: dist
           name: $\{{ needs.build.outputs.plugin-id }}-$\{{ needs.build.outputs.plugin-version }}
@@ -180,10 +180,10 @@ jobs:
 {{#if_eq packageManagerName "pnpm"}}
       # pnpm action uses the packageManager field in package.json to
       # understand which version to install.
-      - uses: pnpm/action-setup@v3
+      - uses: pnpm/action-setup@v4
 {{/if_eq}}
       - name: Setup Node.js environment
-        uses: actions/setup-node@v4
+        uses: actions/setup-node@v6
         with:
           node-version: '22'
           cache: '{{ packageManagerName }}'
@@ -242,7 +242,7 @@ jobs:
     needs: [playwright-tests]
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
         with:
           # required for playwright-gh-pages
           persist-credentials: true

package/templates/github/workflows/cp-update.yml

@@ -1,3 +1,4 @@
+{{!-- /* 🚨 The `${{ }}` Github workflow expressions need to be escaped so they are not being interpreted by Handlebars. (this comment is going to be removed after scaffolding) 🚨 */ --}}
 name: Create Plugin Update
 
 on:
@@ -5,22 +6,16 @@ on:
   schedule:
     - cron: '0 0 1 * *' # run once a month on the 1st day
 
-# To use the default github token with the following elevated permissions make sure to check:
-# **Allow GitHub Actions to create and approve pull requests** in https://github.com/ORG_NAME/REPO_NAME/settings/actions.
-# Alternatively create a fine-grained personal access token for your repository with
-# `contents: read and write` and `pull requests: read and write` and pass it to the action.
-
-permissions:
-  contents: write
-  pull-requests: write
+# To use this workflow please create a fine-grained personal access token for your repository with:
+# `contents: read and write`
+# `pull requests: read and write`
+# `workflows: read and write`
 
 jobs:
   release:
     runs-on: ubuntu-latest
     steps:
-      - uses: grafana/plugin-actions/create-plugin-update@create-plugin-update/v1.1.0
-        # Uncomment to use a fine-grained personal access token instead of default github token
-        # (For more info on how to generate the token see https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens)
-        # with:
-          # Make sure to save the token in your repository secrets
-          # token: ${{ secrets.GH_PAT_TOKEN }}
+      - uses: grafana/plugin-actions/create-plugin-update@create-plugin-update/v2.0.1
+        with:
+          # Make sure to save the token in your repository secrets as `GH_PAT_TOKEN`
+          token: $\{{ secrets.GH_PAT_TOKEN }}

package/templates/github/workflows/is-compatible.yml

@@ -7,18 +7,18 @@ jobs:
     permissions:
       contents: read
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
         with:
           persist-credentials: false
 
 {{#if_eq packageManagerName "pnpm"}}
       # pnpm action uses the packageManager field in package.json to
       # understand which version to install.
-      - uses: pnpm/action-setup@a7487c7e89a18df4991f7f222e4898a00d66ddda # v4.1.0
+      - uses: pnpm/action-setup@41ff72655975bd51cab0327fa583b6e92b6d3061 # v4.2.0
 {{/if_eq}}
 
       - name: Setup Node.js environment
-        uses: actions/setup-node@49933ea5288caeca8642d1e84afbd3f7d6820020 # v4.4.0
+        uses: actions/setup-node@2028fbc5c25fe9cf00d9f06a71cc4710d4507903 # v6.0.0
         with:
           node-version: '22'
           cache: '{{ packageManagerName }}'

package/templates/github/workflows/release.yml

@@ -16,7 +16,7 @@ jobs:
       contents: write
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v4
+      - uses: actions/checkout@v5
         with:
           persist-credentials: false
 

package/vitest.config.ts

@@ -9,5 +9,17 @@ export default mergeConfig(
       root: resolve(__dirname),
       setupFiles: ['./vitest.setup.ts'],
     },
+    plugins: [
+      // This plugin is used to convince Vitest the mocked virtual migrations exist.
+      // https://vitest.dev/guide/mocking/modules.html#mocking-non-existing-module
+      {
+        name: 'virtual-migrations',
+        resolveId(id) {
+          if (id === 'virtual-test-migration.js' || id === 'virtual-test-migration2.js') {
+            return id;
+          }
+        },
+      },
+    ],
   })
 );

package/dist/codemods/additions/manager.js

@@ -1,115 +0,0 @@
-import { additionsDebug, printChanges } from './utils.js';
-import defaultAdditions from './additions.js';
-import { formatFiles, flushChanges, installNPMDependencies } from '../utils.js';
-import { getConfig, isFeatureEnabled, setFeatureFlag } from '../../utils/utils.config.js';
-import { Context } from '../context.js';
-import { output } from '../../utils/utils.console.js';
-
-function getAvailableAdditions(additions = defaultAdditions.additions) {
-  return additions;
-}
-function getAdditionByName(name, additions = defaultAdditions.additions) {
-  return additions[name];
-}
-async function loadAdditionModule(addition) {
-  try {
-    const module = await import(addition.scriptPath);
-    return module;
-  } catch (error) {
-    additionsDebug('Failed to load addition module for "%s" from %s: %O', addition.name, addition.scriptPath, error);
-    return null;
-  }
-}
-async function getAdditionFlags(addition) {
-  const module = await loadAdditionModule(addition);
-  return module?.flags || [];
-}
-async function parseAdditionFlags(addition, argv) {
-  const module = await loadAdditionModule(addition);
-  if (module?.parseFlags) {
-    return module.parseFlags(argv);
-  }
-  return {};
-}
-async function validateAdditionOptions(addition, options) {
-  const flags = await getAdditionFlags(addition);
-  if (!flags || flags.length === 0) {
-    return;
-  }
-  const missingFlags = [];
-  for (const flag of flags) {
-    if (flag.required) {
-      const value = options[flag.name];
-      if (value === void 0 || value === null || Array.isArray(value) && value.length === 0) {
-        missingFlags.push(flag.name);
-      }
-    }
-  }
-  if (missingFlags.length > 0) {
-    const flagDocs = flags.filter((f) => missingFlags.includes(f.name)).map((f) => `  --${f.name}: ${f.description}`);
-    throw new Error(
-      `Missing required flag${missingFlags.length > 1 ? "s" : ""}:
-
-` + flagDocs.join("\n") + `
-
-Example: npx @grafana/create-plugin add ${addition.name} --${missingFlags[0]}=value`
-    );
-  }
-}
-async function runAdditionByName(additionName, argv) {
-  const addition = getAdditionByName(additionName);
-  if (!addition) {
-    const availableAdditions = getAvailableAdditions();
-    const additionsList = Object.keys(availableAdditions);
-    throw new Error(`Unknown addition: ${additionName}
-
-Available additions: ${additionsList.join(", ")}`);
-  }
-  const options = await parseAdditionFlags(addition, argv);
-  await validateAdditionOptions(addition, options);
-  await runAddition(addition, options);
-}
-async function runAddition(addition, additionOptions = {}) {
-  const basePath = process.cwd();
-  const config = getConfig();
-  if (isFeatureEnabled(config.features, addition.featureName)) {
-    output.log({
-      title: `Addition '${addition.name}' is already enabled`,
-      body: [`The feature flag '${addition.featureName}' is already set to true in .cprc.json.`, "No changes needed."]
-    });
-    return;
-  }
-  output.log({
-    title: `Running addition: ${addition.name}`,
-    body: [addition.description]
-  });
-  try {
-    const context = new Context(basePath);
-    const updatedContext = await executeAddition(addition, context, additionOptions);
-    additionsDebug(`context for "${addition.name} (${addition.scriptPath})":`);
-    additionsDebug("%O", updatedContext.listChanges());
-    await formatFiles(updatedContext);
-    flushChanges(updatedContext);
-    printChanges(updatedContext, addition.name, addition);
-    installNPMDependencies(updatedContext);
-    await setFeatureFlag(addition.featureName, true);
-    additionsDebug(`Set feature flag '${addition.featureName}' to true in .cprc.json`);
-    output.success({
-      title: `Successfully added ${addition.name} to your plugin.`
-    });
-  } catch (error) {
-    if (error instanceof Error) {
-      throw new Error(`Error running addition "${addition.name} (${addition.scriptPath})": ${error.message}`);
-    }
-    throw error;
-  }
-}
-async function executeAddition(addition, context, options = {}) {
-  const module = await loadAdditionModule(addition);
-  if (!module) {
-    throw new Error(`Failed to load addition module for ${addition.name}`);
-  }
-  return module.default(context, options);
-}
-
-export { executeAddition, getAdditionByName, getAdditionFlags, getAvailableAdditions, parseAdditionFlags, runAddition, runAdditionByName };

package/dist/codemods/additions/utils.js

@@ -1,10 +0,0 @@
-import { debug } from '../../utils/utils.cli.js';
-import { printChanges as printChanges$1 } from '../utils.js';
-
-const additionsDebug = debug.extend("additions");
-function printChanges(context, key, addition) {
-  additionsDebug("printChanges for addition: %s", key);
-  printChanges$1(context, key, addition);
-}
-
-export { additionsDebug, printChanges };

package/dist/codemods/migrations/utils.js

@@ -1,10 +0,0 @@
-import { debug } from '../../utils/utils.cli.js';
-import { printChanges as printChanges$1 } from '../utils.js';
-
-const migrationsDebug = debug.extend("migrations");
-function printChanges(context, key, migration) {
-  migrationsDebug("printChanges for migration: %s", key);
-  printChanges$1(context, key, migration);
-}
-
-export { migrationsDebug, printChanges };

package/src/codemods/additions/manager.ts

@@ -1,145 +0,0 @@
-import type { AdditionModule, FlagDefinition } from '../types.js';
-import { additionsDebug, printChanges } from './utils.js';
-import defaultAdditions, { AdditionMeta } from './additions.js';
-import { flushChanges, formatFiles, installNPMDependencies } from '../utils.js';
-import { getConfig, isFeatureEnabled, setFeatureFlag } from '../../utils/utils.config.js';
-
-import { Context } from '../context.js';
-import { output } from '../../utils/utils.console.js';
-
-export type AdditionOptions = Record<string, any>;
-
-export function getAvailableAdditions(
-  additions: Record<string, AdditionMeta> = defaultAdditions.additions
-): Record<string, AdditionMeta> {
-  return additions;
-}
-
-export function getAdditionByName(
-  name: string,
-  additions: Record<string, AdditionMeta> = defaultAdditions.additions
-): AdditionMeta | undefined {
-  return additions[name];
-}
-
-async function loadAdditionModule(addition: AdditionMeta): Promise<AdditionModule | null> {
-  try {
-    const module = (await import(addition.scriptPath)) as AdditionModule;
-    return module;
-  } catch (error) {
-    additionsDebug('Failed to load addition module for "%s" from %s: %O', addition.name, addition.scriptPath, error);
-    return null;
-  }
-}
-
-export async function getAdditionFlags(addition: AdditionMeta): Promise<FlagDefinition[]> {
-  const module = await loadAdditionModule(addition);
-  return module?.flags || [];
-}
-
-export async function parseAdditionFlags(addition: AdditionMeta, argv: any): Promise<AdditionOptions> {
-  const module = await loadAdditionModule(addition);
-  if (module?.parseFlags) {
-    return module.parseFlags(argv);
-  }
-  return {};
-}
-
-async function validateAdditionOptions(addition: AdditionMeta, options: AdditionOptions): Promise<void> {
-  const flags = await getAdditionFlags(addition);
-
-  if (!flags || flags.length === 0) {
-    return;
-  }
-
-  const missingFlags: string[] = [];
-
-  for (const flag of flags) {
-    if (flag.required) {
-      const value = options[flag.name];
-      if (value === undefined || value === null || (Array.isArray(value) && value.length === 0)) {
-        missingFlags.push(flag.name);
-      }
-    }
-  }
-
-  if (missingFlags.length > 0) {
-    const flagDocs = flags.filter((f) => missingFlags.includes(f.name)).map((f) => `  --${f.name}: ${f.description}`);
-
-    throw new Error(
-      `Missing required flag${missingFlags.length > 1 ? 's' : ''}:\n\n` +
-        flagDocs.join('\n') +
-        `\n\nExample: npx @grafana/create-plugin add ${addition.name} --${missingFlags[0]}=value`
-    );
-  }
-}
-
-export async function runAdditionByName(additionName: string, argv: any): Promise<void> {
-  const addition = getAdditionByName(additionName);
-  if (!addition) {
-    const availableAdditions = getAvailableAdditions();
-    const additionsList = Object.keys(availableAdditions);
-    throw new Error(`Unknown addition: ${additionName}\n\nAvailable additions: ${additionsList.join(', ')}`);
-  }
-
-  const options = await parseAdditionFlags(addition, argv);
-  await validateAdditionOptions(addition, options);
-  await runAddition(addition, options);
-}
-
-export async function runAddition(addition: AdditionMeta, additionOptions: AdditionOptions = {}): Promise<void> {
-  const basePath = process.cwd();
-
-  // Check if the feature is already enabled
-  const config = getConfig();
-  if (isFeatureEnabled(config.features, addition.featureName)) {
-    output.log({
-      title: `Addition '${addition.name}' is already enabled`,
-      body: [`The feature flag '${addition.featureName}' is already set to true in .cprc.json.`, 'No changes needed.'],
-    });
-    return;
-  }
-
-  output.log({
-    title: `Running addition: ${addition.name}`,
-    body: [addition.description],
-  });
-
-  try {
-    const context = new Context(basePath);
-    const updatedContext = await executeAddition(addition, context, additionOptions);
-
-    additionsDebug(`context for "${addition.name} (${addition.scriptPath})":`);
-    additionsDebug('%O', updatedContext.listChanges());
-
-    await formatFiles(updatedContext);
-    flushChanges(updatedContext);
-    printChanges(updatedContext, addition.name, addition);
-
-    installNPMDependencies(updatedContext);
-
-    await setFeatureFlag(addition.featureName, true);
-    additionsDebug(`Set feature flag '${addition.featureName}' to true in .cprc.json`);
-
-    output.success({
-      title: `Successfully added ${addition.name} to your plugin.`,
-    });
-  } catch (error) {
-    if (error instanceof Error) {
-      throw new Error(`Error running addition "${addition.name} (${addition.scriptPath})": ${error.message}`);
-    }
-    throw error;
-  }
-}
-
-export async function executeAddition(
-  addition: AdditionMeta,
-  context: Context,
-  options: AdditionOptions = {}
-): Promise<Context> {
-  const module = await loadAdditionModule(addition);
-  if (!module) {
-    throw new Error(`Failed to load addition module for ${addition.name}`);
-  }
-  return module.default(context, options);
-}

package/src/codemods/additions/utils.ts

@@ -1,12 +0,0 @@
-import type { AdditionMeta } from './additions.js';
-import type { Context } from '../context.js';
-import { debug } from '../../utils/utils.cli.js';
-import { printChanges as sharedPrintChanges } from '../utils.js';
-
-export const additionsDebug = debug.extend('additions');
-
-// addition-specific wrapper for printChanges.
-export function printChanges(context: Context, key: string, addition: AdditionMeta) {
-  additionsDebug('printChanges for addition: %s', key);
-  sharedPrintChanges(context, key, addition);
-}

package/src/codemods/migrations/utils.ts

@@ -1,12 +0,0 @@
-import type { Context } from '../context.js';
-import type { MigrationMeta } from './migrations.js';
-import { debug } from '../../utils/utils.cli.js';
-import { printChanges as sharedPrintChanges } from '../utils.js';
-
-export const migrationsDebug = debug.extend('migrations');
-
-// migration-specific wrapper for printChanges
-export function printChanges(context: Context, key: string, migration: MigrationMeta) {
-  migrationsDebug('printChanges for migration: %s', key);
-  sharedPrintChanges(context, key, migration);
-}