@grafana/create-plugin 1.2.0 → 1.3.0-canary.226.129a5b7.0

package/dist/commands/generate-actions/print-success-message.js

@@ -12,12 +12,14 @@ exports.__esModule = true;
 exports.printGenerateSuccessMessage = void 0;
 var utils_console_1 = require("../../utils/utils.console");
 var utils_handlebars_1 = require("../../utils/utils.handlebars");
+var utils_npm_1 = require("../../utils/utils.npm");
 function printGenerateSuccessMessage(answers) {
     var directory = (0, utils_handlebars_1.normalizeId)(answers.pluginName, answers.orgName, answers.pluginType);
+    var packageManager = (0, utils_npm_1.getPackageManager)();
     var commands = __spreadArray(__spreadArray([
         "- `cd ./".concat(directory, "`"),
-        '- `yarn install` to install frontend dependencies.',
-        '- `yarn dev` to build (and watch) the plugin frontend code.'
+        "- `".concat(packageManager, " install` to install frontend dependencies."),
+        "- `".concat(packageManager, " run dev` to build (and watch) the plugin frontend code.")
     ], (answers.hasBackend
         ? [
             '- `mage -v build:linux` to build the plugin backend code. Rerun this command every time you edit your backend files.',

package/dist/commands/generate.plopfile.js

@@ -23,14 +23,14 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 exports.__esModule = true;
+var fs_1 = __importDefault(require("fs"));
 var glob_1 = __importDefault(require("glob"));
 var path_1 = __importDefault(require("path"));
-var fs_1 = __importDefault(require("fs"));
-var utils_handlebars_1 = require("../utils/utils.handlebars");
 var constants_1 = require("../constants");
+var utils_handlebars_1 = require("../utils/utils.handlebars");
+var utils_path_1 = require("../utils/utils.path");
 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 utils_path_1 = require("../utils/utils.path");
 function default_1(plop) {
     plop.setHelper('if_eq', utils_handlebars_1.ifEq);
     plop.setHelper('normalize_id', utils_handlebars_1.normalizeId);
@@ -167,6 +167,9 @@ function getActionsForTemplateFolder(_a) {
     function getExportPath(f) {
         return path_1["default"].relative(folderPath, path_1["default"].dirname(f));
     }
+    if (constants_1.EXTRA_TEMPLATE_VARIABLES.packageManager !== 'pnpm') {
+        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/constants.js

@@ -5,6 +5,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
 exports.__esModule = true;
 exports.TEXT = exports.UDPATE_CONFIG = exports.MIGRATION_CONFIG = exports.GRAFANA_FE_PACKAGES = exports.EXTRA_TEMPLATE_VARIABLES = exports.PLUGIN_TYPES = exports.TEMPLATE_PATHS = exports.FIXTURES_PATH = exports.PARTIALS_DIR = exports.TEMPLATES_DIR = exports.DIST_DIR = exports.EXPORT_PATH_PREFIX = exports.DEV_EXPORT_DIR = exports.IS_DEV = void 0;
 var path_1 = __importDefault(require("path"));
+var utils_npm_1 = require("./utils/utils.npm");
 exports.IS_DEV = process.env.CREATE_PLUGIN_DEV !== undefined;
 exports.DEV_EXPORT_DIR = path_1["default"].join(__dirname, '..', 'generated');
 exports.EXPORT_PATH_PREFIX = exports.IS_DEV ? exports.DEV_EXPORT_DIR : process.cwd();
@@ -29,8 +30,12 @@ var PLUGIN_TYPES;
     PLUGIN_TYPES["datasource"] = "datasource";
     PLUGIN_TYPES["secretsmanager"] = "secretsmanager";
 })(PLUGIN_TYPES = exports.PLUGIN_TYPES || (exports.PLUGIN_TYPES = {}));
+var PACKAGE_MANAGER = (0, utils_npm_1.getPackageManager)();
+var PACKAGE_MANAGER_INSTALL_CMD = (0, utils_npm_1.getInstallCmd)(PACKAGE_MANAGER);
 exports.EXTRA_TEMPLATE_VARIABLES = {
-    grafanaVersion: '9.3.8'
+    grafanaVersion: '9.3.8',
+    packageManager: PACKAGE_MANAGER,
+    packageManagerInstallCmd: PACKAGE_MANAGER_INSTALL_CMD
 };
 exports.GRAFANA_FE_PACKAGES = [
     '@grafana/data',

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.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.getInstallCmd = exports.getPackageManager = exports.cleanUpPackageJson = 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"));
@@ -218,3 +218,39 @@ function sortKeysAlphabetically(obj) {
         return acc;
     }, {});
 }
+function getPackageManager() {
+    var agent = process.env.npm_config_user_agent;
+    if (!agent) {
+        var parent_1 = process.env._;
+        if (!parent_1) {
+            return 'npm';
+        }
+        if (parent_1.endsWith('pnpx') || parent_1.endsWith('pnpm')) {
+            return 'pnpm';
+        }
+        if (parent_1.endsWith('yarn')) {
+            return 'yarn';
+        }
+        return 'npm';
+    }
+    var program = agent.split('/')[0];
+    if (program === 'yarn') {
+        return 'yarn';
+    }
+    if (program === 'pnpm') {
+        return 'pnpm';
+    }
+    return 'npm';
+}
+exports.getPackageManager = getPackageManager;
+function getInstallCmd(packageManager) {
+    switch (packageManager) {
+        case 'yarn':
+            return 'yarn install --immutable --prefer-offline';
+        case 'pnpm':
+            return 'pnpm install --frozen-lockfile --prefer-offline';
+        default:
+            return 'npm ci';
+    }
+}
+exports.getInstallCmd = getInstallCmd;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/create-plugin",
-  "version": "1.2.0",
+  "version": "1.3.0-canary.226.129a5b7.0",
   "main": "index.js",
   "repository": {
     "directory": "packages/create-plugin",
@@ -63,5 +63,5 @@
   "engines": {
     "node": ">=16"
   },
-  "gitHead": "286c9962e8625f004f8915f860b8145f633cf215"
+  "gitHead": "129a5b7f313dd3e748f625822fdf7529b135b174"
 }

package/src/commands/generate-actions/print-success-message.ts

@@ -1,14 +1,15 @@
 import { displayAsMarkdown } from '../../utils/utils.console';
 import { normalizeId } from '../../utils/utils.handlebars';
+import { getPackageManager } from '../../utils/utils.npm';
 import { CliArgs } from '../types';
 
 export function printGenerateSuccessMessage(answers: CliArgs) {
   const directory = normalizeId(answers.pluginName, answers.orgName, answers.pluginType);
-
+  const packageManager = getPackageManager();
   const commands = [
     `- \`cd ./${directory}\``,
-    '- `yarn install` to install frontend dependencies.',
-    '- `yarn dev` to build (and watch) the plugin frontend code.',
+    `- \`${packageManager} install\` to install frontend dependencies.`,
+    `- \`${packageManager} run dev\` to build (and watch) the plugin frontend code.`,
     ...(answers.hasBackend
       ? [
           '- `mage -v build:linux` to build the plugin backend code. Rerun this command every time you edit your backend files.',

package/src/commands/generate.plopfile.ts

@@ -1,13 +1,13 @@
-import type { NodePlopAPI, ModifyActionConfig } from 'plop';
+import fs from 'fs';
 import glob from 'glob';
 import path from 'path';
-import fs from 'fs';
+import type { ModifyActionConfig, NodePlopAPI } from 'plop';
+import { EXTRA_TEMPLATE_VARIABLES, IS_DEV, PARTIALS_DIR, PLUGIN_TYPES, TEMPLATE_PATHS } from '../constants';
 import { ifEq, normalizeId } from '../utils/utils.handlebars';
-import { IS_DEV, TEMPLATE_PATHS, PARTIALS_DIR, PLUGIN_TYPES, EXTRA_TEMPLATE_VARIABLES } from '../constants';
+import { getExportPath } from '../utils/utils.path';
 import { printGenerateSuccessMessage } from './generate-actions/print-success-message';
 import { updateGoSdkAndModules } from './generate-actions/update-go-sdk-and-packages';
 import { CliArgs } from './types';
-import { getExportPath } from '../utils/utils.path';
 
 // Plopfile API documentation: https://plopjs.com/documentation/#plopfile-api
 export default function (plop: NodePlopAPI) {
@@ -84,6 +84,7 @@ export default function (plop: NodePlopAPI) {
     }: CliArgs) {
       const exportPath = getExportPath(pluginName, orgName, pluginType);
       const pluginId = normalizeId(pluginName, orgName, pluginType);
+
       // Copy over files that are shared between plugins types
       const commonActions = getActionsForTemplateFolder({
         folderPath: TEMPLATE_PATHS.common,
@@ -204,6 +205,11 @@ function getActionsForTemplateFolder({
     return path.relative(folderPath, path.dirname(f));
   }
 
+  // Remove the npmrc file if not running `pnpm`.
+  if (EXTRA_TEMPLATE_VARIABLES.packageManager !== 'pnpm') {
+    files.filter((file) => path.basename(file) === 'npmrc');
+  }
+
   return files.filter(isFile).map((f) => ({
     type: 'add',
     templateFile: f,

package/src/constants.ts

@@ -1,4 +1,5 @@
 import path from 'path';
+import { getInstallCmd, getPackageManager } from './utils/utils.npm';
 
 export const IS_DEV = process.env.CREATE_PLUGIN_DEV !== undefined;
 
@@ -34,11 +35,17 @@ export enum PLUGIN_TYPES {
   secretsmanager = 'secretsmanager',
 }
 
+// Support the users package manager of choice.
+const PACKAGE_MANAGER = getPackageManager();
+const PACKAGE_MANAGER_INSTALL_CMD = getInstallCmd(PACKAGE_MANAGER);
+
 // This gets merged into variables coming from user prompts (when using Plop) or any other dynamic variables,
 // and will be available to use in the templates.
 // Example: "@grafana/ui": "{{ grafanaVersion }}"
 export const EXTRA_TEMPLATE_VARIABLES = {
   grafanaVersion: '9.3.8',
+  packageManager: PACKAGE_MANAGER,
+  packageManagerInstallCmd: PACKAGE_MANAGER_INSTALL_CMD,
 };
 
 export const GRAFANA_FE_PACKAGES = [

package/src/utils/utils.npm.ts

@@ -249,3 +249,48 @@ function sortKeysAlphabetically(obj: Record<string, string>) {
       return acc;
     }, {});
 }
+
+export function getPackageManager() {
+  const agent = process.env.npm_config_user_agent;
+
+  if (!agent) {
+    const parent = process.env._;
+
+    if (!parent) {
+      return 'npm';
+    }
+
+    if (parent.endsWith('pnpx') || parent.endsWith('pnpm')) {
+      return 'pnpm';
+    }
+    if (parent.endsWith('yarn')) {
+      return 'yarn';
+    }
+
+    return 'npm';
+  }
+
+  const [program] = agent.split('/');
+
+  if (program === 'yarn') {
+    return 'yarn';
+  }
+  if (program === 'pnpm') {
+    return 'pnpm';
+  }
+
+  return 'npm';
+}
+
+export function getInstallCmd(packageManager: string) {
+  switch (packageManager) {
+    case 'yarn':
+      return 'yarn install --immutable --prefer-offline';
+
+    case 'pnpm':
+      return 'pnpm install --frozen-lockfile --prefer-offline';
+
+    default:
+      return 'npm ci';
+  }
+}

package/templates/backend/.vscode/launch.json

@@ -0,0 +1,16 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Standalone debug mode",
+      "type": "go",
+      "request": "launch",
+      "mode": "debug",
+      "program": "${workspaceFolder}/pkg",
+      "env": {},
+      "args": [
+        "-standalone"
+      ]
+    }
+  ]
+}

package/templates/backend/go.mod

@@ -2,7 +2,7 @@ module github.com/{{ kebabCase orgName }}/{{ kebabCase pluginName }}
 
 go 1.19
 
-require github.com/grafana/grafana-plugin-sdk-go v0.155.0
+require github.com/grafana/grafana-plugin-sdk-go v0.156.0
 
 require (
 	github.com/BurntSushi/toml v1.2.1 // indirect

package/templates/backend/go.sum

@@ -112,8 +112,8 @@ github.com/gopherjs/gopherjs v0.0.0-20181103185306-d547d1d9531e h1:JKmoR8x90Iww1
 github.com/gopherjs/gopherjs v0.0.0-20181103185306-d547d1d9531e/go.mod h1:wJfORRmW1u3UXTncJ5qlYoELFm8eSnnEO6hX4iZ3EWY=
 github.com/gorilla/mux v1.8.0 h1:i40aqfkR1h2SlN9hojwV5ZA91wcXFOvkdNIeFDP5koI=
 github.com/gorilla/mux v1.8.0/go.mod h1:DVbg23sWSpFRCP0SfiEN6jmj59UnW/n46BH5rLB71So=
-github.com/grafana/grafana-plugin-sdk-go v0.155.0 h1:i6yQu3RegxxFph2poE2+DOG8EHT1R9LS5WDbTglIhSQ=
-github.com/grafana/grafana-plugin-sdk-go v0.155.0/go.mod h1:Wj4WD+sfoUB/q5UG016IvUQBM7HBJaNEAc88b++4szs=
+github.com/grafana/grafana-plugin-sdk-go v0.156.0 h1:LPR5gpROmdwkkvm5oGihl0mSKyWNHWIjAjzzTxk3k7M=
+github.com/grafana/grafana-plugin-sdk-go v0.156.0/go.mod h1:Wj4WD+sfoUB/q5UG016IvUQBM7HBJaNEAc88b++4szs=
 github.com/grpc-ecosystem/go-grpc-middleware v1.3.0 h1:+9834+KizmvFV7pXQGSXQTsaWhq2GjuNUt0aUU0YBYw=
 github.com/grpc-ecosystem/go-grpc-middleware v1.3.0/go.mod h1:z0ButlSOZa5vEBq9m2m2hlwIgKw+rp3sdCBRoJY+30Y=
 github.com/grpc-ecosystem/go-grpc-prometheus v1.2.0 h1:Ovs26xHkKqVztRpIrF/92BcuyuQ/YW4NSIpoGtfXNho=

package/templates/backend-app/.vscode/launch.json

@@ -0,0 +1,16 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "name": "Standalone debug mode",
+      "type": "go",
+      "request": "launch",
+      "mode": "debug",
+      "program": "${workspaceFolder}/pkg",
+      "env": {},
+      "args": [
+        "-standalone"
+      ]
+    }
+  ]
+}

package/templates/backend-app/go.mod

@@ -2,7 +2,7 @@ module github.com/{{ kebabCase orgName }}/{{ kebabCase pluginName }}
 
 go 1.19
 
-require github.com/grafana/grafana-plugin-sdk-go v0.155.0
+require github.com/grafana/grafana-plugin-sdk-go v0.156.0
 
 require (
 	github.com/BurntSushi/toml v1.2.1 // indirect

package/templates/backend-app/go.sum

@@ -112,8 +112,8 @@ github.com/gopherjs/gopherjs v0.0.0-20181103185306-d547d1d9531e h1:JKmoR8x90Iww1
 github.com/gopherjs/gopherjs v0.0.0-20181103185306-d547d1d9531e/go.mod h1:wJfORRmW1u3UXTncJ5qlYoELFm8eSnnEO6hX4iZ3EWY=
 github.com/gorilla/mux v1.8.0 h1:i40aqfkR1h2SlN9hojwV5ZA91wcXFOvkdNIeFDP5koI=
 github.com/gorilla/mux v1.8.0/go.mod h1:DVbg23sWSpFRCP0SfiEN6jmj59UnW/n46BH5rLB71So=
-github.com/grafana/grafana-plugin-sdk-go v0.155.0 h1:i6yQu3RegxxFph2poE2+DOG8EHT1R9LS5WDbTglIhSQ=
-github.com/grafana/grafana-plugin-sdk-go v0.155.0/go.mod h1:Wj4WD+sfoUB/q5UG016IvUQBM7HBJaNEAc88b++4szs=
+github.com/grafana/grafana-plugin-sdk-go v0.156.0 h1:LPR5gpROmdwkkvm5oGihl0mSKyWNHWIjAjzzTxk3k7M=
+github.com/grafana/grafana-plugin-sdk-go v0.156.0/go.mod h1:Wj4WD+sfoUB/q5UG016IvUQBM7HBJaNEAc88b++4szs=
 github.com/grpc-ecosystem/go-grpc-middleware v1.3.0 h1:+9834+KizmvFV7pXQGSXQTsaWhq2GjuNUt0aUU0YBYw=
 github.com/grpc-ecosystem/go-grpc-middleware v1.3.0/go.mod h1:z0ButlSOZa5vEBq9m2m2hlwIgKw+rp3sdCBRoJY+30Y=
 github.com/grpc-ecosystem/go-grpc-prometheus v1.2.0 h1:Ovs26xHkKqVztRpIrF/92BcuyuQ/YW4NSIpoGtfXNho=

package/templates/common/gitignore

@@ -4,6 +4,7 @@ logs
 npm-debug.log*
 yarn-debug.log*
 yarn-error.log*
+.pnpm-debug.log*
 
 node_modules/
 
@@ -26,7 +27,7 @@ work/
 ci/
 e2e-results/
 **/cypress/videos
-**/cypress/report.json 
+**/cypress/report.json
 
 # Editor
 .idea

package/templates/common/package.json

@@ -9,9 +9,9 @@
     "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",
-    "e2e": "yarn cypress install && yarn grafana-e2e run",
-    "e2e:update": "yarn cypress install && yarn grafana-e2e run --update-screenshots",
+    "lint:fix": "{{ packageManager }} run lint --fix",
+    "e2e": "{{ packageManager }} exec cypress install && {{ packageManager }} exec grafana-e2e run",
+    "e2e:update": "{{ packageManager }} exec cypress install && {{ packageManager }} exec grafana-e2e run --update-screenshots",
     "server": "docker-compose up --build",
     "sign": "npx --yes @grafana/sign-plugin@latest"
   },

package/templates/github/ci/.github/workflows/ci.yml

@@ -15,30 +15,32 @@ jobs:
   build:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
-
+      - uses: actions/checkout@v3{{#if_eq packageManager "pnpm"}}
+      - uses: pnpm/action-setup@v2
+        with:
+          version: 7.x.x{{/if_eq}}
       - name: Setup Node.js environment
         uses: actions/setup-node@v3
         with:
           node-version: '16'
-          cache: 'yarn'
+          cache: '{{ packageManager }}'
       - name: Install dependencies
-        run: yarn install --immutable --prefer-offline
+        run: {{ packageManagerInstallCmd }}
 
       - name: Check types
-        run: yarn typecheck
+        run: {{ packageManager }} run typecheck
       - name: Lint
-        run: yarn lint
+        run: {{ packageManager }} run lint
       - name: Unit tests
-        run: yarn test:ci
+        run: {{ packageManager }} run test:ci
       - name: Build frontend
-        run: yarn build
+        run: {{ packageManager }} run build
 
       - name: Start grafana docker
-        run: yarn server -d
+        run: docker-compose up -d
 
       - name: Run e2e tests
-        run: yarn e2e
+        run: {{ packageManager }} run e2e
 
       - name: Stop grafana docker
         run: docker-compose down

package/templates/github/ci/.github/workflows/release.yml

@@ -12,13 +12,16 @@ jobs:
     env:
       GRAFANA_API_KEY: $\{{ secrets.GRAFANA_API_KEY }} # Requires a Grafana API key from Grafana.com.
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v3{{#if_eq packageManager "pnpm"}}
+      - uses: pnpm/action-setup@v2
+        with:
+          version: 7.x.x{{/if_eq}}
 
       - name: Setup Node.js environment
         uses: actions/setup-node@v3
         with:
           node-version: '16'
-          cache: 'yarn'
+          cache: '{{ packageManager }}'
 
       - name: Setup Go environment
         uses: actions/setup-go@v3
@@ -26,10 +29,10 @@ jobs:
           go-version: '1.19'
 
       - name: Install dependencies
-        run: yarn install --immutable --prefer-offline
+        run: {{ packageManagerInstallCmd }}
 
       - name: Build and test frontend
-        run: yarn build
+        run: {{ packageManager }} run build
 
       - name: Check for backend
         id: check-for-backend
@@ -60,7 +63,7 @@ jobs:
         if: $\{{ env.GRAFANA_API_KEY == '' }}
 
       - name: Sign plugin
-        run: yarn sign
+        run: {{ packageManager }} run sign
         if: $\{{ env.GRAFANA_API_KEY != '' }}
 
       - name: Get plugin metadata

package/templates/github/is-compatible/.github/workflows/is-compatible.yml

@@ -9,10 +9,10 @@ jobs:
       - uses: actions/setup-node@v3
         with:
           node-version: '16'
-          cache: 'yarn'
+          cache: '{{ packageManager }}'
       - name: Install dependencies
-        run: yarn install --immutable --prefer-offline
+        run: {{ packageManagerInstallCmd }}
       - name: Build plugin
-        run: yarn build
+        run: {{ packageManager }} run build
       - name: Compatibility check
         run: npx @grafana/levitate@latest is-compatible --path src/module.ts --target @grafana/data,@grafana/ui,@grafana/runtime