@grafana/create-plugin 0.8.2 → 0.8.4

package/CHANGELOG.md

@@ -1,3 +1,28 @@
+# v0.8.4 (Fri Jan 13 2023)
+
+#### 🐛 Bug Fix
+
+- Create Plugin: Make sure nested plugins dist directory structure is correct [#182](https://github.com/grafana/plugin-tools/pull/182) ([@jackw](https://github.com/jackw))
+
+#### Authors: 1
+
+- Jack Westbrook ([@jackw](https://github.com/jackw))
+
+---
+
+# v0.8.3 (Thu Jan 12 2023)
+
+#### 🐛 Bug Fix
+
+- Create Plugin: Update yarn scripts and instructions to work post scaffold [#168](https://github.com/grafana/plugin-tools/pull/168) ([@sarahzinger](https://github.com/sarahzinger) [@jackw](https://github.com/jackw))
+
+#### Authors: 2
+
+- Jack Westbrook ([@jackw](https://github.com/jackw))
+- Sarah Zinger ([@sarahzinger](https://github.com/sarahzinger))
+
+---
+
 # v0.8.2 (Wed Jan 11 2023)
 
 :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 kind of plugin would you like? '
+                message: 'What type of plugin would you like?'
             },
             {
                 name: 'hasBackend',
@@ -200,6 +200,6 @@ function printSuccessMessage(answers) {
         '- `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 ./").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.2",
+  "version": "0.8.4",
   "main": "index.js",
   "repository": {
     "directory": "packages/create-plugin",
@@ -60,5 +60,5 @@
   "engines": {
     "node": ">=16"
   },
-  "gitHead": "4bdbc3b4f52e243ec28419cfb8a263b7c6b5dffb"
+  "gitHead": "648d226cd34cecfaf840b26afe86166d29b9bf57"
 }

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',
@@ -272,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 ./${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/_partials/frontend-getting-started.md

@@ -6,14 +6,10 @@
    yarn install
    ```
 
-2. Build plugin in development mode or run in watch mode
+2. Build plugin in development mode and run in watch mode
 
    ```bash
    yarn dev
-
-   # or
-
-   yarn watch
    ```
 
 3. Build plugin in production mode
@@ -25,11 +21,11 @@
 4. Run the tests (using Jest)
 
    ```bash
-   # Runs the tests and watches for changes
+   # Runs the tests and watches for changes, requires git init first
    yarn test
    
    # Exists after running all the tests
-   yarn lint:ci
+   yarn test:ci
    ```
 
 5. Spin up a Grafana instance and run the plugin inside it (using Docker)

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/common/package.json

@@ -6,7 +6,7 @@
     "build": "webpack -c ./.config/webpack/webpack.config.ts --env production",
     "dev": "webpack -w -c ./.config/webpack/webpack.config.ts --env development",
     "test": "jest --watch --onlyChanged",
-    "test:ci": "jest --maxWorkers 4",
+    "test:ci": "jest --passWithNoTests --maxWorkers 4",
     "typecheck": "tsc --noEmit",
     "lint": "eslint --cache --ignore-path ./.gitignore --ext .js,.jsx,.ts,.tsx .",
     "lint:fix": "yarn lint --fix",