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

package/src/commands/add.command.ts

@@ -1,7 +1,7 @@
-import { getAdditionFlags, getAvailableAdditions, runAdditionByName } from '../codemods/additions/manager.js';
-import { isGitDirectory, isGitDirectoryClean } from '../utils/utils.git.js';
-
-import { isPluginDirectory } from '../utils/utils.plugin.js';
+import defaultAdditions from '../codemods/additions/additions.js';
+import { runCodemod } from '../codemods/runner.js';
+import { getPackageManagerExecCmd, getPackageManagerFromUserAgent } from '../utils/utils.packageManager.js';
+import { performPreCodemodChecks } from '../utils/utils.checks.js';
 import minimist from 'minimist';
 import { output } from '../utils/utils.console.js';
 
@@ -13,10 +13,27 @@ export const add = async (argv: minimist.ParsedArgs) => {
     process.exit(1);
   }
 
-  await performPreAddChecks(argv);
+  await performPreCodemodChecks(argv);
 
   try {
-    await runAdditionByName(subCommand, argv);
+    const addition = defaultAdditions.find((addition) => addition.name === subCommand);
+    if (!addition) {
+      const additionsList = defaultAdditions.map((addition) => addition.name);
+      throw new Error(`Unknown addition: ${subCommand}\n\nAvailable additions: ${additionsList.join(', ')}`);
+    }
+
+    output.log({
+      title: `Running addition: ${addition.name}`,
+      body: [addition.description],
+    });
+
+    // filter out minimist internal properties (_ and $0) before passing to codemod
+    const { _, $0, ...codemodOptions } = argv;
+    await runCodemod(addition, codemodOptions);
+
+    output.success({
+      title: `Successfully added ${addition.name} to your plugin.`,
+    });
   } catch (error) {
     if (error instanceof Error) {
       output.error({
@@ -29,69 +46,16 @@ export const add = async (argv: minimist.ParsedArgs) => {
 };
 
 async function showAdditionsHelp() {
-  const availableAdditions = getAvailableAdditions();
-  const additionsList = await Promise.all(
-    Object.values(availableAdditions).map(async (addition) => {
-      let info = `${addition.name} - ${addition.description}`;
-      const flags = await getAdditionFlags(addition);
-      if (flags.length > 0) {
-        const flagDocs = flags.map((flag) => {
-          const req = flag.required ? ' (required)' : ' (optional)';
-          return `  --${flag.name}: ${flag.description}${req}`;
-        });
-        info += '\n' + flagDocs.join('\n');
-      }
-      return info;
-    })
-  );
+  const additionsList = defaultAdditions.map((addition) => addition.name);
+  const { packageManagerName, packageManagerVersion } = getPackageManagerFromUserAgent();
 
   output.error({
     title: 'No addition specified',
     body: [
-      'Usage: npx @grafana/create-plugin add <addition-name> [options]',
+      `Usage: ${getPackageManagerExecCmd(packageManagerName, packageManagerVersion)} add <addition-name> [options]`,
       '',
       'Available additions:',
       ...output.bulletList(additionsList),
     ],
   });
 }
-
-async function performPreAddChecks(argv: minimist.ParsedArgs) {
-  if (!(await isGitDirectory()) && !argv.force) {
-    output.error({
-      title: 'You are not inside a git directory',
-      body: [
-        `In order to proceed please run ${output.formatCode('git init')} in the root of your project and commit your changes.`,
-        `(This check is necessary to make sure that the changes are easy to revert and don't interfere with any changes you currently have.`,
-        `In case you want to proceed as is please use the ${output.formatCode('--force')} flag.)`,
-      ],
-    });
-
-    process.exit(1);
-  }
-
-  if (!(await isGitDirectoryClean()) && !argv.force) {
-    output.error({
-      title: 'Please clean your repository working tree before adding features.',
-      body: [
-        'Commit your changes or stash them.',
-        `(This check is necessary to make sure that the changes are easy to revert and don't mess with any changes you currently have.`,
-        `In case you want to proceed as is please use the ${output.formatCode('--force')} flag.)`,
-      ],
-    });
-
-    process.exit(1);
-  }
-
-  if (!isPluginDirectory() && !argv.force) {
-    output.error({
-      title: 'Are you inside a plugin directory?',
-      body: [
-        `We couldn't find a "src/plugin.json" file under your current directory.`,
-        `(Please make sure to run this command from the root of your plugin folder. In case you want to proceed as is please use the ${output.formatCode('--force')} flag.)`,
-      ],
-    });
-
-    process.exit(1);
-  }
-}

package/src/commands/update.command.ts

@@ -5,18 +5,17 @@ import {
   getPackageManagerWithFallback,
 } from '../utils/utils.packageManager.js';
 import { gte, lt } from 'semver';
-import { isGitDirectory, isGitDirectoryClean } from '../utils/utils.git.js';
+import { performPreCodemodChecks } from '../utils/utils.checks.js';
 
 import { CURRENT_APP_VERSION } from '../utils/utils.version.js';
 import { LEGACY_UPDATE_CUTOFF_VERSION } from '../constants.js';
 import { getConfig } from '../utils/utils.config.js';
-import { isPluginDirectory } from '../utils/utils.plugin.js';
 import minimist from 'minimist';
 import { output } from '../utils/utils.console.js';
 import { spawnSync } from 'node:child_process';
 
 export const update = async (argv: minimist.ParsedArgs) => {
-  await performPreUpdateChecks(argv);
+  await performPreCodemodChecks(argv);
   const { version } = getConfig();
 
   if (lt(version, LEGACY_UPDATE_CUTOFF_VERSION)) {
@@ -32,9 +31,13 @@ export const update = async (argv: minimist.ParsedArgs) => {
       process.exit(0);
     }
 
-    const commitEachMigration = argv.commit;
     const migrations = getMigrationsToRun(version, CURRENT_APP_VERSION);
-    await runMigrations(migrations, { commitEachMigration });
+    // filter out minimist internal properties (_ and $0) before passing to codemod
+    const { _, $0, ...codemodOptions } = argv;
+    await runMigrations(migrations, {
+      commitEachMigration: !!argv.commit,
+      codemodOptions,
+    });
     output.success({
       title: `Successfully updated create-plugin from ${version} to ${CURRENT_APP_VERSION}.`,
     });
@@ -49,48 +52,6 @@ export const update = async (argv: minimist.ParsedArgs) => {
   }
 };
 
-async function performPreUpdateChecks(argv: minimist.ParsedArgs) {
-  if (!(await isGitDirectory()) && !argv.force) {
-    output.error({
-      title: 'You are not inside a git directory',
-      body: [
-        `In order to proceed please run ${output.formatCode('git init')} in the root of your project and commit your changes.`,
-        `(This check is necessary to make sure that the updates are easy to revert and don't interfere with any changes you currently have.`,
-        `In case you want to proceed as is please use the ${output.formatCode('--force')} flag.)`,
-      ],
-    });
-
-    process.exit(1);
-  }
-
-  if (!(await isGitDirectoryClean()) && !argv.force) {
-    output.error({
-      title: 'Please clean your repository working tree before updating.',
-      body: [
-        'Commit your changes or stash them.',
-        `(This check is necessary to make sure that the updates are easy to revert and don't mess with any changes you currently have.`,
-        `In case you want to proceed as is please use the ${output.formatCode('--force')} flag.)`,
-      ],
-    });
-
-    process.exit(1);
-  }
-
-  if (!isPluginDirectory() && !argv.force) {
-    output.error({
-      title: 'Are you inside a plugin directory?',
-      body: [
-        `We couldn't find a "src/plugin.json" file under your current directory.`,
-        `(Please make sure to run this command from the root of your plugin folder. In case you want to proceed as is please use the ${output.formatCode(
-          '--force'
-        )} flag.)`,
-      ],
-    });
-
-    process.exit(1);
-  }
-}
-
 /**
  * Prepares a plugin for migrations by running the legacy update command and installing dependencies.
  * This is a one time operation that ensures the plugin configs are "as expected" by the new migration system.

package/src/migrations/migrations.ts

@@ -0,0 +1,44 @@
+import { LEGACY_UPDATE_CUTOFF_VERSION } from '../constants.js';
+
+export type MigrationMeta = {
+  version: string;
+  description: string;
+  migrationScript: string;
+};
+
+type Migrations = {
+  migrations: Record<string, MigrationMeta>;
+};
+
+// Do not use LEGACY_UPDATE_CUTOFF_VERSION for new migrations. It was used to force migrations to run
+// for those written before the switch to updates as migrations.
+export default {
+  migrations: {
+    '001-update-grafana-compose-extend': {
+      version: LEGACY_UPDATE_CUTOFF_VERSION,
+      description: 'Update ./docker-compose.yaml to extend from ./.config/docker-compose-base.yaml.',
+      migrationScript: './scripts/001-update-grafana-compose-extend.js',
+    },
+    '002-update-is-compatible-workflow': {
+      version: LEGACY_UPDATE_CUTOFF_VERSION,
+      description:
+        'Update ./.github/workflows/is-compatible.yml to use is-compatible github action instead of calling levitate directly',
+      migrationScript: './scripts/002-update-is-compatible-workflow.js',
+    },
+    '003-update-eslint-deprecation-rule': {
+      version: LEGACY_UPDATE_CUTOFF_VERSION,
+      description: 'Replace deprecated eslint-plugin-deprecation with @typescript-eslint/no-deprecated rule.',
+      migrationScript: './scripts/003-update-eslint-deprecation-rule.js',
+    },
+    '004-eslint9-flat-config': {
+      version: LEGACY_UPDATE_CUTOFF_VERSION,
+      description: 'Migrate eslint config to flat config format and update devDependencies to latest versions.',
+      migrationScript: './scripts/004-eslint9-flat-config.js',
+    },
+    '005-react-18-3': {
+      version: '6.1.9',
+      description: 'Update React and ReactDOM 18.x versions to ^18.3.0 to surface React 19 compatibility issues.',
+      migrationScript: './scripts/005-react-18-3.js',
+    },
+  },
+} as Migrations;

package/src/utils/utils.checks.ts

@@ -0,0 +1,47 @@
+import minimist from 'minimist';
+import { isGitDirectory, isGitDirectoryClean } from './utils.git.js';
+import { isPluginDirectory } from './utils.plugin.js';
+import { output } from './utils.console.js';
+
+/**
+ * Ensures git directory exists, is clean, and we're in a plugin directory
+ */
+export async function performPreCodemodChecks(argv: minimist.ParsedArgs): Promise<void> {
+  if (!(await isGitDirectory()) && !argv.force) {
+    output.error({
+      title: 'You are not inside a git directory',
+      body: [
+        `In order to proceed please run ${output.formatCode('git init')} in the root of your project and commit your changes.`,
+        `(This check is necessary to make sure that changes are easy to revert and don't interfere with any changes you currently have.`,
+        `In case you want to proceed as is please use the ${output.formatCode('--force')} flag.)`,
+      ],
+    });
+
+    process.exit(1);
+  }
+
+  if (!(await isGitDirectoryClean()) && !argv.force) {
+    output.error({
+      title: 'Please clean your repository working tree before making changes.',
+      body: [
+        'Commit your changes or stash them.',
+        `(This check is necessary to make sure that changes are easy to revert and don't mess with any changes you currently have.`,
+        `In case you want to proceed as is please use the ${output.formatCode('--force')} flag.)`,
+      ],
+    });
+
+    process.exit(1);
+  }
+
+  if (!isPluginDirectory() && !argv.force) {
+    output.error({
+      title: 'Are you inside a plugin directory?',
+      body: [
+        `We couldn't find a "src/plugin.json" file under your current directory.`,
+        `(Please make sure to run this command from the root of your plugin folder. In case you want to proceed as is please use the ${output.formatCode('--force')} flag.)`,
+      ],
+    });
+
+    process.exit(1);
+  }
+}

package/src/utils/utils.config.ts

@@ -1,6 +1,4 @@
 import { argv, commandName } from './utils.cli.js';
-
-import type { AdditionFeatureName } from '../codemods/additions/additions.js';
 import { CURRENT_APP_VERSION } from './utils.version.js';
 import { DEFAULT_FEATURE_FLAGS } from '../constants.js';
 import fs from 'node:fs';
@@ -10,7 +8,7 @@ import path from 'node:path';
 import { writeFile } from 'node:fs/promises';
 import { EOL } from 'node:os';
 
-type CoreFeatureFlags = {
+type FeatureFlags = {
   bundleGrafanaUI?: boolean;
 
   // If set to true, the plugin will be scaffolded with React Router v6. Defaults to true.
@@ -21,16 +19,6 @@ type CoreFeatureFlags = {
   useExperimentalUpdates?: boolean;
 };
 
-type AdditionFeatureFlags = {
-  [K in AdditionFeatureName]?: boolean;
-};
-
-export type FeatureFlags = CoreFeatureFlags & AdditionFeatureFlags;
-
-export function isFeatureEnabled(features: FeatureFlags, featureName: AdditionFeatureName): boolean {
-  return features[featureName] === true;
-}
-
 export type CreatePluginConfig = UserConfig & {
   version: string;
 };
@@ -144,18 +132,3 @@ export async function setRootConfig(configOverride: Partial<CreatePluginConfig>
 
   return updatedConfig;
 }
-
-export async function setFeatureFlag(featureName: string, enabled = true): Promise<void> {
-  const userConfig = getUserConfig() || { features: {} };
-  const userConfigPath = path.resolve(process.cwd(), '.cprc.json');
-
-  const updatedConfig = {
-    ...userConfig,
-    features: {
-      ...userConfig.features,
-      [featureName]: enabled,
-    },
-  };
-
-  await writeFile(userConfigPath, JSON.stringify(updatedConfig, null, 2) + EOL);
-}

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;
+          }
+        },
+      },
+    ],
   })
 );