@grafana/create-plugin 4.13.0 → 4.14.0-canary.970.663d3f9.0

package/dist/commands/update.command.js

@@ -3,8 +3,7 @@ import { printRedBox, printBlueBox } from '../utils/utils.console.js';
 import { updatePackageJson, updateNpmScripts } from '../utils/utils.npm.js';
 import { isGitDirectory, isGitDirectoryClean } from '../utils/utils.git.js';
 import { isPluginDirectory, updateDotConfigFolder } from '../utils/utils.plugin.js';
-import { EXTRA_TEMPLATE_VARIABLES } from '../constants.js';
-import { getVersion } from '../utils/utils.version.js';
+import { getVersion, getGrafanaRuntimeVersion } from '../utils/utils.version.js';
 import { getPackageManagerFromUserAgent } from '../utils/utils.packageManager.js';
 export const update = async (argv) => {
     const { packageManagerName } = getPackageManagerFromUserAgent();
@@ -43,7 +42,7 @@ In case you want to proceed as is please use the ${chalk.bold('--force')} flag.)
         });
         printBlueBox({
             title: 'Update successful ✔',
-            content: `${chalk.bold('@grafana/* package version:')} ${EXTRA_TEMPLATE_VARIABLES.grafanaVersion}
+            content: `${chalk.bold('@grafana/* package version:')} ${getGrafanaRuntimeVersion()}
 ${chalk.bold('@grafana/create-plugin version:')} ${getVersion()}
 
 ${chalk.bold.underline('Next steps:')}

package/dist/constants.js

@@ -28,7 +28,6 @@ export var PLUGIN_TYPES;
     PLUGIN_TYPES["scenes"] = "scenesapp";
 })(PLUGIN_TYPES || (PLUGIN_TYPES = {}));
 export const EXTRA_TEMPLATE_VARIABLES = {
-    grafanaVersion: '10.3.3',
     grafanaImage: 'grafana-enterprise',
 };
 export const DEFAULT_FEATURE_FLAGS = {

package/dist/utils/utils.templates.js

@@ -10,7 +10,7 @@ import { getPluginJson } from './utils.plugin.js';
 import { TEMPLATE_PATHS, EXPORT_PATH_PREFIX, EXTRA_TEMPLATE_VARIABLES, PLUGIN_TYPES, DEFAULT_FEATURE_FLAGS, } from '../constants.js';
 import { getPackageManagerInstallCmd, getPackageManagerWithFallback, getPackageManagerFromUserAgent, } from './utils.packageManager.js';
 import { getExportFileName } from '../utils/utils.files.js';
-import { getVersion } from './utils.version.js';
+import { getGrafanaRuntimeVersion, getVersion } from './utils.version.js';
 import { getConfig } from './utils.config.js';
 const debug = createDebug('templates');
 export function getTemplateFiles(pluginType, filter) {
@@ -58,7 +58,7 @@ export function renderTemplateFromFile(templateFile, data) {
 export function getTemplateData(cliArgs) {
     const { features } = getConfig();
     const currentVersion = getVersion();
-    const grafanaVersion = EXTRA_TEMPLATE_VARIABLES.grafanaVersion;
+    const grafanaVersion = getGrafanaRuntimeVersion();
     const usePlaywright = features.usePlaywright === true || isFile(path.join(process.cwd(), 'playwright.config.ts'));
     const useCypress = !usePlaywright && semverLt(grafanaVersion, '11.0.0') && fs.existsSync(path.join(process.cwd(), 'cypress'));
     const bundleGrafanaUI = features.bundleGrafanaUI ?? DEFAULT_FEATURE_FLAGS.bundleGrafanaUI;

package/dist/utils/utils.version.js

@@ -1,6 +1,7 @@
 import { readFileSync } from 'node:fs';
-import { resolve } from 'node:path';
+import path, { resolve } from 'node:path';
 import { fileURLToPath } from 'node:url';
+import { TEMPLATE_PATHS } from '../constants.js';
 const __dirname = fileURLToPath(new URL('.', import.meta.url));
 export function getVersion() {
     const packageJsonPath = resolve(__dirname, '..', '..', 'package.json');
@@ -11,3 +12,9 @@ export function getVersion() {
     }
     return version;
 }
+export function getGrafanaRuntimeVersion() {
+    const packageJsonPath = path.join(TEMPLATE_PATHS.common, '_package.json');
+    const pkg = readFileSync(packageJsonPath, 'utf8');
+    const { version } = /\"(@grafana\/runtime)\":\s\"\^(?<version>.*)\"/.exec(pkg)?.groups ?? {};
+    return version;
+}

package/fixtures/test-template/src/plugin.json

@@ -29,7 +29,7 @@
     }
   ],
   "dependencies": {
-    "grafanaDependency": ">={{ grafanaVersion }}",
+    "grafanaDependency": ">=10.3.2",
     "plugins": []
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/create-plugin",
-  "version": "4.13.0",
+  "version": "4.14.0-canary.970.663d3f9.0",
   "repository": {
     "directory": "packages/create-plugin",
     "url": "https://github.com/grafana/plugin-tools"
@@ -87,5 +87,5 @@
   "engines": {
     "node": ">=20"
   },
-  "gitHead": "0d126394b9c16cdbd47e3749cb25f258a233ac1a"
+  "gitHead": "663d3f91c7b8e4de18471e706f881016b5310d06"
 }

package/src/commands/update.command.ts

@@ -4,8 +4,7 @@ import { printRedBox, printBlueBox } from '../utils/utils.console.js';
 import { updatePackageJson, updateNpmScripts } from '../utils/utils.npm.js';
 import { isGitDirectory, isGitDirectoryClean } from '../utils/utils.git.js';
 import { isPluginDirectory, updateDotConfigFolder } from '../utils/utils.plugin.js';
-import { EXTRA_TEMPLATE_VARIABLES } from '../constants.js';
-import { getVersion } from '../utils/utils.version.js';
+import { getVersion, getGrafanaRuntimeVersion } from '../utils/utils.version.js';
 import { getPackageManagerFromUserAgent } from '../utils/utils.packageManager.js';
 
 export const update = async (argv: minimist.ParsedArgs) => {
@@ -57,7 +56,7 @@ In case you want to proceed as is please use the ${chalk.bold('--force')} flag.)
 
     printBlueBox({
       title: 'Update successful ✔',
-      content: `${chalk.bold('@grafana/* package version:')} ${EXTRA_TEMPLATE_VARIABLES.grafanaVersion}
+      content: `${chalk.bold('@grafana/* package version:')} ${getGrafanaRuntimeVersion()}
 ${chalk.bold('@grafana/create-plugin version:')} ${getVersion()}
 
 ${chalk.bold.underline('Next steps:')}

package/src/constants.ts

@@ -41,9 +41,7 @@ export enum PLUGIN_TYPES {
 
 // This gets merged into variables coming from user prompts (when scaffolding) or any other dynamic variables,
 // and will be available to use in the templates.
-// Example: "@grafana/ui": "{{ grafanaVersion }}"
 export const EXTRA_TEMPLATE_VARIABLES = {
-  grafanaVersion: '10.3.3',
   grafanaImage: 'grafana-enterprise',
 };
 

package/src/utils/utils.templates.ts

@@ -21,7 +21,7 @@ import {
   getPackageManagerFromUserAgent,
 } from './utils.packageManager.js';
 import { getExportFileName } from '../utils/utils.files.js';
-import { getVersion } from './utils.version.js';
+import { getGrafanaRuntimeVersion, getVersion } from './utils.version.js';
 import { getConfig } from './utils.config.js';
 
 const debug = createDebug('templates');
@@ -96,7 +96,7 @@ export function renderTemplateFromFile(templateFile: string, data?: any) {
 export function getTemplateData(cliArgs?: GenerateCliArgs): TemplateData {
   const { features } = getConfig();
   const currentVersion = getVersion();
-  const grafanaVersion = EXTRA_TEMPLATE_VARIABLES.grafanaVersion;
+  const grafanaVersion = getGrafanaRuntimeVersion();
   const usePlaywright = features.usePlaywright === true || isFile(path.join(process.cwd(), 'playwright.config.ts'));
   //@grafana/e2e was deprecated in Grafana 11
   const useCypress =

package/src/utils/utils.version.ts

@@ -1,6 +1,7 @@
 import { readFileSync } from 'node:fs';
-import { resolve } from 'node:path';
+import path, { resolve } from 'node:path';
 import { fileURLToPath } from 'node:url';
+import { TEMPLATE_PATHS } from '../constants.js';
 
 const __dirname = fileURLToPath(new URL('.', import.meta.url));
 
@@ -13,3 +14,10 @@ export function getVersion(): string {
   }
   return version;
 }
+
+export function getGrafanaRuntimeVersion() {
+  const packageJsonPath = path.join(TEMPLATE_PATHS.common, '_package.json');
+  const pkg = readFileSync(packageJsonPath, 'utf8');
+  const { version } = /\"(@grafana\/runtime)\":\s\"\^(?<version>.*)\"/.exec(pkg)?.groups ?? {};
+  return version;
+}

package/templates/app/src/plugin.json

@@ -62,7 +62,7 @@
     }
   ],
   "dependencies": {
-    "grafanaDependency": ">={{ grafanaVersion }}",
+    "grafanaDependency": ">=10.4.0",
     "plugins": []
   }
 }

package/templates/backend/src/datasource.ts

@@ -12,7 +12,7 @@ export class DataSource extends DataSourceWithBackend<MyQuery, MyDataSourceOptio
     return DEFAULT_QUERY;
   }
 
-  applyTemplateVariables(query: MyQuery, scopedVars: ScopedVars): Record<string, any> {
+  applyTemplateVariables(query: MyQuery, scopedVars: ScopedVars) {
     return {
       ...query,
       queryText: getTemplateSrv().replace(query.queryText, scopedVars),

package/templates/common/.config/webpack/utils.ts

@@ -29,6 +29,11 @@ export function getPluginJson() {
   return require(path.resolve(process.cwd(), `${SOURCE_DIR}/plugin.json`));
 }
 
+export function getCPConfigVersion() {
+  const cprcJson = path.resolve(__dirname, '../', '.cprc.json');
+  return fs.existsSync(cprcJson) ? require(cprcJson).version : { version: 'unknown' };
+}
+
 export function hasReadme() {
   return fs.existsSync(path.resolve(process.cwd(), SOURCE_DIR, 'README.md'));
 }

package/templates/common/.config/webpack/webpack.config.ts

@@ -11,12 +11,14 @@ import ForkTsCheckerWebpackPlugin from 'fork-ts-checker-webpack-plugin';
 import LiveReloadPlugin from 'webpack-livereload-plugin';
 import path from 'path';
 import ReplaceInFileWebpackPlugin from 'replace-in-file-webpack-plugin';
-import { Configuration } from 'webpack';
+import TerserPlugin from 'terser-webpack-plugin';
+import { type Configuration, BannerPlugin } from 'webpack';
 
-import { getPackageJson, getPluginJson, hasReadme, getEntries, isWSL } from './utils';
+import { getPackageJson, getPluginJson, hasReadme, getEntries, isWSL, getCPConfigVersion } from './utils';
 import { SOURCE_DIR, DIST_DIR } from './constants';
 
 const pluginJson = getPluginJson();
+const cpVersion = getCPConfigVersion();
 
 const config = async (env): Promise<Configuration> => {
   const baseConfig: Configuration = {
@@ -133,6 +135,28 @@ const config = async (env): Promise<Configuration> => {
       ],
     },
 
+    optimization: {
+      minimize: Boolean(env.production),
+      minimizer: [
+        new TerserPlugin({
+          terserOptions: {
+            format: {
+              comments: (_, comment) => /^\**!|@preserve|@license|@cc_on|\[create-plugin\]/i.test(comment.value),
+            },
+          },
+          extractComments: (_, comment) => {
+            const { value, type } = comment;
+            // Keep `[create-plugin]` comments in the output
+            if (type === 'comment2' && value.startsWith('[create-plugin]')) {
+              return false;
+            }
+            // Extract other comments
+            return /^\**!|@preserve|@license|@cc_on/i.test(value);
+          },
+        }),
+      ],
+    },
+
     output: {
       clean: {
         keep: new RegExp(`(.*?_(amd64|arm(64)?)(.exe)?|go_plugin_build_manifest)`),
@@ -147,6 +171,12 @@ const config = async (env): Promise<Configuration> => {
     },
 
     plugins: [
+      // Insert create plugin version information into the bundle
+      new BannerPlugin({
+        banner: "/* [create-plugin] version: " + cpVersion + " */",
+        raw: true,
+        entryOnly: true,
+      }),
       new CopyWebpackPlugin({
         patterns: [
           // If src/README.md exists use it; otherwise the root README

package/templates/common/_package.json

@@ -20,10 +20,10 @@
   "license": "Apache-2.0",
   "devDependencies": {
     "@babel/core": "^7.21.4",{{#if useCypress}}
-    "@grafana/e2e": "{{ grafanaVersion }}",
-    "@grafana/e2e-selectors": "{{ grafanaVersion }}",{{/if}}
+    "@grafana/e2e": "^10.4.0",
+    "@grafana/e2e-selectors": "^10.4.0",{{/if}}
     "@grafana/eslint-config": "^7.0.0",{{#if usePlaywright}}
-    "@grafana/plugin-e2e": "1.2.0",{{/if}}
+    "@grafana/plugin-e2e": "^1.2.0",{{/if}}
     "@grafana/tsconfig": "^1.2.0-rc1",{{#if usePlaywright}}
     "@playwright/test": "^1.41.2",{{/if}}
     "@swc/core": "^1.3.90",
@@ -63,10 +63,10 @@
   },
   "dependencies": {
     "@emotion/css": "11.10.6",
-    "@grafana/data": "{{ grafanaVersion }}",
-    "@grafana/runtime": "{{ grafanaVersion }}",
-    "@grafana/ui": "{{ grafanaVersion }}",
-    "@grafana/schema": "{{ grafanaVersion }}",{{#if_eq pluginType "scenesapp"}}
+    "@grafana/data": "^10.4.0",
+    "@grafana/runtime": "^10.4.0",
+    "@grafana/ui": "^10.4.0",
+    "@grafana/schema": "^10.4.0",{{#if_eq pluginType "scenesapp"}}
     "@grafana/scenes": "^3.6.0",{{/if_eq}}
     "react": "18.2.0",
     "react-dom": "18.2.0",{{#if isAppType}}

package/templates/common/docker-compose.yaml

@@ -8,7 +8,7 @@ services:
       context: ./.config
       args:
         grafana_image: ${GRAFANA_IMAGE:-{{~grafanaImage~}} }
-        grafana_version: ${GRAFANA_VERSION:-{{~grafanaVersion~}} }
+        grafana_version: ${GRAFANA_VERSION:-10.4.0}
         development: ${DEVELOPMENT:-false}
     ports:
       - 3000:3000/tcp

package/templates/datasource/src/plugin.json

@@ -22,7 +22,7 @@
     "updated": "%TODAY%"
   },
   "dependencies": {
-    "grafanaDependency": ">={{ grafanaVersion }}",
+    "grafanaDependency": ">=10.4.0",
     "plugins": []
   }
 }

package/templates/panel/src/plugin.json

@@ -19,7 +19,7 @@
     "updated": "%TODAY%"
   },
   "dependencies": {
-    "grafanaDependency": ">={{ grafanaVersion }}",
+    "grafanaDependency": ">=10.4.0",
     "plugins": []
   }
 }

package/templates/scenes-app/src/plugin.json

@@ -56,7 +56,7 @@
     }
   ],
   "dependencies": {
-    "grafanaDependency": ">={{ grafanaVersion }}",
+    "grafanaDependency": ">=10.4.0",
     "plugins": []
   }
 }