@grafana/create-plugin 3.1.1 → 3.1.2-canary.694.f97a4af.0

package/dist/commands/generate.command.js

@@ -133,9 +133,16 @@ async function generateFiles({ actions }) {
             });
         }
         catch (error) {
+            let message;
+            if (error instanceof Error) {
+                message = error.message;
+            }
+            else {
+                message = String(error);
+            }
             failures.push({
                 path: action.path,
-                error: error.message || error.toString(),
+                error: message,
             });
         }
     }

package/dist/commands/provisioning.command.js

@@ -28,6 +28,13 @@ export const provisioning = async () => {
         }
     }
     catch (error) {
-        printError(error);
+        let message;
+        if (error instanceof Error) {
+            message = error.message;
+        }
+        else {
+            message = String(error);
+        }
+        printError(message);
     }
 };

package/dist/utils/utils.npm.js

@@ -3,7 +3,7 @@ import { GRAFANA_FE_PACKAGES } from '../constants.js';
 import { getPackageJson, writePackageJson, getLatestPackageJson } from './utils.packagejson.js';
 export function getNpmDependencyUpdatesAsText(dependencyUpdates) {
     return Object.entries(dependencyUpdates)
-        .filter(([packageName, { prev, next }]) => prev !== next)
+        .filter(([_, { prev, next }]) => prev !== next)
         .map(([packageName, { prev, next }]) => {
         if (!prev) {
             return `\`${packageName}\` - \`${next}\` (new)`;
@@ -39,7 +39,7 @@ export function updatePackageJson(options = {}) {
 export function updateNpmDependencies(dependencies, updateSummary) {
     const updatedDependencies = { ...dependencies };
     for (const [packageName, summary] of Object.entries(updateSummary)) {
-        updatedDependencies[packageName] = summary.next;
+        updatedDependencies[packageName] = summary.next ?? '';
     }
     return updatedDependencies;
 }

package/dist/utils/utils.packageManager.js

@@ -72,12 +72,14 @@ function getPackageManagerFromLockFile() {
     }
     catch (error) {
         console.error('Failed to find package manager from lock file. Have you installed dependencies?');
-        throw Error(error);
+        if (error instanceof Error) {
+            throw error;
+        }
     }
 }
 function getPackageManagerFromPackageJson() {
     const packageJson = getPackageJson();
-    if (packageJson.hasOwnProperty('packageManager')) {
+    if (packageJson?.packageManager) {
         const [packageManagerName, packageManagerVersion] = packageJson.packageManager.split('@');
         return { packageManagerName, packageManagerVersion };
     }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/create-plugin",
-  "version": "3.1.1",
+  "version": "3.1.2-canary.694.f97a4af.0",
   "repository": {
     "directory": "packages/create-plugin",
     "url": "https://github.com/grafana/plugin-tools"
@@ -36,7 +36,7 @@
     "generate-datasource-backend": "tsc && npm run clean-generated && CREATE_PLUGIN_DEV=true node ./dist/bin/run.js --pluginName='Sample datasource' --orgName='sample-org' --pluginDescription='This is a sample datasource.' --pluginType='datasource' --hasBackend --hasGithubWorkflows --hasGithubLevitateWorkflow",
     "lint": "eslint --cache --ext .js,.jsx,.ts,.tsx ./src",
     "lint:fix": "npm run lint -- --fix",
-    "test": "vitest run",
+    "test": "vitest",
     "typecheck": "tsc --noEmit"
   },
   "dependencies": {
@@ -62,8 +62,7 @@
   "devDependencies": {
     "@types/glob": "^7.0.0",
     "eslint-plugin-react": "^7.26.1",
-    "eslint-plugin-react-hooks": "^4.2.0",
-    "vitest": "^1.1.3"
+    "eslint-plugin-react-hooks": "^4.2.0"
   },
   "overrides": {
     "@types/marked-terminal": {
@@ -86,5 +85,5 @@
   "engines": {
     "node": ">=20"
   },
-  "gitHead": "44847f05e9bb2b747ed171852a8052514c25725e"
+  "gitHead": "f97a4af609f8d9b4fd498d88f6811f26725e4ca8"
 }

package/src/commands/generate/prompt-user.ts

@@ -32,7 +32,7 @@ type Prompt = {
   validate?: (value: string) => boolean | string | Promise<boolean | string>;
   initial?: any;
   choices?: Array<string | Choice>;
-  shouldPrompt?: ((state: object) => boolean | Promise<boolean>) | boolean;
+  shouldPrompt?: (answers: Partial<CliArgs>) => boolean;
 };
 
 type Choice = {
@@ -85,7 +85,7 @@ const prompts: Prompt[] = [
     type: 'confirm',
     message: 'Do you want a backend part of your plugin?',
     initial: false,
-    shouldPrompt: (answers: CliArgs) => answers.pluginType !== PLUGIN_TYPES.panel,
+    shouldPrompt: (answers) => answers.pluginType !== PLUGIN_TYPES.panel,
   },
   {
     name: 'hasGithubWorkflows',

package/src/commands/generate.command.ts

@@ -74,6 +74,12 @@ function getTemplateData(answers: CliArgs) {
   return templateData;
 }
 
+type TemplateAction = {
+  templateFile: string;
+  path: string;
+  data: TemplateData;
+};
+
 function getTemplateActions({ exportPath, templateData }: { exportPath: string; templateData: any }) {
   const commonActions = getActionsForTemplateFolder({
     folderPath: TEMPLATE_PATHS.common,
@@ -97,15 +103,18 @@ function getTemplateActions({ exportPath, templateData }: { exportPath: string;
   // Common, pluginType and backend actions can contain different templates for the same destination.
   // This filtering removes the duplicate file additions to make sure the correct template is scaffolded.
   // Note that the order is reversed so backend > pluginType > common
-  const pluginActions = [...backendActions, ...pluginTypeSpecificActions, ...commonActions].reduce((acc, file) => {
-    const actionExists = acc.find((f) => f.path === file.path);
-    // return early to prevent duplicate file additions
-    if (actionExists) {
+  const pluginActions = [...backendActions, ...pluginTypeSpecificActions, ...commonActions].reduce<TemplateAction[]>(
+    (acc, file) => {
+      const actionExists = acc.find((f) => f.path === file.path);
+      // return early to prevent duplicate file additions
+      if (actionExists) {
+        return acc;
+      }
+      acc.push(file);
       return acc;
-    }
-    acc.push(file);
-    return acc;
-  }, []);
+    },
+    []
+  );
 
   // Copy over Github workflow files (if selected)
   const ciWorkflowActions = templateData.hasGithubWorkflows
@@ -147,7 +156,7 @@ function getActionsForTemplateFolder({
     return path.relative(folderPath, path.dirname(f));
   }
 
-  return files.filter(isFile).map((f) => ({
+  return files.filter(isFile).map<TemplateAction>((f) => ({
     templateFile: f,
     // The target path where the compiled template is saved to
     path: path.join(exportPath, getFileExportPath(f), getExportFileName(f)),
@@ -175,9 +184,15 @@ async function generateFiles({ actions }: { actions: any[] }) {
         path: action.path,
       });
     } catch (error) {
+      let message;
+      if (error instanceof Error) {
+        message = error.message;
+      } else {
+        message = String(error);
+      }
       failures.push({
         path: action.path,
-        error: error.message || error.toString(),
+        error: message,
       });
     }
   }

package/src/commands/provisioning.command.ts

@@ -27,6 +27,12 @@ export const provisioning = async () => {
       process.exit(1);
     }
   } catch (error) {
-    printError(error);
+    let message;
+    if (error instanceof Error) {
+      message = error.message;
+    } else {
+      message = String(error);
+    }
+    printError(message);
   }
 };

package/src/utils/utils.config.ts

@@ -23,10 +23,10 @@ export function getConfig(): CreatePluginConfig {
     return {
       ...rootConfig,
       ...userConfig,
-      version: rootConfig.version,
+      version: rootConfig!.version,
       features: createFeatureFlags({
-        ...rootConfig.features,
-        ...userConfig.features,
+        ...rootConfig!.features,
+        ...userConfig!.features,
       }),
     };
   } catch (error) {
@@ -45,7 +45,7 @@ function getUserConfig(): UserConfig | undefined {
     return {
       ...userConfig,
       features: createFeatureFlags({
-        ...userConfig.features,
+        ...userConfig!.features,
       }),
     };
   } catch (error) {

package/src/utils/utils.npm.ts

@@ -13,7 +13,7 @@ type UpdateOptions = {
 
 export function getNpmDependencyUpdatesAsText(dependencyUpdates: UpdateSummary) {
   return Object.entries(dependencyUpdates)
-    .filter(([packageName, { prev, next }]) => prev !== next)
+    .filter(([_, { prev, next }]) => prev !== next)
     .map(([packageName, { prev, next }]) => {
       // New package
       if (!prev) {
@@ -59,14 +59,11 @@ export function updatePackageJson(options: UpdateOptions = {}) {
   writePackageJson(packageJson);
 }
 
-export function updateNpmDependencies(
-  dependencies: Record<string, string>,
-  updateSummary: UpdateSummary
-): Record<string, string> {
-  const updatedDependencies: Record<string, string> = { ...dependencies };
+export function updateNpmDependencies(dependencies: Record<string, string>, updateSummary: UpdateSummary) {
+  const updatedDependencies = { ...dependencies };
 
   for (const [packageName, summary] of Object.entries(updateSummary)) {
-    updatedDependencies[packageName] = summary.next;
+    updatedDependencies[packageName] = summary.next ?? '';
   }
 
   return updatedDependencies;

package/src/utils/utils.packageManager.ts

@@ -94,13 +94,15 @@ function getPackageManagerFromLockFile(): PackageManager | undefined {
     return undefined;
   } catch (error) {
     console.error('Failed to find package manager from lock file. Have you installed dependencies?');
-    throw Error(error);
+    if (error instanceof Error) {
+      throw error;
+    }
   }
 }
 
 function getPackageManagerFromPackageJson(): PackageManager | undefined {
   const packageJson = getPackageJson();
-  if (packageJson.hasOwnProperty('packageManager')) {
+  if (packageJson?.packageManager) {
     const [packageManagerName, packageManagerVersion] = packageJson.packageManager.split('@');
     return { packageManagerName, packageManagerVersion };
   }

package/tsconfig.json

@@ -1,10 +1,6 @@
 {
   "$schema": "https://json.schemastore.org/tsconfig",
   "compilerOptions": {
-    "lib": ["es2023", "dom"],
-    "module": "node16",
-    "target": "es2022",
-    "moduleResolution": "node16",
     "outDir": "./dist"
   },
   "exclude": ["node_modules", "templates"],

package/vitest.config.ts

@@ -1,10 +1,12 @@
-import { resolve } from 'path';
-import { defineConfig } from 'vitest/config';
+import { resolve } from 'node:path';
+import { defineProject, mergeConfig } from 'vitest/config';
+import configShared from '../../vitest.config.base.js';
 
-export default defineConfig({
-  test: {
-    root: resolve(__dirname),
-    globals: true,
-    include: ['**/*.test.ts'],
-  },
-});
+export default mergeConfig(
+  configShared,
+  defineProject({
+    test: {
+      root: resolve(__dirname),
+    },
+  })
+);

package/jest.config.js

@@ -1,8 +0,0 @@
-const sharedConfig = require('../../jest.config.base');
-const esModules = ['change-case', 'title-case'].join('|');
-
-module.exports = {
-  ...sharedConfig,
-  modulePathIgnorePatterns: ['<rootDir>/templates/'],
-  transformIgnorePatterns: [`/node_modules/(?!${esModules})`],
-};