@grafana/create-plugin 2.2.0-canary.455.9637001.0 → 2.2.0

package/CHANGELOG.md

@@ -1,3 +1,39 @@
+# v2.2.0 (Tue Oct 17 2023)
+
+#### 🚀 Enhancement
+
+- Create Plugin: Make sure scaffolded code is prettified [#461](https://github.com/grafana/plugin-tools/pull/461) ([@jackw](https://github.com/jackw))
+
+#### Authors: 1
+
+- Jack Westbrook ([@jackw](https://github.com/jackw))
+
+---
+
+# v2.1.2 (Mon Oct 16 2023)
+
+#### 🐛 Bug Fix
+
+- Create Plugin: Prevent conflicting webpack runtimes [#464](https://github.com/grafana/plugin-tools/pull/464) ([@jackw](https://github.com/jackw))
+
+#### Authors: 1
+
+- Jack Westbrook ([@jackw](https://github.com/jackw))
+
+---
+
+# v2.1.1 (Fri Oct 13 2023)
+
+#### 🐛 Bug Fix
+
+- Create Plugin: Format code under templates/common [#451](https://github.com/grafana/plugin-tools/pull/451) ([@zoltanbedi](https://github.com/zoltanbedi))
+
+#### Authors: 1
+
+- Zoltán Bedi ([@zoltanbedi](https://github.com/zoltanbedi))
+
+---
+
 # v2.1.0 (Fri Oct 13 2023)
 
 :tada: This release contains work from a new contributor! :tada:

package/dist/commands/generate-actions/prettify-files.js

@@ -0,0 +1,75 @@
+"use strict";
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __generator = (this && this.__generator) || function (thisArg, body) {
+    var _ = { label: 0, sent: function() { if (t[0] & 1) throw t[1]; return t[1]; }, trys: [], ops: [] }, f, y, t, g;
+    return g = { next: verb(0), "throw": verb(1), "return": verb(2) }, typeof Symbol === "function" && (g[Symbol.iterator] = function() { return this; }), g;
+    function verb(n) { return function (v) { return step([n, v]); }; }
+    function step(op) {
+        if (f) throw new TypeError("Generator is already executing.");
+        while (g && (g = 0, op[0] && (_ = 0)), _) try {
+            if (f = 1, y && (t = op[0] & 2 ? y["return"] : op[0] ? y["throw"] || ((t = y["return"]) && t.call(y), 0) : y.next) && !(t = t.call(y, op[1])).done) return t;
+            if (y = 0, t) op = [op[0] & 2, t.value];
+            switch (op[0]) {
+                case 0: case 1: t = op; break;
+                case 4: _.label++; return { value: op[1], done: false };
+                case 5: _.label++; y = op[1]; op = [0]; continue;
+                case 7: op = _.ops.pop(); _.trys.pop(); continue;
+                default:
+                    if (!(t = _.trys, t = t.length > 0 && t[t.length - 1]) && (op[0] === 6 || op[0] === 2)) { _ = 0; continue; }
+                    if (op[0] === 3 && (!t || (op[1] > t[0] && op[1] < t[3]))) { _.label = op[1]; break; }
+                    if (op[0] === 6 && _.label < t[1]) { _.label = t[1]; t = op; break; }
+                    if (t && _.label < t[2]) { _.label = t[2]; _.ops.push(op); break; }
+                    if (t[2]) _.ops.pop();
+                    _.trys.pop(); continue;
+            }
+            op = body.call(thisArg, _);
+        } catch (e) { op = [6, e]; y = 0; } finally { f = t = 0; }
+        if (op[0] & 5) throw op[1]; return { value: op[0] ? op[1] : void 0, done: true };
+    }
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.prettifyFiles = void 0;
+var node_child_process_1 = require("node:child_process");
+var node_util_1 = require("node:util");
+var fs_1 = __importDefault(require("fs"));
+var utils_path_1 = require("../../utils/utils.path");
+var exec = (0, node_util_1.promisify)(node_child_process_1.exec);
+function prettifyFiles(_a) {
+    var pluginName = _a.pluginName, orgName = _a.orgName, pluginType = _a.pluginType;
+    return __awaiter(this, void 0, void 0, function () {
+        var exportPath, command, error_1;
+        return __generator(this, function (_b) {
+            switch (_b.label) {
+                case 0:
+                    exportPath = (0, utils_path_1.getExportPath)(pluginName, orgName, pluginType);
+                    if (!fs_1.default.existsSync(exportPath)) {
+                        return [2, ''];
+                    }
+                    _b.label = 1;
+                case 1:
+                    _b.trys.push([1, 3, , 4]);
+                    command = 'npx -y prettier@2 . --write';
+                    return [4, exec(command, { cwd: exportPath })];
+                case 2:
+                    _b.sent();
+                    return [3, 4];
+                case 3:
+                    error_1 = _b.sent();
+                    throw new Error('There was a problem running prettier on the plugin files. Please run `npx -y prettier@2 . --write` manually in your plugin directory.');
+                case 4: return [2, 'Successfully ran prettier against new plugin.'];
+            }
+        });
+    });
+}
+exports.prettifyFiles = prettifyFiles;

package/dist/commands/generate.plopfile.js

@@ -32,10 +32,12 @@ var utils_path_1 = require("../utils/utils.path");
 var utils_packageManager_1 = require("../utils/utils.packageManager");
 var print_success_message_1 = require("./generate-actions/print-success-message");
 var update_go_sdk_and_packages_1 = require("./generate-actions/update-go-sdk-and-packages");
+var prettify_files_1 = require("./generate-actions/prettify-files");
 function default_1(plop) {
     plop.setHelper('if_eq', utils_handlebars_1.ifEq);
     plop.setHelper('normalize_id', utils_handlebars_1.normalizeId);
     plop.setActionType('printSuccessMessage', print_success_message_1.printGenerateSuccessMessage);
+    plop.setActionType('prettifyFiles', prettify_files_1.prettifyFiles);
     plop.setActionType('updateGoSdkAndModules', update_go_sdk_and_packages_1.updateGoSdkAndModules);
     plop.setGenerator('create-plugin', {
         description: 'used to scaffold a grafana plugin',
@@ -107,7 +109,7 @@ function default_1(plop) {
                 packageManagerInstallCmd: packageManagerInstallCmd,
                 packageManagerVersion: packageManagerVersion,
                 isAppType: isAppType,
-                isNPM: packageManagerName === 'npm'
+                isNPM: packageManagerName === 'npm',
             };
             var commonActions = getActionsForTemplateFolder({
                 folderPath: constants_1.TEMPLATE_PATHS.common,
@@ -150,6 +152,7 @@ function default_1(plop) {
                 {
                     type: 'updateGoSdkAndModules',
                 },
+                { type: 'prettifyFiles' },
                 {
                     type: 'printSuccessMessage',
                 },

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/create-plugin",
-  "version": "2.2.0-canary.455.9637001.0",
+  "version": "2.2.0",
   "main": "index.js",
   "repository": {
     "directory": "packages/create-plugin",
@@ -66,5 +66,5 @@
   "engines": {
     "node": ">=18"
   },
-  "gitHead": "9637001847838dfc4e26a67f84382309ff9c88f9"
+  "gitHead": "67123c677a1ecc23d0d83249b353bd2e467779e4"
 }

package/src/commands/generate-actions/prettify-files.ts

@@ -0,0 +1,25 @@
+import { exec as nodeExec } from 'node:child_process';
+import { promisify } from 'node:util';
+import fs from 'fs';
+import { getExportPath } from '../../utils/utils.path';
+import { CliArgs } from '../types';
+
+const exec = promisify(nodeExec);
+
+export async function prettifyFiles({ pluginName, orgName, pluginType }: CliArgs) {
+  const exportPath = getExportPath(pluginName, orgName, pluginType);
+
+  if (!fs.existsSync(exportPath)) {
+    return '';
+  }
+
+  try {
+    let command = 'npx -y prettier@2 . --write';
+    await exec(command, { cwd: exportPath });
+  } catch (error) {
+    throw new Error(
+      'There was a problem running prettier on the plugin files. Please run `npx -y prettier@2 . --write` manually in your plugin directory.'
+    );
+  }
+  return 'Successfully ran prettier against new plugin.';
+}

package/src/commands/generate.plopfile.ts

@@ -8,6 +8,7 @@ import { getExportPath } from '../utils/utils.path';
 import { getPackageManagerInstallCmd, getPackageManagerFromUserAgent } from '../utils/utils.packageManager';
 import { printGenerateSuccessMessage } from './generate-actions/print-success-message';
 import { updateGoSdkAndModules } from './generate-actions/update-go-sdk-and-packages';
+import { prettifyFiles } from './generate-actions/prettify-files';
 import { CliArgs, TemplateData } from './types';
 
 // Plopfile API documentation: https://plopjs.com/documentation/#plopfile-api
@@ -16,6 +17,7 @@ export default function (plop: NodePlopAPI) {
   plop.setHelper('normalize_id', normalizeId);
 
   plop.setActionType('printSuccessMessage', printGenerateSuccessMessage);
+  plop.setActionType('prettifyFiles', prettifyFiles);
   plop.setActionType('updateGoSdkAndModules', updateGoSdkAndModules);
 
   plop.setGenerator('create-plugin', {
@@ -95,7 +97,7 @@ export default function (plop: NodePlopAPI) {
         packageManagerInstallCmd,
         packageManagerVersion,
         isAppType,
-        isNPM: packageManagerName === 'npm'
+        isNPM: packageManagerName === 'npm',
       };
       // Copy over files that are shared between plugins types
       const commonActions = getActionsForTemplateFolder({
@@ -159,6 +161,7 @@ export default function (plop: NodePlopAPI) {
         {
           type: 'updateGoSdkAndModules',
         },
+        { type: 'prettifyFiles' },
         {
           type: 'printSuccessMessage',
         },

package/templates/common/.config/.eslintrc

@@ -4,7 +4,7 @@
  * In order to extend the configuration follow the steps in
  * https://grafana.com/developers/plugin-tools/create-a-plugin/extend-a-plugin/extend-configurations#extend-the-eslint-config
  */
- {
+{
   "extends": ["@grafana/eslint-config"],
   "root": true,
   "rules": {

package/templates/common/.config/.prettierrc.js

@@ -5,12 +5,12 @@
  */
 
 module.exports = {
-  "endOfLine": "auto",
-  "printWidth": 120,
-  "trailingComma": "es5",
-  "semi": true,
-  "jsxSingleQuote": false,
-  "singleQuote": true,
-  "useTabs": false,
-  "tabWidth": 2
-};
+  endOfLine: 'auto',
+  printWidth: 120,
+  trailingComma: 'es5',
+  semi: true,
+  jsxSingleQuote: false,
+  singleQuote: true,
+  useTabs: false,
+  tabWidth: 2,
+};

package/templates/common/.config/tsconfig.json

@@ -4,7 +4,7 @@
  * In order to extend the configuration follow the steps in
  * https://grafana.com/developers/plugin-tools/create-a-plugin/extend-a-plugin/extend-configurations#extend-the-typescript-config
  */
- {
+{
   "compilerOptions": {
     "alwaysStrict": true,
     "declaration": false,

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

@@ -2,11 +2,9 @@ import fs from 'fs';
 import process from 'process';
 import os from 'os';
 import path from 'path';
-import util from 'util';
 import { glob } from 'glob';
 import { SOURCE_DIR } from './constants';
 
-
 export function isWSL() {
   if (process.platform !== 'linux') {
     return false;
@@ -21,7 +19,7 @@ export function isWSL() {
   } catch {
     return false;
   }
-} 
+}
 
 export function getPackageJson() {
   return require(path.resolve(process.cwd(), 'package.json'));
@@ -40,7 +38,8 @@ export function hasReadme() {
 export async function getEntries(): Promise<Record<string, string>> {
   const pluginsJson = await glob('**/src/**/plugin.json', { absolute: true });
 
-  const plugins = await Promise.all(pluginsJson.map((pluginJson) => {
+  const plugins = await Promise.all(
+    pluginsJson.map((pluginJson) => {
       const folder = path.dirname(pluginJson);
       return glob(`${folder}/module.{ts,tsx,js,jsx}`, { absolute: true });
     })

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

@@ -97,7 +97,7 @@ const config = async (env): Promise<Configuration> => {
         },
         {
           test: /\.css$/,
-          use: ["style-loader", "css-loader"]
+          use: ['style-loader', 'css-loader'],
         },
         {
           test: /\.s[ac]ss$/,
@@ -136,6 +136,7 @@ const config = async (env): Promise<Configuration> => {
       },
       path: path.resolve(process.cwd(), DIST_DIR),
       publicPath: `public/plugins/${pluginJson.id}/`,
+      uniqueName: pluginJson.id,
     },
 
     plugins: [
@@ -207,7 +208,6 @@ const config = async (env): Promise<Configuration> => {
   }
 
   return baseConfig;
-
 };
 
 export default config;

package/templates/common/.eslintrc

@@ -1,3 +1,3 @@
 {
   "extends": "./.config/.eslintrc"
-}
+}

package/templates/common/.nvmrc

@@ -1 +1 @@
-16
+18

package/templates/common/.prettierrc.js

@@ -1,4 +1,4 @@
 module.exports = {
   // Prettier configuration provided by Grafana scaffolding
-  ...require("./.config/.prettierrc.js")
-};
+  ...require('./.config/.prettierrc.js'),
+};

package/templates/common/CHANGELOG.md

@@ -2,4 +2,4 @@
 
 ## 1.0.0 (Unreleased)
 
-Initial release.
+Initial release.

package/templates/common/package.json

@@ -27,7 +27,7 @@
     "@swc/helpers": "^0.5.0",
     "@swc/jest": "^0.2.26",
     "@testing-library/jest-dom": "^5.16.5",
-    "@testing-library/react": "14.0.0",
+    "@testing-library/react": "^12.1.4",
     "@types/jest": "^29.5.0",
     "@types/lodash": "^4.14.194",
     "@types/node": "^18.15.11",{{#if isAppType}}
@@ -57,15 +57,15 @@
     "node": ">=18"
   },
   "dependencies": {
-    "@emotion/css": "11.10.6",
+    "@emotion/css": "^11.1.3",
     "@grafana/data": "{{ grafanaVersion }}",
     "@grafana/runtime": "{{ grafanaVersion }}",
     "@grafana/ui": "{{ grafanaVersion }}",{{#if_eq pluginType "scenesapp"}}
     "@grafana/schema": "{{ grafanaVersion }}",
     "@grafana/scenes": "0.27.0",{{/if_eq}}
-    "react": "18.2.0",
-    "react-dom": "18.2.0",{{#if isAppType}}
-    "react-router-dom": "5.3.3",
+    "react": "17.0.2",
+    "react-dom": "17.0.2",{{#if isAppType}}
+    "react-router-dom": "^5.2.0",
     "rxjs": "7.8.0",{{/if}}
     "tslib": "2.5.3"
   },

package/templates/common/tsconfig.json

@@ -1,3 +1,3 @@
 {
   "extends": "./.config/tsconfig.json"
-}
+}