@grafana/create-plugin 2.11.2 → 2.12.0-canary.658.dabaee1.0

package/src/utils/tests/utils.npm.test.ts

@@ -1,18 +1,27 @@
+import { vi } from 'vitest';
 import {
   updateNpmDependencies,
   getUpdatableNpmDependencies,
   hasNpmDependenciesToUpdate,
   getPackageJsonUpdatesAsText,
   updatePackageJson,
-} from '../utils.npm';
-
-import { getPackageJson, getLatestPackageJson, writePackageJson } from '../utils.packagejson';
-
-jest.mock('../utils.packagejson.ts');
+} from '../utils.npm.js';
+
+const mocks = vi.hoisted(() => {
+  return {
+    getPackageJson: vi.fn(),
+    getLatestPackageJson: vi.fn(),
+    writePackageJson: vi.fn(),
+  };
+});
 
-const getPackageJsonMock = getPackageJson as jest.Mock;
-const getLatestPackageJsonMock = getLatestPackageJson as jest.Mock;
-const writePackageJsonMock = writePackageJson as jest.Mock;
+vi.mock('../utils.packagejson.js', async () => {
+  return {
+    getPackageJson: mocks.getPackageJson,
+    getLatestPackageJson: mocks.getLatestPackageJson,
+    writePackageJson: mocks.writePackageJson,
+  };
+});
 
 describe('Utils / NPM', () => {
   describe('getUpdatableNpmDependencies()', () => {
@@ -220,8 +229,8 @@ describe('Utils / NPM', () => {
       };
 
       // same package.json for existing and latest
-      getPackageJsonMock.mockReturnValue(packageJson);
-      getLatestPackageJsonMock.mockReturnValue(packageJson);
+      mocks.getPackageJson.mockReturnValue(packageJson);
+      mocks.getLatestPackageJson.mockReturnValue(packageJson);
 
       const result = hasNpmDependenciesToUpdate();
       expect(result).toBe(false);
@@ -252,8 +261,8 @@ describe('Utils / NPM', () => {
         scripts: {},
       };
 
-      getPackageJsonMock.mockReturnValue(packageJson);
-      getLatestPackageJsonMock.mockReturnValue(latestPackageJson);
+      mocks.getPackageJson.mockReturnValue(packageJson);
+      mocks.getLatestPackageJson.mockReturnValue(latestPackageJson);
 
       const result = hasNpmDependenciesToUpdate();
       expect(result).toBe(true);
@@ -285,8 +294,8 @@ describe('Utils / NPM', () => {
         scripts: {},
       };
 
-      getPackageJsonMock.mockReturnValue(packageJson);
-      getLatestPackageJsonMock.mockReturnValue(latestPackageJson);
+      mocks.getPackageJson.mockReturnValue(packageJson);
+      mocks.getLatestPackageJson.mockReturnValue(latestPackageJson);
 
       const result = hasNpmDependenciesToUpdate({ devOnly: true });
       expect(result).toBe(false);
@@ -307,8 +316,8 @@ describe('Utils / NPM', () => {
         scripts: {},
       };
 
-      getPackageJsonMock.mockReturnValue(packageJson);
-      getLatestPackageJsonMock.mockReturnValue(packageJson);
+      mocks.getPackageJson.mockReturnValue(packageJson);
+      mocks.getLatestPackageJson.mockReturnValue(packageJson);
 
       const result = getPackageJsonUpdatesAsText();
       expect(result).toBe('');
@@ -339,8 +348,8 @@ describe('Utils / NPM', () => {
         scripts: {},
       };
 
-      getPackageJsonMock.mockReturnValue(packageJson);
-      getLatestPackageJsonMock.mockReturnValue(latestPackageJson);
+      mocks.getPackageJson.mockReturnValue(packageJson);
+      mocks.getLatestPackageJson.mockReturnValue(latestPackageJson);
 
       const result = getPackageJsonUpdatesAsText();
       expect(result).toContain('sass');
@@ -372,8 +381,8 @@ describe('Utils / NPM', () => {
         scripts: {},
       };
 
-      getPackageJsonMock.mockReturnValue(packageJson);
-      getLatestPackageJsonMock.mockReturnValue(latestPackageJson);
+      mocks.getPackageJson.mockReturnValue(packageJson);
+      mocks.getLatestPackageJson.mockReturnValue(latestPackageJson);
 
       const result = getPackageJsonUpdatesAsText({ devOnly: true });
       expect(result).toBe('');
@@ -404,8 +413,8 @@ describe('Utils / NPM', () => {
         scripts: {},
       };
 
-      getPackageJsonMock.mockReturnValue(packageJson);
-      getLatestPackageJsonMock.mockReturnValue(latestPackageJson);
+      mocks.getPackageJson.mockReturnValue(packageJson);
+      mocks.getLatestPackageJson.mockReturnValue(latestPackageJson);
 
       const result = getPackageJsonUpdatesAsText({ devOnly: true });
       expect(result).toContain('sass');
@@ -426,12 +435,12 @@ describe('Utils / NPM', () => {
         scripts: {},
       };
 
-      getPackageJsonMock.mockReturnValue(packageJson);
-      getLatestPackageJsonMock.mockReturnValue(packageJson);
+      mocks.getPackageJson.mockReturnValue(packageJson);
+      mocks.getLatestPackageJson.mockReturnValue(packageJson);
 
       updatePackageJson();
       //should have the same original content
-      expect(writePackageJsonMock).toHaveBeenCalledWith({
+      expect(mocks.writePackageJson).toHaveBeenCalledWith({
         dependencies: {
           '@grafana/ui': '10.0.0',
           react: '18.2.0',
@@ -469,12 +478,12 @@ describe('Utils / NPM', () => {
         scripts: {},
       };
 
-      getPackageJsonMock.mockReturnValue(packageJson);
-      getLatestPackageJsonMock.mockReturnValue(latestPackageJson);
+      mocks.getPackageJson.mockReturnValue(packageJson);
+      mocks.getLatestPackageJson.mockReturnValue(latestPackageJson);
 
       updatePackageJson();
       //should have the combined content
-      expect(writePackageJsonMock).toHaveBeenCalledWith({
+      expect(mocks.writePackageJson).toHaveBeenCalledWith({
         dependencies: {
           '@grafana/ui': '10.0.0',
           react: '18.2.1', //changed
@@ -512,12 +521,12 @@ describe('Utils / NPM', () => {
         scripts: {},
       };
 
-      getPackageJsonMock.mockReturnValue(packageJson);
-      getLatestPackageJsonMock.mockReturnValue(latestPackageJson);
+      mocks.getPackageJson.mockReturnValue(packageJson);
+      mocks.getLatestPackageJson.mockReturnValue(latestPackageJson);
 
       updatePackageJson({ devOnly: true });
       //should have the combined content
-      expect(writePackageJsonMock).toHaveBeenCalledWith({
+      expect(mocks.writePackageJson).toHaveBeenCalledWith({
         dependencies: {
           '@grafana/ui': '10.0.0',
           react: '18.2.0',
@@ -555,12 +564,12 @@ describe('Utils / NPM', () => {
         scripts: {},
       };
 
-      getPackageJsonMock.mockReturnValue(packageJson);
-      getLatestPackageJsonMock.mockReturnValue(latestPackageJson);
+      mocks.getPackageJson.mockReturnValue(packageJson);
+      mocks.getLatestPackageJson.mockReturnValue(latestPackageJson);
 
       updatePackageJson({ devOnly: true });
       //should have the combined content
-      expect(writePackageJsonMock).toHaveBeenCalledWith({
+      expect(mocks.writePackageJson).toHaveBeenCalledWith({
         dependencies: {
           '@grafana/ui': '10.0.0',
           react: '18.2.0', //changed but devOnly so should not be changed in the file

package/src/utils/tests/utils.plugin.test.ts

@@ -1,5 +1,5 @@
-import { FIXTURES_PATH, TEMPLATE_PATHS } from '../../constants';
-import { getPluginJson } from '../utils.plugin';
+import { FIXTURES_PATH, TEMPLATE_PATHS } from '../../constants.js';
+import { getPluginJson } from '../utils.plugin.js';
 
 describe('Utils / Plugins', () => {
   describe('getPluginJson()', () => {

package/src/utils/tests/utils.templates.test.ts

@@ -1,5 +1,5 @@
-import { PLUGIN_TYPES } from '../../constants';
-import { getTemplateFiles } from '../utils.templates';
+import { PLUGIN_TYPES } from '../../constants.js';
+import { getTemplateFiles } from '../utils.templates.js';
 
 describe('Utils / Templates', () => {
   describe('getTemplateFiles()', () => {

package/src/utils/utils.config.ts

@@ -1,6 +1,6 @@
-import fs from 'fs';
-import path from 'path';
-import { getVersion } from './utils.version';
+import fs from 'node:fs';
+import path from 'node:path';
+import { getVersion } from './utils.version.js';
 
 type FeatureFlags = {
   bundleGrafanaUI: boolean;

package/src/utils/utils.console.ts

@@ -1,7 +1,9 @@
-const { marked } = require('marked');
-const chalk = require('chalk');
-const TerminalRenderer = require('marked-terminal');
-const { Confirm, Select } = require('enquirer');
+import { marked } from 'marked';
+import chalk from 'chalk';
+import TerminalRenderer from 'marked-terminal';
+import Enquirer from 'enquirer';
+
+const { prompt } = Enquirer;
 
 marked.setOptions({
   renderer: new TerminalRenderer({
@@ -29,20 +31,23 @@ export function printError(error: string) {
   console.error(displayAsMarkdown(`\n❌ ${error}`));
 }
 
-export function confirmPrompt(message: string): Promise<boolean> {
-  const prompt = new Confirm({
-    name: 'question',
+export async function confirmPrompt(message: string): Promise<boolean> {
+  const question: Record<string, boolean> = await prompt({
+    name: 'confirmPrompt',
+    type: 'confirm',
     message: displayAsMarkdown(message),
   });
 
-  return prompt.run();
+  return question['confirmPrompt'];
 }
 
-export function selectPrompt(message: string, choices: string[]): Promise<string> {
-  const prompt = new Select({
+export async function selectPrompt(message: string, choices: string[]): Promise<string> {
+  const question: Record<string, string> = await prompt({
+    name: 'selectPrompt',
+    type: 'select',
     choices,
     message: displayAsMarkdown(message),
   });
 
-  return prompt.run();
+  return question['selectPrompt'];
 }

package/src/utils/utils.files.ts

@@ -1,6 +1,6 @@
-import path from 'path';
-import fs from 'fs';
-import { TEMPLATE_PATHS } from '../constants';
+import path from 'node:path';
+import fs from 'node:fs';
+import { TEMPLATE_PATHS } from '../constants.js';
 import { access, constants } from 'fs/promises';
 
 // Removes common template files from the list in case they have a plugin-specific override

package/src/utils/utils.handlebars.ts

@@ -3,9 +3,9 @@ import * as changeCase from 'change-case';
 import titleCase from 'title-case';
 import upperCase from 'upper-case';
 import lowerCase from 'lower-case';
-import { PARTIALS_DIR, PLUGIN_TYPES } from '../constants';
-import { readFileSync, readdirSync } from 'fs';
-import { basename, join } from 'path';
+import { PARTIALS_DIR, PLUGIN_TYPES } from '../constants.js';
+import { readFileSync, readdirSync } from 'node:fs';
+import { basename, join } from 'node:path';
 
 // Why? The `{#if}` expression in Handlebars unfortunately only accepts a boolean, which makes it hard to compare values in templates.
 export const ifEq = (a: any, b: any, options: HelperOptions) => {

package/src/utils/utils.npm.ts

@@ -1,7 +1,7 @@
 import semver from 'semver';
-import { GRAFANA_FE_PACKAGES } from '../constants';
-import { getPackageJson, writePackageJson, getLatestPackageJson } from './utils.packagejson';
-import { PackageManager } from './utils.packageManager';
+import { GRAFANA_FE_PACKAGES } from '../constants.js';
+import { getPackageJson, writePackageJson, getLatestPackageJson } from './utils.packagejson.js';
+import { PackageManager } from './utils.packageManager.js';
 
 type UpdateSummary = Record<string, { prev: string | null; next: string | null }>;
 

package/src/utils/utils.packageManager.ts

@@ -1,7 +1,7 @@
-import { basename } from 'path';
-import { spawnSync } from 'child_process';
+import { basename } from 'node:path';
+import { spawnSync } from 'node:child_process';
 import { sync as findUpSync } from 'find-up';
-import { getPackageJson } from './utils.packagejson';
+import { getPackageJson } from './utils.packagejson.js';
 
 const NPM_LOCKFILE = 'package-lock.json';
 const PNPM_LOCKFILE = 'pnpm-lock.yaml';

package/src/utils/utils.packagejson.ts

@@ -1,8 +1,8 @@
-import path from 'path';
-import { TEMPLATE_PATHS } from '../constants';
-import { readJsonFile } from './utils.files';
-import { getTemplateData, renderTemplateFromFile } from './utils.templates';
-import fs from 'fs';
+import path from 'node:path';
+import { TEMPLATE_PATHS } from '../constants.js';
+import { readJsonFile } from './utils.files.js';
+import { getTemplateData, renderTemplateFromFile } from './utils.templates.js';
+import fs from 'node:fs';
 
 export type PackageJson = {
   scripts: Record<string, string>;

package/src/utils/utils.path.ts

@@ -1,6 +1,6 @@
-import path from 'path';
-import { PLUGIN_TYPES, IS_DEV, DEV_EXPORT_DIR } from '../constants';
-import { normalizeId } from './utils.handlebars';
+import path from 'node:path';
+import { PLUGIN_TYPES, IS_DEV, DEV_EXPORT_DIR } from '../constants.js';
+import { normalizeId } from './utils.handlebars.js';
 
 export function getExportPath(pluginName: string, orgName: string, pluginType: PLUGIN_TYPES): string {
   if (IS_DEV) {

package/src/utils/utils.plugin.ts

@@ -1,9 +1,8 @@
-import path from 'path';
-import { readJsonFile } from './utils.files';
+import path from 'node:path';
+import { readJsonFile } from './utils.files.js';
 
 export function getPluginJson(srcDir?: string) {
   const srcPath = srcDir || path.join(process.cwd(), 'src');
   const pluginJsonPath = path.join(srcPath, 'plugin.json');
-
   return readJsonFile(pluginJsonPath);
 }

package/src/utils/utils.templates.ts

@@ -1,15 +1,15 @@
 import glob from 'glob';
-import path from 'path';
-import fs from 'fs';
+import path from 'node:path';
+import fs from 'node:fs';
 import mkdirp from 'mkdirp';
-import { filterOutCommonFiles, isFile, isFileStartingWith } from './utils.files';
-import { renderHandlebarsTemplate } from './utils.handlebars';
-import { getPluginJson } from './utils.plugin';
-import { TEMPLATE_PATHS, EXPORT_PATH_PREFIX, EXTRA_TEMPLATE_VARIABLES } from '../constants';
-import { getPackageManagerWithFallback } from './utils.packageManager';
-import { getExportFileName } from '../utils/utils.files';
-import { getVersion } from './utils.version';
-import { getConfig } from './utils.config';
+import { filterOutCommonFiles, isFile, isFileStartingWith } from './utils.files.js';
+import { renderHandlebarsTemplate } from './utils.handlebars.js';
+import { getPluginJson } from './utils.plugin.js';
+import { TEMPLATE_PATHS, EXPORT_PATH_PREFIX, EXTRA_TEMPLATE_VARIABLES } from '../constants.js';
+import { getPackageManagerWithFallback } from './utils.packageManager.js';
+import { getExportFileName } from '../utils/utils.files.js';
+import { getVersion } from './utils.version.js';
+import { getConfig } from './utils.config.js';
 
 /**
  *

package/src/utils/utils.version.ts

@@ -1,5 +1,8 @@
-import { readFileSync } from 'fs';
-import { resolve } from 'path';
+import { readFileSync } from 'node:fs';
+import { resolve } from 'node:path';
+import { fileURLToPath } from 'node:url';
+
+const __dirname = fileURLToPath(new URL('.', import.meta.url));
 
 export function getVersion(): string {
   const packageJsonPath = resolve(__dirname, '..', '..', 'package.json');

package/tsconfig.json

@@ -1,5 +1,10 @@
 {
+  "$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

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