@grafana/create-plugin 1.3.0-canary.226.fa1f5e2.0 → 1.3.0

package/CHANGELOG.md

@@ -1,3 +1,25 @@
+# v1.3.0 (Fri Apr 28 2023)
+
+#### 🚀 Enhancement
+
+- Create Plugin: Support different Node package managers [#226](https://github.com/grafana/plugin-tools/pull/226) ([@jackw](https://github.com/jackw))
+
+#### 🐛 Bug Fix
+
+- Documentation: Fix path in for template README.md for jest customizations [#218](https://github.com/grafana/plugin-tools/pull/218) ([@briangann](https://github.com/briangann))
+
+#### 🔩 Dependency Updates
+
+- Chore: Update `glob` to v10 [#230](https://github.com/grafana/plugin-tools/pull/230) ([@leventebalogh](https://github.com/leventebalogh))
+
+#### Authors: 3
+
+- Brian Gann ([@briangann](https://github.com/briangann))
+- Jack Westbrook ([@jackw](https://github.com/jackw))
+- Levente Balogh ([@leventebalogh](https://github.com/leventebalogh))
+
+---
+
 # v1.2.1 (Thu Mar 30 2023)
 
 #### 🐛 Bug Fix

package/dist/commands/generate.plopfile.js

@@ -100,15 +100,16 @@ function default_1(plop) {
             var pluginId = (0, utils_handlebars_1.normalizeId)(pluginName, orgName, pluginType);
             var _b = (0, utils_packageManager_1.getPackageManagerFromUserAgent)(), packageManagerName = _b.packageManagerName, packageManagerVersion = _b.packageManagerVersion;
             var packageManagerInstallCmd = (0, utils_packageManager_1.getPackageManagerInstallCmd)(packageManagerName);
+            var templateData = {
+                pluginId: pluginId,
+                packageManagerName: packageManagerName,
+                packageManagerInstallCmd: packageManagerInstallCmd,
+                packageManagerVersion: packageManagerVersion
+            };
             var commonActions = getActionsForTemplateFolder({
                 folderPath: constants_1.TEMPLATE_PATHS.common,
                 exportPath: exportPath,
-                templateData: {
-                    pluginId: pluginId,
-                    packageManagerName: packageManagerName,
-                    packageManagerInstallCmd: packageManagerInstallCmd,
-                    packageManagerVersion: packageManagerVersion
-                }
+                templateData: templateData
             });
             var pluginTypeSpecificActions = getActionsForTemplateFolder({
                 folderPath: constants_1.TEMPLATE_PATHS[pluginType],
@@ -130,25 +131,17 @@ function default_1(plop) {
                 ? getActionsForTemplateFolder({
                     folderPath: constants_1.TEMPLATE_PATHS.ciWorkflows,
                     exportPath: exportPath,
-                    templateData: {
-                        packageManagerName: packageManagerName,
-                        packageManagerInstallCmd: packageManagerInstallCmd,
-                        packageManagerVersion: packageManagerVersion
-                    }
+                    templateData: templateData
                 })
                 : [];
             var isCompatibleWorkflowActions = hasGithubLevitateWorkflow
                 ? getActionsForTemplateFolder({
                     folderPath: constants_1.TEMPLATE_PATHS.isCompatibleWorkflow,
                     exportPath: exportPath,
-                    templateData: {
-                        packageManagerName: packageManagerName,
-                        packageManagerInstallCmd: packageManagerInstallCmd,
-                        packageManagerVersion: packageManagerVersion
-                    }
+                    templateData: templateData
                 })
                 : [];
-            var readmeActions = getActionsForReadme({ exportPath: exportPath });
+            var readmeActions = getActionsForReadme({ exportPath: exportPath, templateData: templateData });
             return __spreadArray(__spreadArray(__spreadArray(__spreadArray(__spreadArray([], pluginActions, true), ciWorkflowActions, true), readmeActions, true), isCompatibleWorkflowActions, true), [
                 {
                     type: 'updateGoSdkAndModules'
@@ -162,26 +155,30 @@ function default_1(plop) {
 }
 exports["default"] = default_1;
 function getActionsForReadme(_a) {
-    var exportPath = _a.exportPath;
+    var exportPath = _a.exportPath, templateData = _a.templateData;
     return [
-        replacePatternWithTemplateInReadme('-- INSERT FRONTEND GETTING STARTED --', 'frontend-getting-started.md', exportPath),
-        replacePatternWithTemplateInReadme('-- INSERT BACKEND GETTING STARTED --', 'backend-getting-started.md', exportPath),
-        replacePatternWithTemplateInReadme('-- INSERT DISTRIBUTING YOUR PLUGIN --', 'distributing-your-plugin.md', exportPath),
+        replacePatternWithTemplateInReadme('-- INSERT FRONTEND GETTING STARTED --', 'frontend-getting-started.md', exportPath, templateData),
+        replacePatternWithTemplateInReadme('-- INSERT BACKEND GETTING STARTED --', 'backend-getting-started.md', exportPath, templateData),
+        replacePatternWithTemplateInReadme('-- INSERT DISTRIBUTING YOUR PLUGIN --', 'distributing-your-plugin.md', exportPath, templateData),
     ];
 }
-function replacePatternWithTemplateInReadme(pattern, partialsFile, exportPath) {
+function replacePatternWithTemplateInReadme(pattern, partialsFile, exportPath, templateData) {
+    if (templateData === void 0) { templateData = {}; }
     return {
         type: 'modify',
         path: path_1["default"].join(exportPath, 'README.md'),
         pattern: pattern,
         template: undefined,
         templateFile: path_1["default"].join(constants_1.PARTIALS_DIR, partialsFile),
-        data: constants_1.EXTRA_TEMPLATE_VARIABLES
+        data: __assign(__assign({}, constants_1.EXTRA_TEMPLATE_VARIABLES), templateData)
     };
 }
 function getActionsForTemplateFolder(_a) {
     var folderPath = _a.folderPath, exportPath = _a.exportPath, _b = _a.templateData, templateData = _b === void 0 ? {} : _b;
     var files = glob_1["default"].sync("".concat(folderPath, "/**"), { dot: true });
+    if (templateData.packageManagerName !== 'pnpm') {
+        files = files.filter(function (file) { return path_1["default"].basename(file) !== 'npmrc'; });
+    }
     function getExportFileName(f) {
         if (path_1["default"].basename(f) === 'gitignore') {
             return '.gitignore';
@@ -194,11 +191,6 @@ function getActionsForTemplateFolder(_a) {
     function getExportPath(f) {
         return path_1["default"].relative(folderPath, path_1["default"].dirname(f));
     }
-    if (templateData.packageManagerName !== 'pnpm') {
-        files = files.filter(function (file) {
-            return path_1["default"].basename(file) !== 'npmrc';
-        });
-    }
     return files.filter(isFile).map(function (f) { return ({
         type: 'add',
         templateFile: f,

package/dist/commands/migrate.command.js

@@ -122,7 +122,7 @@ var migrate = function () { return __awaiter(void 0, void 0, void 0, function ()
                     (0, utils_console_1.printMessage)(constants_1.TEXT.updateNpmScriptsAborted);
                 }
                 packageManager = (0, utils_packageManager_1.getPackageManagerWithFallback)();
-                (0, utils_npm_1.writePackageManager)(packageManager);
+                (0, utils_npm_1.writePackageManagerInPackageJson)(packageManager);
                 (0, utils_npm_1.cleanUpPackageJson)();
                 (0, utils_console_1.printSuccessMessage)(constants_1.TEXT.migrationCommandSuccess);
                 return [3, 12];

package/dist/commands/update.command.js

@@ -95,7 +95,7 @@ var update = function () { return __awaiter(void 0, void 0, void 0, function ()
                     (0, utils_console_1.printMessage)(constants_1.TEXT.updateNpmScriptsAborted);
                 }
                 packageManager = (0, utils_packageManager_1.getPackageManagerWithFallback)();
-                (0, utils_npm_1.writePackageManager)(packageManager);
+                (0, utils_npm_1.writePackageManagerInPackageJson)(packageManager);
                 (0, utils_console_1.printSuccessMessage)(constants_1.TEXT.updateCommandSuccess);
                 return [3, 6];
             case 5:

package/dist/utils/utils.npm.js

@@ -14,7 +14,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 exports.__esModule = true;
-exports.cleanUpPackageJson = exports.writePackageManager = exports.updateNpmScripts = exports.removeNpmDependencies = exports.getRemovableNpmDependencies = exports.getUpdatableNpmDependencies = exports.getPackageJsonUpdates = exports.updateNpmDependencies = exports.updatePackageJson = exports.hasNpmDependenciesToUpdate = exports.getPackageJsonUpdatesAsText = exports.getNpmDependencyUpdatesAsText = exports.writePackageJson = exports.getLatestPackageJson = exports.getPackageJson = void 0;
+exports.cleanUpPackageJson = exports.writePackageManagerInPackageJson = exports.updateNpmScripts = exports.removeNpmDependencies = exports.getRemovableNpmDependencies = exports.getUpdatableNpmDependencies = exports.getPackageJsonUpdates = exports.updateNpmDependencies = exports.updatePackageJson = exports.hasNpmDependenciesToUpdate = exports.getPackageJsonUpdatesAsText = exports.getNpmDependencyUpdatesAsText = exports.writePackageJson = exports.getLatestPackageJson = exports.getPackageJson = void 0;
 var path_1 = __importDefault(require("path"));
 var fs_1 = __importDefault(require("fs"));
 var semver_1 = __importDefault(require("semver"));
@@ -204,7 +204,7 @@ function updateNpmScripts() {
     writePackageJson(packageJson);
 }
 exports.updateNpmScripts = updateNpmScripts;
-function writePackageManager(_a) {
+function writePackageManagerInPackageJson(_a) {
     var packageManagerName = _a.packageManagerName, packageManagerVersion = _a.packageManagerVersion;
     var packageJson = getPackageJson();
     if (!packageJson.packageManager) {
@@ -212,7 +212,7 @@ function writePackageManager(_a) {
         writePackageJson(packageJson);
     }
 }
-exports.writePackageManager = writePackageManager;
+exports.writePackageManagerInPackageJson = writePackageManagerInPackageJson;
 function cleanUpPackageJson() {
     var packageJson = getPackageJson();
     packageJson.scripts = sortKeysAlphabetically(packageJson.scripts);

package/dist/utils/utils.packageManager.js

@@ -9,7 +9,7 @@ var NPM_LOCKFILE = 'package-lock.json';
 var PNPM_LOCKFILE = 'pnpm-lock.yaml';
 var YARN_LOCKFILE = 'yarn.lock';
 var SUPPORTED_PACKAGE_MANAGERS = ['npm', 'yarn', 'pnpm'];
-var LEGACY_PACKAGE_MANAGER = { packageManagerName: 'yarn', packageManagerVersion: '1.22.19' };
+var DEFAULT_PACKAGE_MANAGER = { packageManagerName: 'yarn', packageManagerVersion: '1.22.19' };
 function getPackageManagerFromUserAgent() {
     var agent = process.env.npm_config_user_agent;
     var _a = agent.split('/'), name = _a[0], versionWithText = _a[1];
@@ -17,7 +17,7 @@ function getPackageManagerFromUserAgent() {
     if (SUPPORTED_PACKAGE_MANAGERS.includes(name)) {
         return { packageManagerName: name, packageManagerVersion: version.trimEnd() };
     }
-    return LEGACY_PACKAGE_MANAGER;
+    return DEFAULT_PACKAGE_MANAGER;
 }
 exports.getPackageManagerFromUserAgent = getPackageManagerFromUserAgent;
 function getPackageManagerWithFallback() {
@@ -29,7 +29,7 @@ function getPackageManagerWithFallback() {
     if (packageManagerFromLockFile) {
         return packageManagerFromLockFile;
     }
-    return LEGACY_PACKAGE_MANAGER;
+    return DEFAULT_PACKAGE_MANAGER;
 }
 exports.getPackageManagerWithFallback = getPackageManagerWithFallback;
 function getPackageManagerInstallCmd(packageManagerName) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/create-plugin",
-  "version": "1.3.0-canary.226.fa1f5e2.0",
+  "version": "1.3.0",
   "main": "index.js",
   "repository": {
     "directory": "packages/create-plugin",
@@ -64,5 +64,5 @@
   "engines": {
     "node": ">=16"
   },
-  "gitHead": "fa1f5e2468477e1cacc5f7028079090d5875aeca"
+  "gitHead": "75bcdffdcffa1302a0ef270e149c58c4f921a7a7"
 }

package/src/commands/generate.plopfile.ts

@@ -88,17 +88,17 @@ export default function (plop: NodePlopAPI) {
       // Support the users package manager of choice.
       const { packageManagerName, packageManagerVersion } = getPackageManagerFromUserAgent();
       const packageManagerInstallCmd = getPackageManagerInstallCmd(packageManagerName);
-
+      const templateData = {
+        pluginId,
+        packageManagerName,
+        packageManagerInstallCmd,
+        packageManagerVersion,
+      };
       // Copy over files that are shared between plugins types
       const commonActions = getActionsForTemplateFolder({
         folderPath: TEMPLATE_PATHS.common,
         exportPath,
-        templateData: {
-          pluginId,
-          packageManagerName,
-          packageManagerInstallCmd,
-          packageManagerVersion,
-        },
+        templateData,
       });
 
       // Copy over files from the plugin type specific folder, e.g. "templates/app" for "app" plugins ("app" | "panel" | "datasource").
@@ -132,11 +132,7 @@ export default function (plop: NodePlopAPI) {
         ? getActionsForTemplateFolder({
             folderPath: TEMPLATE_PATHS.ciWorkflows,
             exportPath,
-            templateData: {
-              packageManagerName,
-              packageManagerInstallCmd,
-              packageManagerVersion,
-            },
+            templateData,
           })
         : [];
 
@@ -144,16 +140,12 @@ export default function (plop: NodePlopAPI) {
         ? getActionsForTemplateFolder({
             folderPath: TEMPLATE_PATHS.isCompatibleWorkflow,
             exportPath,
-            templateData: {
-              packageManagerName,
-              packageManagerInstallCmd,
-              packageManagerVersion,
-            },
+            templateData,
           })
         : [];
 
       // Replace conditional bits in the Readme files
-      const readmeActions = getActionsForReadme({ exportPath });
+      const readmeActions = getActionsForReadme({ exportPath, templateData });
 
       return [
         ...pluginActions,
@@ -171,22 +163,31 @@ export default function (plop: NodePlopAPI) {
   });
 }
 
-function getActionsForReadme({ exportPath }: { exportPath: string }): ModifyActionConfig[] {
+function getActionsForReadme({
+  exportPath,
+  templateData,
+}: {
+  exportPath: string;
+  templateData: Record<string, string>;
+}): ModifyActionConfig[] {
   return [
     replacePatternWithTemplateInReadme(
       '-- INSERT FRONTEND GETTING STARTED --',
       'frontend-getting-started.md',
-      exportPath
+      exportPath,
+      templateData
     ),
     replacePatternWithTemplateInReadme(
       '-- INSERT BACKEND GETTING STARTED --',
       'backend-getting-started.md',
-      exportPath
+      exportPath,
+      templateData
     ),
     replacePatternWithTemplateInReadme(
       '-- INSERT DISTRIBUTING YOUR PLUGIN --',
       'distributing-your-plugin.md',
-      exportPath
+      exportPath,
+      templateData
     ),
   ];
 }
@@ -194,7 +195,8 @@ function getActionsForReadme({ exportPath }: { exportPath: string }): ModifyActi
 function replacePatternWithTemplateInReadme(
   pattern: string,
   partialsFile: string,
-  exportPath: string
+  exportPath: string,
+  templateData: Record<string, string> = {}
 ): ModifyActionConfig {
   return {
     type: 'modify',
@@ -203,7 +205,10 @@ function replacePatternWithTemplateInReadme(
     // @ts-ignore
     template: undefined,
     templateFile: path.join(PARTIALS_DIR, partialsFile),
-    data: EXTRA_TEMPLATE_VARIABLES,
+    data: {
+      ...EXTRA_TEMPLATE_VARIABLES,
+      ...templateData,
+    },
   };
 }
 
@@ -218,6 +223,12 @@ function getActionsForTemplateFolder({
   templateData?: Record<string, string>;
 }) {
   let files = glob.sync(`${folderPath}/**`, { dot: true });
+
+  // The npmrc file is only useful for `pnpm` settings. We can remove it for other package managers.
+  if (templateData.packageManagerName !== 'pnpm') {
+    files = files.filter((file) => path.basename(file) !== 'npmrc');
+  }
+
   function getExportFileName(f: string) {
     // yarn and npm packing will not include `.gitignore` files
     // so we have to manually rename them to add the dot prefix
@@ -230,17 +241,11 @@ function getActionsForTemplateFolder({
 
     return path.extname(f) === '.hbs' ? path.basename(f, '.hbs') : path.basename(f);
   }
+
   function getExportPath(f: string) {
     return path.relative(folderPath, path.dirname(f));
   }
 
-  // Remove the npmrc file if not running `pnpm`.
-  if (templateData.packageManagerName !== 'pnpm') {
-    files = files.filter((file) => {
-      return path.basename(file) !== 'npmrc';
-    });
-  }
-
   return files.filter(isFile).map((f) => ({
     type: 'add',
     templateFile: f,

package/src/commands/migrate.command.ts

@@ -10,7 +10,7 @@ import {
   removeNpmDependencies,
   updateNpmScripts,
   cleanUpPackageJson,
-  writePackageManager,
+  writePackageManagerInPackageJson,
 } from '../utils/utils.npm';
 import { getPackageManagerWithFallback } from '../utils/utils.packageManager';
 
@@ -99,7 +99,7 @@ export const migrate = async () => {
 
     // Guarantee that the package manager property is set in the package.json file if it is missing
     const packageManager = getPackageManagerWithFallback();
-    writePackageManager(packageManager);
+    writePackageManagerInPackageJson(packageManager);
 
     // Tidy package.json file so any changed fields are sorted as a
     // package manager would expect.

package/src/commands/update.command.ts

@@ -6,7 +6,7 @@ import {
   hasNpmDependenciesToUpdate,
   getPackageJsonUpdatesAsText,
   updateNpmScripts,
-  writePackageManager,
+  writePackageManagerInPackageJson,
 } from '../utils/utils.npm';
 import { getPackageManagerWithFallback } from '../utils/utils.packageManager';
 
@@ -69,7 +69,7 @@ export const update = async () => {
 
     // Guarantee that the package manager property is set in the package.json file if it is missing
     const packageManager = getPackageManagerWithFallback();
-    writePackageManager(packageManager);
+    writePackageManagerInPackageJson(packageManager);
 
     // 4. Summary
     // -------------

package/src/utils/utils.npm.ts

@@ -238,7 +238,7 @@ export function updateNpmScripts() {
   writePackageJson(packageJson);
 }
 
-export function writePackageManager({ packageManagerName, packageManagerVersion }: PackageManager) {
+export function writePackageManagerInPackageJson({ packageManagerName, packageManagerVersion }: PackageManager) {
   const packageJson = getPackageJson();
   if (!packageJson.packageManager) {
     packageJson.packageManager = `${packageManagerName}@${packageManagerVersion}`;

package/src/utils/utils.packageManager.ts

@@ -7,7 +7,7 @@ const NPM_LOCKFILE = 'package-lock.json';
 const PNPM_LOCKFILE = 'pnpm-lock.yaml';
 const YARN_LOCKFILE = 'yarn.lock';
 const SUPPORTED_PACKAGE_MANAGERS = ['npm', 'yarn', 'pnpm'];
-const LEGACY_PACKAGE_MANAGER = { packageManagerName: 'yarn', packageManagerVersion: '1.22.19' };
+const DEFAULT_PACKAGE_MANAGER = { packageManagerName: 'yarn', packageManagerVersion: '1.22.19' };
 
 export type PackageManager = {
   packageManagerName: string;
@@ -24,7 +24,7 @@ export function getPackageManagerFromUserAgent(): PackageManager {
     return { packageManagerName: name, packageManagerVersion: version.trimEnd() };
   }
 
-  return LEGACY_PACKAGE_MANAGER;
+  return DEFAULT_PACKAGE_MANAGER;
 }
 
 export function getPackageManagerWithFallback() {
@@ -38,7 +38,7 @@ export function getPackageManagerWithFallback() {
     return packageManagerFromLockFile;
   }
 
-  return LEGACY_PACKAGE_MANAGER;
+  return DEFAULT_PACKAGE_MANAGER;
 }
 
 export function getPackageManagerInstallCmd(packageManagerName: string) {

package/templates/_partials/frontend-getting-started.md

@@ -3,53 +3,53 @@
 1. Install dependencies
 
    ```bash
-   yarn install
+   {{ packageManagerName }} run install
    ```
 
 2. Build plugin in development mode and run in watch mode
 
    ```bash
-   yarn dev
+   {{ packageManagerName }} run dev
    ```
 
 3. Build plugin in production mode
 
    ```bash
-   yarn build
+   {{ packageManagerName }} run build
    ```
 
 4. Run the tests (using Jest)
 
    ```bash
    # Runs the tests and watches for changes, requires git init first
-   yarn test
-   
+   {{ packageManagerName }} run test
+
    # Exits after running all the tests
-   yarn test:ci
+   {{ packageManagerName }} run test:ci
    ```
 
 5. Spin up a Grafana instance and run the plugin inside it (using Docker)
 
    ```bash
-   yarn server
+   {{ packageManagerName }} run server
    ```
 
 6. Run the E2E tests (using Cypress)
 
    ```bash
-   # Spins up a Grafana instance first that we tests against 
-   yarn server
-   
+   # Spins up a Grafana instance first that we tests against
+   {{ packageManagerName }} run server
+
    # Starts the tests
-   yarn e2e
+   {{ packageManagerName }} run e2e
    ```
 
 7. Run the linter
 
    ```bash
-   yarn lint
-   
+   {{ packageManagerName }} run lint
+
    # or
 
-   yarn lint:fix
+   {{ packageManagerName }} run lint:fix
    ```

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

@@ -1,11 +1,9 @@
 import fs from 'fs';
 import path from 'path';
 import util from 'util';
-import glob from 'glob';
+import { glob } from 'glob';
 import { SOURCE_DIR } from './constants';
 
-const globAsync = util.promisify(glob);
-
 export function getPackageJson() {
   return require(path.resolve(process.cwd(), 'package.json'));
 }
@@ -21,11 +19,11 @@ export function hasReadme() {
 // Support bundling nested plugins by finding all plugin.json files in src directory
 // then checking for a sibling module.[jt]sx? file.
 export async function getEntries(): Promise<Record<string, string>> {
-  const pluginsJson = await globAsync('**/src/**/plugin.json', { absolute: true });
+  const pluginsJson = await glob('**/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,jsx}`, { absolute: true });
+      return glob(`${folder}/module.{ts,tsx,js,jsx}`, { absolute: true });
     })
   );
 

package/templates/common/package.json

@@ -28,7 +28,6 @@
     "@swc/jest": "^0.2.23",
     "@testing-library/jest-dom": "^5.16.2",
     "@testing-library/react": "^12.1.4",
-    "@types/glob": "^8.0.0",
     "@types/jest": "^29.2.2",
     "@types/lodash": "^4.14.188",
     "@types/node": "^18.11.9",
@@ -39,7 +38,7 @@
     "css-loader": "^6.7.1",
     "eslint-webpack-plugin": "^3.1.1",
     "fork-ts-checker-webpack-plugin": "^7.2.0",
-    "glob": "^8.0.3",
+    "glob": "^10.0.0",
     "identity-obj-proxy": "3.0.0",
     "jest": "^29.3.1",
     "jest-environment-jsdom": "^29.3.1",