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

package/dist/codemods/additions/scripts/example-addition.js

@@ -1,61 +0,0 @@
-import { addDependenciesToPackageJson } from '../../utils.js';
-
-const flags = [
-  {
-    name: "feature-name",
-    description: "Name of the feature to add",
-    required: false
-  },
-  {
-    name: "enabled",
-    description: "Whether the feature should be enabled by default",
-    required: false
-  }
-];
-function parseFlags(argv) {
-  return {
-    featureName: argv["feature-name"] || "myFeature",
-    enabled: argv.enabled === "true" || argv.enabled === true
-  };
-}
-function migrate(context, options = { featureName: "myFeature", enabled: true }) {
-  const { featureName, enabled } = options;
-  const rawPkgJson = context.getFile("./package.json") ?? "{}";
-  const packageJson = JSON.parse(rawPkgJson);
-  if (packageJson.scripts && !packageJson.scripts["example-script"]) {
-    packageJson.scripts["example-script"] = `echo "Running ${featureName}"`;
-    context.updateFile("./package.json", JSON.stringify(packageJson, null, 2));
-  }
-  addDependenciesToPackageJson(context, {}, { "example-dev-dep": "^1.0.0" });
-  if (!context.doesFileExist("./src/config.json")) {
-    const config = {
-      features: {
-        [featureName]: {
-          enabled,
-          description: "Example feature configuration"
-        }
-      }
-    };
-    context.addFile("./src/config.json", JSON.stringify(config, null, 2));
-  }
-  if (!context.doesFileExist(`./src/features/${featureName}.ts`)) {
-    const featureCode = `export const ${featureName} = {
-  name: '${featureName}',
-  enabled: ${enabled},
-  init() {
-    console.log('${featureName} initialized');
-  },
-};
-`;
-    context.addFile(`./src/features/${featureName}.ts`, featureCode);
-  }
-  if (context.doesFileExist("./src/deprecated.ts")) {
-    context.deleteFile("./src/deprecated.ts");
-  }
-  if (context.doesFileExist("./src/old-config.json")) {
-    context.renameFile("./src/old-config.json", "./src/new-config.json");
-  }
-  return context;
-}
-
-export { migrate as default, flags, parseFlags };

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/dist/commands/add.command.js

@@ -1,86 +0,0 @@
-import { runAdditionByName, getAvailableAdditions, getAdditionFlags } from '../codemods/additions/manager.js';
-import { isGitDirectory, isGitDirectoryClean } from '../utils/utils.git.js';
-import { isPluginDirectory } from '../utils/utils.plugin.js';
-import { output } from '../utils/utils.console.js';
-
-const add = async (argv) => {
-  const subCommand = argv._[1];
-  if (!subCommand) {
-    await showAdditionsHelp();
-    process.exit(1);
-  }
-  await performPreAddChecks(argv);
-  try {
-    await runAdditionByName(subCommand, argv);
-  } catch (error) {
-    if (error instanceof Error) {
-      output.error({
-        title: "Addition failed",
-        body: [error.message]
-      });
-    }
-    process.exit(1);
-  }
-};
-async function showAdditionsHelp() {
-  const availableAdditions = getAvailableAdditions();
-  const additionsList = await Promise.all(
-    Object.values(availableAdditions).map(async (addition) => {
-      let info = `${addition.name} - ${addition.description}`;
-      const flags = await getAdditionFlags(addition);
-      if (flags.length > 0) {
-        const flagDocs = flags.map((flag) => {
-          const req = flag.required ? " (required)" : " (optional)";
-          return `  --${flag.name}: ${flag.description}${req}`;
-        });
-        info += "\n" + flagDocs.join("\n");
-      }
-      return info;
-    })
-  );
-  output.error({
-    title: "No addition specified",
-    body: [
-      "Usage: npx @grafana/create-plugin add <addition-name> [options]",
-      "",
-      "Available additions:",
-      ...output.bulletList(additionsList)
-    ]
-  });
-}
-async function performPreAddChecks(argv) {
-  if (!await isGitDirectory() && !argv.force) {
-    output.error({
-      title: "You are not inside a git directory",
-      body: [
-        `In order to proceed please run ${output.formatCode("git init")} in the root of your project and commit your changes.`,
-        `(This check is necessary to make sure that the changes are easy to revert and don't interfere with any changes you currently have.`,
-        `In case you want to proceed as is please use the ${output.formatCode("--force")} flag.)`
-      ]
-    });
-    process.exit(1);
-  }
-  if (!await isGitDirectoryClean() && !argv.force) {
-    output.error({
-      title: "Please clean your repository working tree before adding features.",
-      body: [
-        "Commit your changes or stash them.",
-        `(This check is necessary to make sure that the changes are easy to revert and don't mess with any changes you currently have.`,
-        `In case you want to proceed as is please use the ${output.formatCode("--force")} flag.)`
-      ]
-    });
-    process.exit(1);
-  }
-  if (!isPluginDirectory() && !argv.force) {
-    output.error({
-      title: "Are you inside a plugin directory?",
-      body: [
-        `We couldn't find a "src/plugin.json" file under your current directory.`,
-        `(Please make sure to run this command from the root of your plugin folder. In case you want to proceed as is please use the ${output.formatCode("--force")} flag.)`
-      ]
-    });
-    process.exit(1);
-  }
-}
-
-export { add };

package/src/codemods/additions/additions.ts

@@ -1,23 +0,0 @@
-export type AdditionMeta<TFeatureName extends string = string> = {
-  name: string;
-  description: string;
-  scriptPath: string;
-  featureName: TFeatureName;
-};
-
-const additions = {
-  i18n: {
-    name: 'i18n',
-    description: 'Add internationalization (i18n) support to your plugin',
-    scriptPath: './scripts/add-i18n.js',
-    featureName: 'i18nEnabled',
-  },
-};
-
-export default { additions };
-
-// extract feature names for type-safe FeatureFlags in utils.config.ts
-type AdditionValues = (typeof additions)[keyof typeof additions];
-export type AdditionFeatureName = AdditionValues['featureName'];
-
-export type TypedAdditionMeta = AdditionMeta<AdditionFeatureName>;

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/scripts/example-addition.test.ts

@@ -1,111 +0,0 @@
-import { describe, expect, it } from 'vitest';
-
-import { Context } from '../../context.js';
-import migrate from './example-addition.js';
-
-describe('example-addition', () => {
-  it('should be idempotent', async () => {
-    const context = new Context('/virtual');
-
-    // Set up a minimal project structure
-    context.addFile('package.json', JSON.stringify({ scripts: {}, dependencies: {}, devDependencies: {} }));
-    context.addFile('src/index.ts', 'export const foo = "bar";');
-
-    const migrateWithOptions = (ctx: Context) => migrate(ctx, { featureName: 'testFeature', enabled: true });
-    await expect(migrateWithOptions).toBeIdempotent(context);
-  });
-
-  it('should add example script to package.json', () => {
-    const context = new Context('/virtual');
-
-    context.addFile('package.json', JSON.stringify({ scripts: {}, dependencies: {}, devDependencies: {} }));
-
-    const result = migrate(context, { featureName: 'testFeature', enabled: true });
-
-    const packageJson = JSON.parse(result.getFile('package.json') || '{}');
-    expect(packageJson.scripts['example-script']).toBe('echo "Running testFeature"');
-  });
-
-  it('should add dev dependency', () => {
-    const context = new Context('/virtual');
-
-    context.addFile('package.json', JSON.stringify({ scripts: {}, dependencies: {}, devDependencies: {} }));
-
-    const result = migrate(context, { featureName: 'myFeature', enabled: false });
-
-    const packageJson = JSON.parse(result.getFile('package.json') || '{}');
-    expect(packageJson.devDependencies['example-dev-dep']).toBe('^1.0.0');
-  });
-
-  it('should create config file with feature settings', () => {
-    const context = new Context('/virtual');
-
-    context.addFile('package.json', JSON.stringify({ scripts: {}, dependencies: {}, devDependencies: {} }));
-
-    const result = migrate(context, { featureName: 'coolFeature', enabled: true });
-
-    expect(result.doesFileExist('src/config.json')).toBe(true);
-    const config = JSON.parse(result.getFile('src/config.json') || '{}');
-    expect(config.features.coolFeature).toEqual({
-      enabled: true,
-      description: 'Example feature configuration',
-    });
-  });
-
-  it('should create feature TypeScript file', () => {
-    const context = new Context('/virtual');
-
-    context.addFile('package.json', JSON.stringify({ scripts: {}, dependencies: {}, devDependencies: {} }));
-
-    const result = migrate(context, { featureName: 'myFeature', enabled: false });
-
-    expect(result.doesFileExist('src/features/myFeature.ts')).toBe(true);
-    const featureCode = result.getFile('src/features/myFeature.ts');
-    expect(featureCode).toContain('export const myFeature');
-    expect(featureCode).toContain('enabled: false');
-    expect(featureCode).toContain('myFeature initialized');
-  });
-
-  it('should delete deprecated file if it exists', () => {
-    const context = new Context('/virtual');
-
-    context.addFile('package.json', JSON.stringify({ scripts: {}, dependencies: {}, devDependencies: {} }));
-    context.addFile('src/deprecated.ts', 'export const old = true;');
-
-    const result = migrate(context, { featureName: 'testFeature', enabled: true });
-
-    expect(result.doesFileExist('src/deprecated.ts')).toBe(false);
-  });
-
-  it('should rename old-config.json if it exists', () => {
-    const context = new Context('/virtual');
-
-    context.addFile('package.json', JSON.stringify({ scripts: {}, dependencies: {}, devDependencies: {} }));
-    context.addFile('src/old-config.json', JSON.stringify({ old: true }));
-
-    const result = migrate(context, { featureName: 'testFeature', enabled: true });
-
-    expect(result.doesFileExist('src/old-config.json')).toBe(false);
-    expect(result.doesFileExist('src/new-config.json')).toBe(true);
-    const newConfig = JSON.parse(result.getFile('src/new-config.json') || '{}');
-    expect(newConfig.old).toBe(true);
-  });
-
-  it('should not add script if it already exists', () => {
-    const context = new Context('/virtual');
-
-    context.addFile(
-      'package.json',
-      JSON.stringify({
-        scripts: { 'example-script': 'existing command' },
-        dependencies: {},
-        devDependencies: {},
-      })
-    );
-
-    const result = migrate(context, { featureName: 'testFeature', enabled: true });
-
-    const packageJson = JSON.parse(result.getFile('package.json') || '{}');
-    expect(packageJson.scripts['example-script']).toBe('existing command');
-  });
-});

package/src/codemods/additions/scripts/example-addition.ts

@@ -1,79 +0,0 @@
-import type { Context } from '../../context.js';
-import type { FlagDefinition } from '../../types.js';
-import { addDependenciesToPackageJson } from '../../utils.js';
-
-export type ExampleOptions = {
-  featureName: string;
-  enabled: boolean;
-};
-
-export const flags: FlagDefinition[] = [
-  {
-    name: 'feature-name',
-    description: 'Name of the feature to add',
-    required: false,
-  },
-  {
-    name: 'enabled',
-    description: 'Whether the feature should be enabled by default',
-    required: false,
-  },
-];
-
-export function parseFlags(argv: any): ExampleOptions {
-  return {
-    featureName: argv['feature-name'] || 'myFeature',
-    enabled: argv.enabled === 'true' || argv.enabled === true,
-  };
-}
-
-export default function migrate(
-  context: Context,
-  options: ExampleOptions = { featureName: 'myFeature', enabled: true }
-): Context {
-  const { featureName, enabled } = options;
-
-  const rawPkgJson = context.getFile('./package.json') ?? '{}';
-  const packageJson = JSON.parse(rawPkgJson);
-
-  if (packageJson.scripts && !packageJson.scripts['example-script']) {
-    packageJson.scripts['example-script'] = `echo "Running ${featureName}"`;
-    context.updateFile('./package.json', JSON.stringify(packageJson, null, 2));
-  }
-
-  addDependenciesToPackageJson(context, {}, { 'example-dev-dep': '^1.0.0' });
-
-  if (!context.doesFileExist('./src/config.json')) {
-    const config = {
-      features: {
-        [featureName]: {
-          enabled,
-          description: 'Example feature configuration',
-        },
-      },
-    };
-    context.addFile('./src/config.json', JSON.stringify(config, null, 2));
-  }
-
-  if (!context.doesFileExist(`./src/features/${featureName}.ts`)) {
-    const featureCode = `export const ${featureName} = {
-  name: '${featureName}',
-  enabled: ${enabled},
-  init() {
-    console.log('${featureName} initialized');
-  },
-};
-`;
-    context.addFile(`./src/features/${featureName}.ts`, featureCode);
-  }
-
-  if (context.doesFileExist('./src/deprecated.ts')) {
-    context.deleteFile('./src/deprecated.ts');
-  }
-
-  if (context.doesFileExist('./src/old-config.json')) {
-    context.renameFile('./src/old-config.json', './src/new-config.json');
-  }
-
-  return context;
-}

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);
-}

package/src/codemods/types.ts

@@ -1,21 +0,0 @@
-import type { Context } from './context.js';
-
-export interface CodemodModule {
-  default: (context: Context) => Context | Promise<Context>;
-}
-
-export interface FlagDefinition {
-  name: string;
-  description: string;
-  required: boolean;
-}
-
-export interface AdditionModule<TOptions = any> extends CodemodModule {
-  default: (context: Context, options?: TOptions) => Context | Promise<Context>;
-  flags?: FlagDefinition[];
-  parseFlags?: (argv: any) => TOptions;
-}
-
-export interface MigrationModule extends CodemodModule {
-  default: (context: Context) => Context | Promise<Context>;
-}

package/src/commands/add.command.ts

@@ -1,97 +0,0 @@
-import { getAdditionFlags, getAvailableAdditions, runAdditionByName } from '../codemods/additions/manager.js';
-import { isGitDirectory, isGitDirectoryClean } from '../utils/utils.git.js';
-
-import { isPluginDirectory } from '../utils/utils.plugin.js';
-import minimist from 'minimist';
-import { output } from '../utils/utils.console.js';
-
-export const add = async (argv: minimist.ParsedArgs) => {
-  const subCommand = argv._[1];
-
-  if (!subCommand) {
-    await showAdditionsHelp();
-    process.exit(1);
-  }
-
-  await performPreAddChecks(argv);
-
-  try {
-    await runAdditionByName(subCommand, argv);
-  } catch (error) {
-    if (error instanceof Error) {
-      output.error({
-        title: 'Addition failed',
-        body: [error.message],
-      });
-    }
-    process.exit(1);
-  }
-};
-
-async function showAdditionsHelp() {
-  const availableAdditions = getAvailableAdditions();
-  const additionsList = await Promise.all(
-    Object.values(availableAdditions).map(async (addition) => {
-      let info = `${addition.name} - ${addition.description}`;
-      const flags = await getAdditionFlags(addition);
-      if (flags.length > 0) {
-        const flagDocs = flags.map((flag) => {
-          const req = flag.required ? ' (required)' : ' (optional)';
-          return `  --${flag.name}: ${flag.description}${req}`;
-        });
-        info += '\n' + flagDocs.join('\n');
-      }
-      return info;
-    })
-  );
-
-  output.error({
-    title: 'No addition specified',
-    body: [
-      'Usage: npx @grafana/create-plugin add <addition-name> [options]',
-      '',
-      'Available additions:',
-      ...output.bulletList(additionsList),
-    ],
-  });
-}
-
-async function performPreAddChecks(argv: minimist.ParsedArgs) {
-  if (!(await isGitDirectory()) && !argv.force) {
-    output.error({
-      title: 'You are not inside a git directory',
-      body: [
-        `In order to proceed please run ${output.formatCode('git init')} in the root of your project and commit your changes.`,
-        `(This check is necessary to make sure that the changes are easy to revert and don't interfere with any changes you currently have.`,
-        `In case you want to proceed as is please use the ${output.formatCode('--force')} flag.)`,
-      ],
-    });
-
-    process.exit(1);
-  }
-
-  if (!(await isGitDirectoryClean()) && !argv.force) {
-    output.error({
-      title: 'Please clean your repository working tree before adding features.',
-      body: [
-        'Commit your changes or stash them.',
-        `(This check is necessary to make sure that the changes are easy to revert and don't mess with any changes you currently have.`,
-        `In case you want to proceed as is please use the ${output.formatCode('--force')} flag.)`,
-      ],
-    });
-
-    process.exit(1);
-  }
-
-  if (!isPluginDirectory() && !argv.force) {
-    output.error({
-      title: 'Are you inside a plugin directory?',
-      body: [
-        `We couldn't find a "src/plugin.json" file under your current directory.`,
-        `(Please make sure to run this command from the root of your plugin folder. In case you want to proceed as is please use the ${output.formatCode('--force')} flag.)`,
-      ],
-    });
-
-    process.exit(1);
-  }
-}