@grafana/create-plugin 0.8.0 → 0.8.2-canary.182.820acd2.0

package/CHANGELOG.md

@@ -1,3 +1,19 @@
+# v0.8.1 (Tue Dec 13 2022)
+
+:tada: This release contains work from a new contributor! :tada:
+
+Thank you, Erik Sundell ([@sunker](https://github.com/sunker)), for all your work!
+
+#### 🐛 Bug Fix
+
+- Templates: Use getDefaultQuery method to set query default values [#173](https://github.com/grafana/plugin-tools/pull/173) ([@sunker](https://github.com/sunker))
+
+#### Authors: 1
+
+- Erik Sundell ([@sunker](https://github.com/sunker))
+
+---
+
 # v0.8.0 (Wed Nov 30 2022)
 
 #### 🚀 Enhancement

package/dist/commands/generate.plopfile.js

@@ -68,7 +68,7 @@ function default_1(plop) {
                 name: 'pluginType',
                 type: 'list',
                 choices: [constants_1.PLUGIN_TYPES.app, constants_1.PLUGIN_TYPES.datasource, constants_1.PLUGIN_TYPES.panel],
-                message: 'What kind of plugin would you like? '
+                message: 'What type of plugin would you like?'
             },
             {
                 name: 'hasBackend',
@@ -196,6 +196,6 @@ function printSuccessMessage(answers) {
     ], (answers.hasBackend ? ['- `mage -v build:linux` to build the plugin backend code.'] : []), true), [
         '- Open http://localhost:3000 in your browser to create a dashboard to begin developing your plugin.',
     ], false);
-    var msg = "\nCongratulations on scaffolding a Grafana ".concat(answers.pluginType, " plugin! \uD83D\uDE80\n\n## What's next?\n\nRun the following commands to get started:\n").concat(commands.map(function (command) { return command; }).join('\n'), "\n\n_Note: We strongly recommend creating a new Git repository by running `git init` in ./").concat(directory, " before continuing._\n\n- View ./").concat(directory, "/README.md\n- Learn more about Grafana Plugins at https://grafana.com/docs/grafana/latest/plugins/developing/development/\n");
+    var msg = "\nCongratulations on scaffolding a Grafana ".concat(answers.pluginType, " plugin! \uD83D\uDE80\n\n## What's next?\n\nRun the following commands to get started:\n").concat(commands.map(function (command) { return command; }).join('\n'), "\n\n_Note: We strongly recommend creating a new Git repository by running `git init` in ./").concat(directory, " before continuing._\n\n- View create-plugin documentation at https://grafana.github.io/plugin-tools/\n- Learn more about Grafana Plugins at https://grafana.com/docs/grafana/latest/plugins/developing/development/\n");
     return (0, utils_console_1.displayAsMarkdown)(msg);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/create-plugin",
-  "version": "0.8.0",
+  "version": "0.8.2-canary.182.820acd2.0",
   "main": "index.js",
   "repository": {
     "directory": "packages/create-plugin",
@@ -60,5 +60,5 @@
   "engines": {
     "node": ">=16"
   },
-  "gitHead": "bb69dd167db675f1d90a1a31744b89bb0cd5ebc6"
+  "gitHead": "820acd28975420b9d0b38e143fa76c6e80e4cbe8"
 }

package/src/commands/generate.plopfile.ts

@@ -65,7 +65,7 @@ export default function (plop: NodePlopAPI) {
         name: 'pluginType',
         type: 'list',
         choices: [PLUGIN_TYPES.app, PLUGIN_TYPES.datasource, PLUGIN_TYPES.panel],
-        message: 'What kind of plugin would you like? ',
+        message: 'What type of plugin would you like?',
       },
       {
         name: 'hasBackend',
@@ -268,7 +268,7 @@ ${commands.map((command) => command).join('\n')}
 
 _Note: We strongly recommend creating a new Git repository by running \`git init\` in ./${directory} before continuing._
 
-- View ./${directory}/README.md
+- View create-plugin documentation at https://grafana.github.io/plugin-tools/
 - Learn more about Grafana Plugins at https://grafana.com/docs/grafana/latest/plugins/developing/development/
 `;
 

package/templates/backend/src/datasource.ts

@@ -1,10 +1,14 @@
-import { DataSourceInstanceSettings } from '@grafana/data';
-
-import { MyQuery, MyDataSourceOptions } from './types';
+import { DataSourceInstanceSettings, CoreApp } from '@grafana/data';
 import { DataSourceWithBackend } from '@grafana/runtime';
 
+import { MyQuery, MyDataSourceOptions, DEFAULT_QUERY } from './types';
+
 export class DataSource extends DataSourceWithBackend<MyQuery, MyDataSourceOptions> {
   constructor(instanceSettings: DataSourceInstanceSettings<MyDataSourceOptions>) {
     super(instanceSettings);
   }
+
+  getDefaultQuery(_: CoreApp): Partial<MyQuery> {
+    return DEFAULT_QUERY
+  }
 }

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

@@ -21,21 +21,22 @@ export function hasReadme() {
 }
 
 export async function getEntries(): Promise<Record<string, string>> {
-  const parent = '..';
-  const pluginsJson = await globAsync('**/src/**/plugin.json');
-  
-  const plugins = await Promise.all(pluginsJson.map(pluginJson => {
-    const folder = path.dirname(pluginJson);
-    return globAsync(`${folder}/module.{ts,tsx,js}`);
-  }));
+  const pluginsJson = await globAsync('**/src/**/plugin.json', { absolute: true });
+
+  const plugins = await Promise.all(pluginsJson.map((pluginJson) => {
+      const folder = path.dirname(pluginJson);
+      return globAsync(`${folder}/module.{ts,tsx,js}`, { absolute: true });
+    })
+  );
 
   return plugins.reduce((result, modules) => {
     return modules.reduce((result, module) => {
-      const pluginPath = path.resolve(path.dirname(module), parent);
+      const pluginPath = path.dirname(module);
       const pluginName = path.basename(pluginPath);
-      const entryName = plugins.length > 1 ? `${pluginName}/module` : 'module';
-  
-      result[entryName] = path.join(parent, module);
+      // support bundling nested plugins
+      const entryName = pluginName === 'src' ? 'module' : `${pluginName}/module`;
+
+      result[entryName] = module;
       return result;
     }, result);
   }, {});

package/templates/datasource/src/components/QueryEditor.tsx

@@ -1,10 +1,8 @@
-import defaults from 'lodash/defaults';
-
 import React, { ChangeEvent, PureComponent } from 'react';
 import { LegacyForms } from '@grafana/ui';
 import { QueryEditorProps } from '@grafana/data';
 import { DataSource } from '../datasource';
-import { defaultQuery, MyDataSourceOptions, MyQuery } from '../types';
+import { MyDataSourceOptions, MyQuery } from '../types';
 
 const { FormField } = LegacyForms;
 
@@ -24,8 +22,7 @@ export class QueryEditor extends PureComponent<Props> {
   };
 
   render() {
-    const query = defaults(this.props.query, defaultQuery);
-    const { queryText, constant } = query;
+    const { queryText, constant } = this.props.query;
 
     return (
       <div className="gf-form">

package/templates/datasource/src/datasource.ts

@@ -1,5 +1,3 @@
-import defaults from 'lodash/defaults';
-
 import {
   DataQueryRequest,
   DataQueryResponse,
@@ -9,7 +7,7 @@ import {
   FieldType,
 } from '@grafana/data';
 
-import { MyQuery, MyDataSourceOptions, defaultQuery } from './types';
+import { MyQuery, MyDataSourceOptions, DEFAULT_QUERY } from './types';
 
 export class DataSource extends DataSourceApi<MyQuery, MyDataSourceOptions> {
   constructor(instanceSettings: DataSourceInstanceSettings<MyDataSourceOptions>) {
@@ -23,12 +21,11 @@ export class DataSource extends DataSourceApi<MyQuery, MyDataSourceOptions> {
 
     // Return a constant for each query.
     const data = options.targets.map((target) => {
-      const query = defaults(target, defaultQuery);
       return new MutableDataFrame({
-        refId: query.refId,
+        refId: target.refId,
         fields: [
           { name: 'Time', values: [from, to], type: FieldType.time },
-          { name: 'Value', values: [query.constant, query.constant], type: FieldType.number },
+          { name: 'Value', values: [target.constant, target.constant], type: FieldType.number },
         ],
       });
     });

package/templates/datasource/src/types.ts

@@ -5,7 +5,7 @@ export interface MyQuery extends DataQuery {
   constant: number;
 }
 
-export const defaultQuery: Partial<MyQuery> = {
+export const DEFAULT_QUERY: Partial<MyQuery> = {
   constant: 6.5,
 };