@grafana/create-plugin 4.2.5 → 4.2.6-canary.834.ce6962b.0

package/dist/commands/generate/print-success-message.js

@@ -13,7 +13,8 @@ export function printGenerateSuccessMessage(answers) {
                 '- `mage -v build:linux` to build the plugin backend code. Rerun this command every time you edit your backend files.',
             ]
             : []),
-        '- `docker-compose up` to start a grafana development server. Restart this command after each time you run mage to run your new backend code.',
+        '- `docker-compose up` to start a grafana development server. ' +
+            (answers.hasBackend ? 'Restart this command after each time you run mage to run your new backend code.' : ''),
         '- Open http://localhost:3000 in your browser to create a dashboard to begin developing your plugin.',
     ];
     const msg = `\n# Congratulations on scaffolding a Grafana ${answers.pluginType} plugin! 🚀

package/dist/utils/utils.handlebars.js

@@ -1,7 +1,7 @@
 import Handlebars from 'handlebars';
 import { camelCase, snakeCase, dotCase, pathCase, sentenceCase, constantCase, kebabCase, pascalCase, } from 'change-case';
 import { titleCase } from 'title-case';
-import { PARTIALS_DIR } from '../constants.js';
+import { PARTIALS_DIR, PLUGIN_TYPES } from '../constants.js';
 import { readFileSync, readdirSync } from 'node:fs';
 import { basename, join } from 'node:path';
 export const ifEq = (a, b, options) => {
@@ -12,7 +12,8 @@ export const normalizeId = (pluginName, orgName, type) => {
     const nameRegex = new RegExp('[^0-9a-zA-Z]', 'g');
     const newPluginName = pluginName.replace(re, '').replace(nameRegex, '');
     const newOrgName = orgName.replace(nameRegex, '');
-    return newOrgName.toLowerCase() + '-' + newPluginName.toLowerCase() + `-${type}`;
+    const newType = type === PLUGIN_TYPES.scenes ? PLUGIN_TYPES.app : type;
+    return newOrgName.toLowerCase() + '-' + newPluginName.toLowerCase() + `-${newType}`;
 };
 registerHandlebarsHelpers();
 registerHandlebarsPartials();

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

@@ -2,7 +2,7 @@
   "$schema": "https://raw.githubusercontent.com/grafana/grafana/main/docs/sources/developers/plugins/plugin.schema.json",
   "type": "app",
   "name": "{{ titleCase pluginName }}",
-  "id": "{{ normalize_id pluginName orgName 'app' }}",
+  "id": "{{ pluginId }}",
   "backend": true,
   "executable": "gpx_{{ snakeCase pluginName }}",
   "info": {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/create-plugin",
-  "version": "4.2.5",
+  "version": "4.2.6-canary.834.ce6962b.0",
   "repository": {
     "directory": "packages/create-plugin",
     "url": "https://github.com/grafana/plugin-tools"
@@ -87,5 +87,5 @@
   "engines": {
     "node": ">=20"
   },
-  "gitHead": "83b004bd75c21c6de1b04a8f7e4eb14e887aa116"
+  "gitHead": "ce6962b220c6effebbd8bc163c1b1de050bbea49"
 }

package/src/commands/generate/print-success-message.ts

@@ -15,7 +15,8 @@ export function printGenerateSuccessMessage(answers: CliArgs) {
           '- `mage -v build:linux` to build the plugin backend code. Rerun this command every time you edit your backend files.',
         ]
       : []),
-    '- `docker-compose up` to start a grafana development server. Restart this command after each time you run mage to run your new backend code.',
+    '- `docker-compose up` to start a grafana development server. ' +
+      (answers.hasBackend ? 'Restart this command after each time you run mage to run your new backend code.' : ''),
     '- Open http://localhost:3000 in your browser to create a dashboard to begin developing your plugin.',
   ];
 

package/src/utils/utils.handlebars.ts

@@ -25,7 +25,9 @@ export const normalizeId = (pluginName: string, orgName: string, type: PLUGIN_TY
 
   const newPluginName = pluginName.replace(re, '').replace(nameRegex, '');
   const newOrgName = orgName.replace(nameRegex, '');
-  return newOrgName.toLowerCase() + '-' + newPluginName.toLowerCase() + `-${type}`;
+  const newType = type === PLUGIN_TYPES.scenes ? PLUGIN_TYPES.app : type;
+
+  return newOrgName.toLowerCase() + '-' + newPluginName.toLowerCase() + `-${newType}`;
 };
 
 // Register our helpers and partials with handlebars.

package/templates/app/provisioning/plugins/apps.yaml

@@ -1,7 +1,7 @@
 apiVersion: 1
 
 apps:
-  - type: '{{ normalize_id pluginName orgName 'app' }}'
+  - type: '{{ pluginId }}'
     org_id: 1
     org_name: '{{ orgName }}'
     disabled: false

package/templates/app/src/plugin.json

@@ -2,7 +2,7 @@
   "$schema": "https://raw.githubusercontent.com/grafana/grafana/main/docs/sources/developers/plugins/plugin.schema.json",
   "type": "app",
   "name": "{{ titleCase pluginName }}",
-  "id": "{{ normalize_id pluginName orgName 'app' }}",{{#if hasBackend}}
+  "id": "{{ pluginId }}",{{#if hasBackend}}
   "backend": true,
   "executable": "gpx_{{ snakeCase pluginName }}",{{/if}}
   "info": {

package/templates/backend/pkg/main.go

@@ -17,8 +17,8 @@ func main() {
 	// from Grafana to create different instances of SampleDatasource (per datasource
 	// ID). When datasource configuration changed Dispose method will be called and
 	// new datasource instance created using NewSampleDatasource factory.
-	if err := datasource.Manage("{{ normalize_id pluginName orgName pluginType }}", plugin.NewDatasource, datasource.ManageOpts{}); err != nil {
+	if err := datasource.Manage("{{ pluginId }}", plugin.NewDatasource, datasource.ManageOpts{}); err != nil {
 		log.DefaultLogger.Error(err.Error())
 		os.Exit(1)
 	}
-}
+}

package/templates/backend-app/pkg/main.go

@@ -16,7 +16,7 @@ func main() {
 	// argument. This factory will be automatically called on incoming request
 	// from Grafana to create different instances of `App` (per plugin
 	// ID).
-	if err := app.Manage("{{ normalize_id pluginName orgName pluginType }}", plugin.NewApp, app.ManageOpts{}); err != nil {
+	if err := app.Manage("{{ pluginId }}", plugin.NewApp, app.ManageOpts{}); err != nil {
 		log.DefaultLogger.Error(err.Error())
 		os.Exit(1)
 	}

package/templates/datasource/provisioning/datasources/datasources.yml

@@ -2,7 +2,7 @@ apiVersion: 1
 
 datasources:
   - name: '{{ pluginName }}'
-    type: '{{ normalize_id pluginName orgName 'datasource' }}'
+    type: '{{ pluginId }}'
     access: proxy
     isDefault: false
     orgId: 1

package/templates/datasource/src/plugin.json

@@ -2,7 +2,7 @@
   "$schema": "https://raw.githubusercontent.com/grafana/grafana/main/docs/sources/developers/plugins/plugin.schema.json",
   "type": "datasource",
   "name": "{{ titleCase pluginName }}",
-  "id": "{{ normalize_id pluginName orgName 'datasource' }}",
+  "id": "{{ pluginId }}",
   "metrics": true,{{#if hasBackend}}
   "backend": true,
   "executable": "gpx_{{ snakeCase pluginName }}",{{/if}}

package/templates/panel/src/plugin.json

@@ -2,7 +2,7 @@
   "$schema": "https://raw.githubusercontent.com/grafana/grafana/main/docs/sources/developers/plugins/plugin.schema.json",
   "type": "panel",
   "name": "{{ titleCase pluginName }}",
-  "id": "{{ normalize_id pluginName orgName 'panel' }}",
+  "id": "{{ pluginId }}",
   "info": {
     "keywords": ["panel"],
     "description": "{{ sentenceCase pluginDescription }}",

package/templates/scenes-app/provisioning/plugins/app.yaml

@@ -1,7 +1,7 @@
 apiVersion: 1
 
 apps:
-  - type: '{{ normalize_id pluginName orgName 'app' }}'
+  - type: '{{ pluginId }}'
     org_id: 1
     org_name: '{{ orgName }}'
     disabled: false

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

@@ -2,7 +2,7 @@
   "$schema": "https://raw.githubusercontent.com/grafana/grafana/main/docs/sources/developers/plugins/plugin.schema.json",
   "type": "app",
   "name": "{{ titleCase pluginName }}",
-  "id": "{{ normalize_id pluginName orgName 'app' }}",{{#if hasBackend}}
+  "id": "{{ pluginId }}",{{#if hasBackend}}
   "backend": true,
   "executable": "gpx_{{ snakeCase pluginName }}",{{/if}}
   "info": {