@grafana/create-plugin 6.3.0-canary.2314.19540157259.0 → 6.3.0-canary.2319.19627830170.0

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+# v6.2.2 (Fri Nov 21 2025)
+
+#### 🐛 Bug Fix
+
+- fix(deps): update dependency glob to v11.1.0 [security] [#2308](https://github.com/grafana/plugin-tools/pull/2308) ([@renovate-sh-app[bot]](https://github.com/renovate-sh-app[bot]))
+
+#### Authors: 1
+
+- [@renovate-sh-app[bot]](https://github.com/renovate-sh-app[bot])
+
+---
+
 # v6.2.1 (Thu Nov 20 2025)
 
 #### 🐛 Bug Fix

package/dist/constants.js

@@ -1,13 +1,13 @@
 import { fileURLToPath } from 'node:url';
 import path from 'node:path';
 
-const __dirname = fileURLToPath(new URL(".", import.meta.url));
+const __dirname$1 = fileURLToPath(new URL(".", import.meta.url));
 const IS_DEV = process.env.CREATE_PLUGIN_DEV !== void 0;
 const EXPORT_PATH_PREFIX = process.cwd();
-path.join(__dirname, "dist");
-const TEMPLATES_DIR = path.join(__dirname, "..", "templates");
+path.join(__dirname$1, "dist");
+const TEMPLATES_DIR = path.join(__dirname$1, "..", "templates");
 const PARTIALS_DIR = path.join(TEMPLATES_DIR, "_partials");
-path.join(__dirname, "..", "fixtures");
+path.join(__dirname$1, "..", "fixtures");
 const TEMPLATE_PATHS = {
   app: path.join(TEMPLATES_DIR, "app"),
   scenesapp: path.join(TEMPLATES_DIR, "scenes-app"),

package/dist/libs/version/src/index.js

@@ -2,9 +2,9 @@ import { findUpSync } from 'find-up';
 import { readFileSync } from 'node:fs';
 import { fileURLToPath } from 'node:url';
 
-const __dirname = fileURLToPath(new URL(".", import.meta.url));
+const __dirname$1 = fileURLToPath(new URL(".", import.meta.url));
 function getVersion() {
-  const packageJsonPath = findUpSync("package.json", { cwd: __dirname });
+  const packageJsonPath = findUpSync("package.json", { cwd: __dirname$1 });
   if (!packageJsonPath) {
     throw `Could not find package.json`;
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/create-plugin",
-  "version": "6.3.0-canary.2314.19540157259.0",
+  "version": "6.3.0-canary.2319.19627830170.0",
   "repository": {
     "directory": "packages/create-plugin",
     "url": "https://github.com/grafana/plugin-tools"
@@ -32,7 +32,7 @@
     "debug": "^4.3.4",
     "enquirer": "^2.4.1",
     "find-up": "^8.0.0",
-    "glob": "^11.0.0",
+    "glob": "^11.1.0",
     "handlebars": "^4.7.8",
     "jsonc-parser": "^3.3.1",
     "minimist": "^1.2.8",
@@ -61,5 +61,5 @@
   "engines": {
     "node": ">=20"
   },
-  "gitHead": "ca948602b5bf553b3e538bf2285f6f61d3ec849c"
+  "gitHead": "e62bbbc7de46e7d822179afb84d620b5e809b50e"
 }

package/src/codemods/AGENTS.md

@@ -0,0 +1,25 @@
+# Create Plugin Codemods Guide
+
+This guide provides specific instructions for working with migrations and additions in the create-plugin package.
+
+## Agent Behavior
+
+- Refer to current migrations and additions typescript files found in @./additions/scripts and @./migrations/scripts
+- When creating a new migration add it to the exported migrations object in @./migrations/migrations.ts
+- Always refer to @./context.ts to know what methods are available on the context class
+- Always check for file existence using the @./context.ts class before attempting to do anything with it
+- Never write files with any 3rd party npm library. Use the context for all file operations
+- Always return the context for the next migration
+- Test thoroughly using the provided utils in @./test-utils.ts where necessary
+- Each migration must be idempotent and must include a test case that uses the `.toBeIdempotent` custom matcher found in @../../vitest.setup.ts
+- Keep migrations focused on one task
+- Never attempt to read or write files outside the current working directory
+
+## Naming Conventions
+
+- Each migration lives under @./migrations/scripts
+- Migration filenames follow the format: `NNN-migration-title` where migration-title is, at the most, a three word summary of what the migration does and NNN is the next number in sequence based on the current file name in @./migrations/scripts
+- Each migration must have:
+  - `NNN-migration-title.ts` - main migration logic
+  - `NNN-migration-title.test.ts` - migration logic tests
+- Each migration should export a default function named "migrate"

package/templates/github/workflows/ci.yml

@@ -247,7 +247,7 @@ jobs:
           # required for playwright-gh-pages
           persist-credentials: true
       - name: Publish report
-        uses: grafana/plugin-actions/playwright-gh-pages/deploy-report-pages@deploy-report-pages/v1.0.1
+        uses: grafana/plugin-actions/playwright-gh-pages/deploy-report-pages@deploy-report-pages/v1.1.0
         with:
           github-token: $\{{ secrets.GITHUB_TOKEN }}
 

package/templates/panel/.config/AGENTS/instructions.md

@@ -1,83 +0,0 @@
----
-name: panel-plugin-agent-fundamentals
-description: Develops Grafana panel plugins
----
-
-You are an expert Grafana panel plugin developer for this project.
-
-## Your role
-
-- You are fluent in TypeScript and React
-- You know how to use Grafana dashboards
-
-## Project knowledge
-
-This repository contains a **Grafana panel plugin**, providing a custom visualization for Grafana dashboards.
-Panel plugins are used to:
-
-- Display data from Grafana data sources in custom ways
-- Add interactive behavior (drill-downs, navigation, etc.)
-- Visualize or control external systems (IoT, integrations, custom controls)
-
-### Plugin anatomy
-
-A typical panel plugin includes:
-
-**plugin.json**
-
-- Declares plugin ID, type (`panel`), name, version
-- Loaded by Grafana at startup
-
-**Main module (`src/module.ts`)**
-
-- Exports: `new PanelPlugin(PanelComponent)`
-- Registers panel options, migrations, defaults, ui extensions
-
-**Panel component (`src/components/Panel.tsx`)**
-
-- React component receiving: `data`, `timeRange`, `width`, `height`, `options`
-- Renders visualization using Grafana data frames and field configs
-
-### Repository layout
-
-- `plugin.json` — Panel plugin manifest
-- `src/module.ts` — Main plugin entry
-- `src/components/` — Panel React components
-- `src/types.ts` — Option and model types
-- `tests/` — E2E tests (if present)
-- `provisioning/` — Local development provisioning
-- `README.md` — Human documentation
-
-## Coding guidelines
-
-- Use **TypeScript** and **functional React components**
-- Use **@grafana/ui**, **@grafana/data**, **@grafana/runtime**
-- Respect `width` and `height`; keep layout responsive
-- Avoid unnecessary dependencies; ensure Grafana compatibility
-- Use useTheme2() from @grafana/ui for visual tokens
-- Never hardcode colors, spacing, padding, or font sizes.
-- Use useStyles2(), Emotion and visual tokens from the theme to create styles.
-- Follow existing file structure
-- Keep code typed and predictable
-
-## Boundaries
-
-You must **not**:
-
-- Change plugin IDs or plugin type in `plugin.json`
-- Modify anything under `.config/*`
-- Add a backend — panel plugins are **frontend only**
-- Remove or change existing options without a migration handler
-- Break public APIs (options, field configs, panel props)
-- Store or use credentials.
-
-You **should**:
-
-- Keep the plugin backward compatible
-- Preserve the existing options schema unless adding a migration handler
-- Mirror patterns from Grafana’s official panel plugin examples
-- Follow idiomatic React + TypeScript patterns used in official Grafana examples
-
-## Instructions for specific tasks
-
-- [Add panel options](./tasks/add-panel-options.md)

package/templates/panel/.config/AGENTS/tasks/add-panel-options.md

@@ -1,132 +0,0 @@
-# Adding a New Panel Option
-
-Panel options are settings the user configures to change panel behavior.
-
-Always complete **all three steps**:
-
-### **1. Extend the options type**
-
-File: `src/types.ts`
-
-```ts
-export interface SimpleOptions {
-  // existing...
-  myOptionName: MyOptionType;
-}
-```
-
-- Property name must match the builder `path`.
-- Type must match expected editor output.
-
----
-
-### **2. Register the option in `setPanelOptions`**
-
-File: `src/module.ts` inside `setPanelOptions((builder) => { ... })`
-
-Use the correct builder method:
-
-| Type               | Builder              |
-| ------------------ | -------------------- |
-| boolean            | `addBooleanSwitch`   |
-| number             | `addNumberInput`     |
-| string             | `addTextInput`       |
-| select             | `addSelect`          |
-| radio              | `addRadio`           |
-| radio group        | `addRadio`           |
-| slider             | `addSliderInput`     |
-| color picker       | `addColorPicker`     |
-| unit picker        | `addUnitPicker`      |
-| field namer picker | `addFieldNamePicker` |
-
-Template:
-
-```ts
-builder.addXxx({
-  path: 'myOptionName',   // must match type property
-  name: 'My option',
-  defaultValue: <default>,
-  description: '',
-  settings: { /* optional */ },
-  // Optional visibility rule:
-  // showIf: (opts) => opts.someOtherOption,
-});
-```
-
-Rules:
-
-- Every option **must** have a `defaultValue`.
-- Put numeric constraints in `settings` (`min`, `max`, `step`).
-- Use `showIf` for conditional display.
-
----
-
-### **3. Use the option in the panel component**
-
-File: `src/Panel.tsx` (or equivalent)
-
-```tsx
-export const Panel = ({ options }) => {
-  const { myOptionName } = options;
-  // apply it in rendering/logic
-};
-```
-
-No option may remain unused.
-
----
-
-# Quick Editor Recipes
-
-### **Boolean**
-
-```ts
-.addBooleanSwitch({ path: 'flag', name: 'Flag', defaultValue: false })
-```
-
-### **Number**
-
-```ts
-.addNumberInput({
-  path: 'max',
-  name: 'Max value',
-  defaultValue: 10,
-  settings: { min: 1, max: 100, step: 1 },
-})
-```
-
-### **String**
-
-```ts
-.addTextInput({ path: 'label', name: 'Label', defaultValue: '' })
-```
-
-### **Select**
-
-```ts
-.addSelect({
-  path: 'mode',
-  name: 'Mode',
-  defaultValue: 'auto',
-  settings: { options: [
-    { value: 'a', label: 'A' },
-    { value: 'b', label: 'B' },
-  ]},
-})
-```
-
-### **Radio**
-
-```ts
-.addRadio({
-  path: 'size',
-  name: 'Size',
-  defaultValue: 'md',
-  settings: { options: [
-    { value: 'sm', label: 'Small' },
-    { value: 'md', label: 'Medium' },
-    { value: 'lg', label: 'Large' },
-  ]},
-  showIf: (o) => o.showSize,
-})
-```

package/templates/panel/AGENTS.md

@@ -1,10 +0,0 @@
----
-name: panel-plugin-agent
-description: Develops Grafana panel plugins
----
-
-## Project knowledge
-
-This repository contains a **Grafana panel plugin**. Follow the [instructions](./.config/AGENTS/instructions.md) before doing any changes.
-
-All build, lint, test, and Docker dev-server commands are documented in the "Getting started" section of [README.md](./README.md). Prefer running the non-watch versions of these commands.