@grafana/create-plugin 6.2.0-canary.2233.19133609453.0 → 6.2.0-canary.2233.19424871609.0

package/vitest.config.ts

@@ -9,5 +9,17 @@ export default mergeConfig(
       root: resolve(__dirname),
       setupFiles: ['./vitest.setup.ts'],
     },
+    plugins: [
+      // This plugin is used to convince Vitest the mocked virtual migrations exist.
+      // https://vitest.dev/guide/mocking/modules.html#mocking-non-existing-module
+      {
+        name: 'virtual-migrations',
+        resolveId(id) {
+          if (id === 'virtual-test-migration.js' || id === 'virtual-test-migration2.js') {
+            return id;
+          }
+        },
+      },
+    ],
   })
 );

package/dist/codemods/additions/manager.js

@@ -1,115 +0,0 @@
-import { additionsDebug, printChanges } from './utils.js';
-import defaultAdditions from './additions.js';
-import { formatFiles, flushChanges, installNPMDependencies } from '../utils.js';
-import { getConfig, isFeatureEnabled, setFeatureFlag } from '../../utils/utils.config.js';
-import { Context } from '../context.js';
-import { output } from '../../utils/utils.console.js';
-
-function getAvailableAdditions(additions = defaultAdditions.additions) {
-  return additions;
-}
-function getAdditionByName(name, additions = defaultAdditions.additions) {
-  return additions[name];
-}
-async function loadAdditionModule(addition) {
-  try {
-    const module = await import(addition.scriptPath);
-    return module;
-  } catch (error) {
-    additionsDebug('Failed to load addition module for "%s" from %s: %O', addition.name, addition.scriptPath, error);
-    return null;
-  }
-}
-async function getAdditionFlags(addition) {
-  const module = await loadAdditionModule(addition);
-  return module?.flags || [];
-}
-async function parseAdditionFlags(addition, argv) {
-  const module = await loadAdditionModule(addition);
-  if (module?.parseFlags) {
-    return module.parseFlags(argv);
-  }
-  return {};
-}
-async function validateAdditionOptions(addition, options) {
-  const flags = await getAdditionFlags(addition);
-  if (!flags || flags.length === 0) {
-    return;
-  }
-  const missingFlags = [];
-  for (const flag of flags) {
-    if (flag.required) {
-      const value = options[flag.name];
-      if (value === void 0 || value === null || Array.isArray(value) && value.length === 0) {
-        missingFlags.push(flag.name);
-      }
-    }
-  }
-  if (missingFlags.length > 0) {
-    const flagDocs = flags.filter((f) => missingFlags.includes(f.name)).map((f) => `  --${f.name}: ${f.description}`);
-    throw new Error(
-      `Missing required flag${missingFlags.length > 1 ? "s" : ""}:
-
-` + flagDocs.join("\n") + `
-
-Example: npx @grafana/create-plugin add ${addition.name} --${missingFlags[0]}=value`
-    );
-  }
-}
-async function runAdditionByName(additionName, argv) {
-  const addition = getAdditionByName(additionName);
-  if (!addition) {
-    const availableAdditions = getAvailableAdditions();
-    const additionsList = Object.keys(availableAdditions);
-    throw new Error(`Unknown addition: ${additionName}
-
-Available additions: ${additionsList.join(", ")}`);
-  }
-  const options = await parseAdditionFlags(addition, argv);
-  await validateAdditionOptions(addition, options);
-  await runAddition(addition, options);
-}
-async function runAddition(addition, additionOptions = {}) {
-  const basePath = process.cwd();
-  const config = getConfig();
-  if (isFeatureEnabled(config.features, addition.featureName)) {
-    output.log({
-      title: `Addition '${addition.name}' is already enabled`,
-      body: [`The feature flag '${addition.featureName}' is already set to true in .cprc.json.`, "No changes needed."]
-    });
-    return;
-  }
-  output.log({
-    title: `Running addition: ${addition.name}`,
-    body: [addition.description]
-  });
-  try {
-    const context = new Context(basePath);
-    const updatedContext = await executeAddition(addition, context, additionOptions);
-    additionsDebug(`context for "${addition.name} (${addition.scriptPath})":`);
-    additionsDebug("%O", updatedContext.listChanges());
-    await formatFiles(updatedContext);
-    flushChanges(updatedContext);
-    printChanges(updatedContext, addition.name, addition);
-    installNPMDependencies(updatedContext);
-    await setFeatureFlag(addition.featureName, true);
-    additionsDebug(`Set feature flag '${addition.featureName}' to true in .cprc.json`);
-    output.success({
-      title: `Successfully added ${addition.name} to your plugin.`
-    });
-  } catch (error) {
-    if (error instanceof Error) {
-      throw new Error(`Error running addition "${addition.name} (${addition.scriptPath})": ${error.message}`);
-    }
-    throw error;
-  }
-}
-async function executeAddition(addition, context, options = {}) {
-  const module = await loadAdditionModule(addition);
-  if (!module) {
-    throw new Error(`Failed to load addition module for ${addition.name}`);
-  }
-  return module.default(context, options);
-}
-
-export { executeAddition, getAdditionByName, getAdditionFlags, getAvailableAdditions, parseAdditionFlags, runAddition, runAdditionByName };

package/dist/codemods/additions/utils.js

@@ -1,10 +0,0 @@
-import { debug } from '../../utils/utils.cli.js';
-import { printChanges as printChanges$1 } from '../utils.js';
-
-const additionsDebug = debug.extend("additions");
-function printChanges(context, key, addition) {
-  additionsDebug("printChanges for addition: %s", key);
-  printChanges$1(context, key, addition);
-}
-
-export { additionsDebug, printChanges };

package/dist/codemods/migrations/utils.js

@@ -1,10 +0,0 @@
-import { debug } from '../../utils/utils.cli.js';
-import { printChanges as printChanges$1 } from '../utils.js';
-
-const migrationsDebug = debug.extend("migrations");
-function printChanges(context, key, migration) {
-  migrationsDebug("printChanges for migration: %s", key);
-  printChanges$1(context, key, migration);
-}
-
-export { migrationsDebug, printChanges };

package/src/codemods/additions/manager.ts

@@ -1,145 +0,0 @@
-import type { AdditionModule, FlagDefinition } from '../types.js';
-import { additionsDebug, printChanges } from './utils.js';
-import defaultAdditions, { AdditionMeta } from './additions.js';
-import { flushChanges, formatFiles, installNPMDependencies } from '../utils.js';
-import { getConfig, isFeatureEnabled, setFeatureFlag } from '../../utils/utils.config.js';
-
-import { Context } from '../context.js';
-import { output } from '../../utils/utils.console.js';
-
-export type AdditionOptions = Record<string, any>;
-
-export function getAvailableAdditions(
-  additions: Record<string, AdditionMeta> = defaultAdditions.additions
-): Record<string, AdditionMeta> {
-  return additions;
-}
-
-export function getAdditionByName(
-  name: string,
-  additions: Record<string, AdditionMeta> = defaultAdditions.additions
-): AdditionMeta | undefined {
-  return additions[name];
-}
-
-async function loadAdditionModule(addition: AdditionMeta): Promise<AdditionModule | null> {
-  try {
-    const module = (await import(addition.scriptPath)) as AdditionModule;
-    return module;
-  } catch (error) {
-    additionsDebug('Failed to load addition module for "%s" from %s: %O', addition.name, addition.scriptPath, error);
-    return null;
-  }
-}
-
-export async function getAdditionFlags(addition: AdditionMeta): Promise<FlagDefinition[]> {
-  const module = await loadAdditionModule(addition);
-  return module?.flags || [];
-}
-
-export async function parseAdditionFlags(addition: AdditionMeta, argv: any): Promise<AdditionOptions> {
-  const module = await loadAdditionModule(addition);
-  if (module?.parseFlags) {
-    return module.parseFlags(argv);
-  }
-  return {};
-}
-
-async function validateAdditionOptions(addition: AdditionMeta, options: AdditionOptions): Promise<void> {
-  const flags = await getAdditionFlags(addition);
-
-  if (!flags || flags.length === 0) {
-    return;
-  }
-
-  const missingFlags: string[] = [];
-
-  for (const flag of flags) {
-    if (flag.required) {
-      const value = options[flag.name];
-      if (value === undefined || value === null || (Array.isArray(value) && value.length === 0)) {
-        missingFlags.push(flag.name);
-      }
-    }
-  }
-
-  if (missingFlags.length > 0) {
-    const flagDocs = flags.filter((f) => missingFlags.includes(f.name)).map((f) => `  --${f.name}: ${f.description}`);
-
-    throw new Error(
-      `Missing required flag${missingFlags.length > 1 ? 's' : ''}:\n\n` +
-        flagDocs.join('\n') +
-        `\n\nExample: npx @grafana/create-plugin add ${addition.name} --${missingFlags[0]}=value`
-    );
-  }
-}
-
-export async function runAdditionByName(additionName: string, argv: any): Promise<void> {
-  const addition = getAdditionByName(additionName);
-  if (!addition) {
-    const availableAdditions = getAvailableAdditions();
-    const additionsList = Object.keys(availableAdditions);
-    throw new Error(`Unknown addition: ${additionName}\n\nAvailable additions: ${additionsList.join(', ')}`);
-  }
-
-  const options = await parseAdditionFlags(addition, argv);
-  await validateAdditionOptions(addition, options);
-  await runAddition(addition, options);
-}
-
-export async function runAddition(addition: AdditionMeta, additionOptions: AdditionOptions = {}): Promise<void> {
-  const basePath = process.cwd();
-
-  // Check if the feature is already enabled
-  const config = getConfig();
-  if (isFeatureEnabled(config.features, addition.featureName)) {
-    output.log({
-      title: `Addition '${addition.name}' is already enabled`,
-      body: [`The feature flag '${addition.featureName}' is already set to true in .cprc.json.`, 'No changes needed.'],
-    });
-    return;
-  }
-
-  output.log({
-    title: `Running addition: ${addition.name}`,
-    body: [addition.description],
-  });
-
-  try {
-    const context = new Context(basePath);
-    const updatedContext = await executeAddition(addition, context, additionOptions);
-
-    additionsDebug(`context for "${addition.name} (${addition.scriptPath})":`);
-    additionsDebug('%O', updatedContext.listChanges());
-
-    await formatFiles(updatedContext);
-    flushChanges(updatedContext);
-    printChanges(updatedContext, addition.name, addition);
-
-    installNPMDependencies(updatedContext);
-
-    await setFeatureFlag(addition.featureName, true);
-    additionsDebug(`Set feature flag '${addition.featureName}' to true in .cprc.json`);
-
-    output.success({
-      title: `Successfully added ${addition.name} to your plugin.`,
-    });
-  } catch (error) {
-    if (error instanceof Error) {
-      throw new Error(`Error running addition "${addition.name} (${addition.scriptPath})": ${error.message}`);
-    }
-    throw error;
-  }
-}
-
-export async function executeAddition(
-  addition: AdditionMeta,
-  context: Context,
-  options: AdditionOptions = {}
-): Promise<Context> {
-  const module = await loadAdditionModule(addition);
-  if (!module) {
-    throw new Error(`Failed to load addition module for ${addition.name}`);
-  }
-  return module.default(context, options);
-}

package/src/codemods/additions/utils.ts

@@ -1,12 +0,0 @@
-import type { AdditionMeta } from './additions.js';
-import type { Context } from '../context.js';
-import { debug } from '../../utils/utils.cli.js';
-import { printChanges as sharedPrintChanges } from '../utils.js';
-
-export const additionsDebug = debug.extend('additions');
-
-// addition-specific wrapper for printChanges.
-export function printChanges(context: Context, key: string, addition: AdditionMeta) {
-  additionsDebug('printChanges for addition: %s', key);
-  sharedPrintChanges(context, key, addition);
-}

package/src/codemods/migrations/utils.ts

@@ -1,12 +0,0 @@
-import type { Context } from '../context.js';
-import type { MigrationMeta } from './migrations.js';
-import { debug } from '../../utils/utils.cli.js';
-import { printChanges as sharedPrintChanges } from '../utils.js';
-
-export const migrationsDebug = debug.extend('migrations');
-
-// migration-specific wrapper for printChanges
-export function printChanges(context: Context, key: string, migration: MigrationMeta) {
-  migrationsDebug('printChanges for migration: %s', key);
-  sharedPrintChanges(context, key, migration);
-}