@grafana/create-plugin 0.8.2-canary.182.e5280e4.0 → 0.8.2

package/CHANGELOG.md

@@ -1,3 +1,19 @@
+# v0.8.2 (Wed Jan 11 2023)
+
+:tada: This release contains work from a new contributor! :tada:
+
+Thank you, Sarah Zinger ([@sarahzinger](https://github.com/sarahzinger)), for all your work!
+
+#### 🐛 Bug Fix
+
+- Create Plugin: Update docs to build backend before running docker [#167](https://github.com/grafana/plugin-tools/pull/167) ([@sarahzinger](https://github.com/sarahzinger))
+
+#### Authors: 1
+
+- Sarah Zinger ([@sarahzinger](https://github.com/sarahzinger))
+
+---
+
 # v0.8.1 (Tue Dec 13 2022)
 
 :tada: This release contains work from a new contributor! :tada:

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 type of plugin would you like?'
+                message: 'What kind of plugin would you like? '
             },
             {
                 name: 'hasBackend',
@@ -191,11 +191,15 @@ function printSuccessMessage(answers) {
     var commands = __spreadArray(__spreadArray([
         "- `cd ./".concat(directory, "`"),
         '- `yarn install` to install frontend dependencies.',
-        '- `docker-compose up` to start a grafana development server.',
         '- `yarn dev` to build (and watch) the plugin frontend code.'
-    ], (answers.hasBackend ? ['- `mage -v build:linux` to build the plugin backend code.'] : []), true), [
+    ], (answers.hasBackend
+        ? [
+            '- `mage -v build:linux` to build the plugin backend code. Rerun this command every time you edit your backend files.',
+        ]
+        : []), true), [
+        '- `docker-compose up` to start a grafana development server. 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.',
     ], 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 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");
+    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");
     return (0, utils_console_1.displayAsMarkdown)(msg);
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/create-plugin",
-  "version": "0.8.2-canary.182.e5280e4.0",
+  "version": "0.8.2",
   "main": "index.js",
   "repository": {
     "directory": "packages/create-plugin",
@@ -60,5 +60,5 @@
   "engines": {
     "node": ">=16"
   },
-  "gitHead": "e5280e4497637813ad0aab2687a8438452578133"
+  "gitHead": "4bdbc3b4f52e243ec28419cfb8a263b7c6b5dffb"
 }

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 type of plugin would you like?',
+        message: 'What kind of plugin would you like? ',
       },
       {
         name: 'hasBackend',
@@ -252,9 +252,13 @@ function printSuccessMessage(answers: CliArgs) {
   const commands = [
     `- \`cd ./${directory}\``,
     '- `yarn install` to install frontend dependencies.',
-    '- `docker-compose up` to start a grafana development server.',
     '- `yarn dev` to build (and watch) the plugin frontend code.',
-    ...(answers.hasBackend ? ['- `mage -v build:linux` to build the plugin backend code.'] : []),
+    ...(answers.hasBackend
+      ? [
+          '- `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.',
     '- Open http://localhost:3000 in your browser to create a dashboard to begin developing your plugin.',
   ];
 
@@ -268,7 +272,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 create-plugin documentation at https://grafana.github.io/plugin-tools/
+- View ./${directory}/README.md
 - Learn more about Grafana Plugins at https://grafana.com/docs/grafana/latest/plugins/developing/development/
 `;
 

package/templates/app/README.md

@@ -8,8 +8,8 @@ App plugins can let you create a custom out-of-the-box monitoring experience by
 
 ## Getting started
 
--- INSERT FRONTEND GETTING STARTED --
 {{#if hasBackend}}-- INSERT BACKEND GETTING STARTED --{{/if}}
+-- INSERT FRONTEND GETTING STARTED --
 
 -- INSERT DISTRIBUTING YOUR PLUGIN --
 

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

@@ -21,22 +21,21 @@ export function hasReadme() {
 }
 
 export async function getEntries(): Promise<Record<string, string>> {
-  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 });
-    })
-  );
+  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}`);
+  }));
 
   return plugins.reduce((result, modules) => {
     return modules.reduce((result, module) => {
-      const pluginPath = path.dirname(module);
+      const pluginPath = path.resolve(path.dirname(module), parent);
       const pluginName = path.basename(pluginPath);
-      // support bundling nested plugins
-      const entryName = pluginName === 'src' ? 'module' : `${pluginName}/module`;
-
-      result[entryName] = module;
+      const entryName = plugins.length > 1 ? `${pluginName}/module` : 'module';
+  
+      result[entryName] = path.join(parent, module);
       return result;
     }, result);
   }, {});

package/templates/datasource/README.md

@@ -8,8 +8,8 @@ Grafana supports a wide range of data sources, including Prometheus, MySQL, and
 
 ## Getting started
 
--- INSERT FRONTEND GETTING STARTED --
 {{#if hasBackend}}-- INSERT BACKEND GETTING STARTED --{{/if}}
+-- INSERT FRONTEND GETTING STARTED --
 
 -- INSERT DISTRIBUTING YOUR PLUGIN --
 

package/templates/panel/README.md

@@ -11,7 +11,6 @@ Use panel plugins when you want to do things like visualize data returned by dat
 ## Getting started
 
 -- INSERT FRONTEND GETTING STARTED --
-{{#if hasBackend}}-- INSERT BACKEND GETTING STARTED --{{/if}}
 
 -- INSERT DISTRIBUTING YOUR PLUGIN --