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

package/dist/utils/utils.checks.js

@@ -0,0 +1,40 @@
+import { isGitDirectory, isGitDirectoryClean } from './utils.git.js';
+import { isPluginDirectory } from './utils.plugin.js';
+import { output } from './utils.console.js';
+
+async function performPreCodemodChecks(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 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 making changes.",
+      body: [
+        "Commit your changes or stash them.",
+        `(This check is necessary to make sure that 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 { performPreCodemodChecks };

package/dist/utils/utils.config.js

@@ -8,9 +8,6 @@ import path from 'node:path';
 import { writeFile } from 'node:fs/promises';
 import { EOL } from 'node:os';
 
-function isFeatureEnabled(features, featureName) {
-  return features[featureName] === true;
-}
 let hasShownConfigWarnings = false;
 function getConfig(workDir = process.cwd()) {
   const rootConfig = getRootConfig(workDir);
@@ -95,17 +92,5 @@ async function setRootConfig(configOverride = {}) {
   await writeFile(rootConfigPath, JSON.stringify(updatedConfig, null, 2) + EOL);
   return updatedConfig;
 }
-async function setFeatureFlag(featureName, enabled = true) {
-  const userConfig = getUserConfig() || { features: {} };
-  const userConfigPath = path.resolve(process.cwd(), ".cprc.json");
-  const updatedConfig = {
-    ...userConfig,
-    features: {
-      ...userConfig.features,
-      [featureName]: enabled
-    }
-  };
-  await writeFile(userConfigPath, JSON.stringify(updatedConfig, null, 2) + EOL);
-}
 
-export { getConfig, isFeatureEnabled, setFeatureFlag, setRootConfig };
+export { getConfig, setRootConfig };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/create-plugin",
-  "version": "6.2.0-canary.2233.19133609453.0",
+  "version": "6.2.0-canary.2233.19424871609.0",
   "repository": {
     "directory": "packages/create-plugin",
     "url": "https://github.com/grafana/plugin-tools"
@@ -38,6 +38,7 @@
     "recast": "^0.23.11",
     "semver": "^7.3.5",
     "title-case": "^4.3.0",
+    "valibot": "^1.1.0",
     "which": "^5.0.0",
     "yaml": "^2.7.0"
   },
@@ -59,5 +60,5 @@
   "engines": {
     "node": ">=20"
   },
-  "gitHead": "d84f5bcb2be40efa1f28ad4a86b52a8a1566e85c"
+  "gitHead": "0b0b05e102a885fb4fb16588c6cfbd0f0b69392f"
 }

package/src/codemods/additions/additions.test.ts

@@ -0,0 +1,12 @@
+import defaultAdditions from './additions.js';
+
+describe('additions json', () => {
+  // as addition scripts are imported dynamically when add is run we assert the path is valid
+  defaultAdditions.forEach((addition) => {
+    it(`should have a valid addition script path for ${addition.name}`, () => {
+      expect(async () => {
+        await import(addition.scriptPath);
+      }).not.toThrow();
+    });
+  });
+});

package/src/codemods/additions/additions.ts

@@ -1,23 +1,9 @@
-export type AdditionMeta<TFeatureName extends string = string> = {
-  name: string;
-  description: string;
-  scriptPath: string;
-  featureName: TFeatureName;
-};
+import { Codemod } from '../types.js';
 
-const additions = {
-  i18n: {
-    name: 'i18n',
-    description: 'Add internationalization (i18n) support to your plugin',
-    scriptPath: './scripts/add-i18n.js',
-    featureName: 'i18nEnabled',
+export default [
+  {
+    name: 'example-addition',
+    description: 'Example addition demonstrating Valibot schema with type inference',
+    scriptPath: import.meta.resolve('./scripts/example-addition.js'),
   },
-};
-
-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>;
+] satisfies Codemod[];

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

@@ -4,23 +4,12 @@ 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 result = migrate(context, { featureName: 'testFeature', enabled: true, frameworks: ['react'] });
 
     const packageJson = JSON.parse(result.getFile('package.json') || '{}');
     expect(packageJson.scripts['example-script']).toBe('echo "Running testFeature"');
@@ -31,39 +20,31 @@ describe('example-addition', () => {
 
     context.addFile('package.json', JSON.stringify({ scripts: {}, dependencies: {}, devDependencies: {} }));
 
-    const result = migrate(context, { featureName: 'myFeature', enabled: false });
+    const result = migrate(context, { featureName: 'myFeature', enabled: false, frameworks: ['react'] });
 
     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', () => {
+  it('should create feature TypeScript file with options', () => {
     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',
+    const result = migrate(context, {
+      featureName: 'myFeature',
+      enabled: false,
+      port: 4000,
+      frameworks: ['react', 'vue'],
     });
-  });
-
-  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');
+    expect(featureCode).toContain('port: 4000');
+    expect(featureCode).toContain('frameworks: ["react","vue"]');
+    expect(featureCode).toContain('myFeature initialized on port 4000');
   });
 
   it('should delete deprecated file if it exists', () => {
@@ -72,7 +53,7 @@ describe('example-addition', () => {
     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 });
+    const result = migrate(context, { featureName: 'testFeature', enabled: true, frameworks: ['react'] });
 
     expect(result.doesFileExist('src/deprecated.ts')).toBe(false);
   });
@@ -83,7 +64,7 @@ describe('example-addition', () => {
     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 });
+    const result = migrate(context, { featureName: 'testFeature', enabled: true, frameworks: ['react'] });
 
     expect(result.doesFileExist('src/old-config.json')).toBe(false);
     expect(result.doesFileExist('src/new-config.json')).toBe(true);
@@ -103,7 +84,7 @@ describe('example-addition', () => {
       })
     );
 
-    const result = migrate(context, { featureName: 'testFeature', enabled: true });
+    const result = migrate(context, { featureName: 'testFeature', enabled: true, frameworks: ['react'] });
 
     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,37 +1,30 @@
+import * as v from 'valibot';
 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;
+/**
+ * Example addition demonstrating Valibot schema with type inference
+ * Schema defines validation rules, defaults and types are automatically inferred
+ */
+export const schema = v.object({
+  featureName: v.pipe(
+    v.string(),
+    v.minLength(3, 'Feature name must be at least 3 characters'),
+    v.maxLength(50, 'Feature name must be at most 50 characters')
+  ),
+  enabled: v.optional(v.boolean(), true),
+  port: v.optional(
+    v.pipe(v.number(), v.minValue(1000, 'Port must be at least 1000'), v.maxValue(65535, 'Port must be at most 65535'))
+  ),
+  frameworks: v.optional(v.array(v.string()), ['react']),
+});
+
+// Type is automatically inferred from the schema
+type ExampleOptions = v.InferOutput<typeof schema>;
+
+export default function exampleAddition(context: Context, options: ExampleOptions): Context {
+  // These options have been validated by the framework
+  const { featureName, enabled, port, frameworks } = options;
 
   const rawPkgJson = context.getFile('./package.json') ?? '{}';
   const packageJson = JSON.parse(rawPkgJson);
@@ -43,24 +36,14 @@ export default function migrate(
 
   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},
+  port: ${port ?? 3000},
+  frameworks: ${JSON.stringify(frameworks)},
   init() {
-    console.log('${featureName} initialized');
+    console.log('${featureName} initialized on port ${port ?? 3000}');
   },
 };
 `;

package/src/codemods/migrations/fixtures/migrations.ts

@@ -1,19 +1,20 @@
-export default {
-  migrations: {
-    'migration-key1': {
-      version: '5.0.0',
-      description: 'Update project to use new cache directory',
-      migrationScript: './5-0-0-cache-directory.js',
-    },
-    'migration-key2': {
-      version: '5.4.0',
-      description: 'Update project to use new cache directory',
-      migrationScript: './5-4-0-cache-directory.js',
-    },
-    'migration-key3': {
-      version: '6.0.0',
-      description: 'Update project to use new cache directory',
-      migrationScript: './5-4-0-cache-directory.js',
-    },
+export default [
+  {
+    name: 'migration-key1',
+    version: '5.0.0',
+    description: 'Update project to use new cache directory',
+    scriptPath: './5-0-0-cache-directory.js',
   },
-};
+  {
+    name: 'migration-key2',
+    version: '5.4.0',
+    description: 'Update project to use new cache directory',
+    scriptPath: './5-4-0-cache-directory.js',
+  },
+  {
+    name: 'migration-key3',
+    version: '6.0.0',
+    description: 'Update project to use new cache directory',
+    scriptPath: './5-4-0-cache-directory.js',
+  },
+];

package/src/codemods/migrations/manager.test.ts

@@ -1,24 +1,23 @@
-import { flushChanges, formatFiles } from '../utils.js';
-import { getMigrationsToRun, runMigration, runMigrations } from './manager.js';
+import { flushChanges, formatFiles, printChanges } from '../utils.js';
+import { getMigrationsToRun, runMigrations } from './manager.js';
 
 import { Context } from '../context.js';
-import { MigrationMeta } from './migrations.js';
+import { Migration } from './migrations.js';
 import { gitCommitNoVerify } from '../../utils/utils.git.js';
 import migrationFixtures from './fixtures/migrations.js';
-import { printChanges } from './utils.js';
 import { setRootConfig } from '../../utils/utils.config.js';
 import { vi } from 'vitest';
 
-vi.mock('./utils.js', () => ({
-  printChanges: vi.fn(),
-  migrationsDebug: vi.fn(),
-}));
-
-vi.mock('../utils.js', () => ({
-  flushChanges: vi.fn(),
-  formatFiles: vi.fn(),
-  installNPMDependencies: vi.fn(),
-}));
+vi.mock('../utils.js', async (importOriginal) => {
+  const actual = (await importOriginal()) as any;
+  return {
+    ...actual,
+    flushChanges: vi.fn(),
+    formatFiles: vi.fn(),
+    installNPMDependencies: vi.fn(),
+    printChanges: vi.fn(),
+  };
+});
 
 // Silence terminal output during tests.
 vi.mock('../../utils/utils.console.js', () => ({
@@ -50,92 +49,83 @@ describe('Migrations', () => {
     it('should return the migrations that need to be run', () => {
       const fromVersion = '3.0.0';
       const toVersion = '5.0.0';
-      const migrations = getMigrationsToRun(fromVersion, toVersion, migrationFixtures.migrations);
-      expect(migrations).toEqual({
-        'migration-key1': {
+      const migrations = getMigrationsToRun(fromVersion, toVersion, migrationFixtures);
+      expect(migrations).toEqual([
+        {
+          name: 'migration-key1',
           version: '5.0.0',
           description: 'Update project to use new cache directory',
-          migrationScript: './5-0-0-cache-directory.js',
+          scriptPath: './5-0-0-cache-directory.js',
         },
-      });
+      ]);
 
       const fromVersion2 = '5.0.0';
       const toVersion2 = '5.5.0';
-      const migrations2 = getMigrationsToRun(fromVersion2, toVersion2, migrationFixtures.migrations);
-      expect(migrations2).toEqual({
-        'migration-key1': {
+      const migrations2 = getMigrationsToRun(fromVersion2, toVersion2, migrationFixtures);
+      expect(migrations2).toEqual([
+        {
+          name: 'migration-key1',
           version: '5.0.0',
           description: 'Update project to use new cache directory',
-          migrationScript: './5-0-0-cache-directory.js',
+          scriptPath: './5-0-0-cache-directory.js',
         },
-        'migration-key2': {
+        {
+          name: 'migration-key2',
           version: '5.4.0',
           description: 'Update project to use new cache directory',
-          migrationScript: './5-4-0-cache-directory.js',
+          scriptPath: './5-4-0-cache-directory.js',
         },
-      });
+      ]);
 
       const fromVersion3 = '5.5.0';
       const toVersion3 = '6.0.0';
-      const migrations3 = getMigrationsToRun(fromVersion3, toVersion3, migrationFixtures.migrations);
-      expect(migrations3).toEqual({
-        'migration-key3': {
+      const migrations3 = getMigrationsToRun(fromVersion3, toVersion3, migrationFixtures);
+      expect(migrations3).toEqual([
+        {
+          name: 'migration-key3',
           version: '6.0.0',
           description: 'Update project to use new cache directory',
-          migrationScript: './5-4-0-cache-directory.js',
+          scriptPath: './5-4-0-cache-directory.js',
         },
-      });
+      ]);
     });
 
     it('should sort migrations by version', () => {
       const fromVersion = '2.0.0';
       const toVersion = '6.0.0';
-      const migrations = getMigrationsToRun(fromVersion, toVersion, {
-        'migration-key1': {
+      const migrations = getMigrationsToRun(fromVersion, toVersion, [
+        {
+          name: 'migration-key1',
           version: '5.3.0',
           description: 'Update project to use new cache directory',
-          migrationScript: './5.3.0-migration.js',
+          scriptPath: './5.3.0-migration.js',
         },
-        'migration-key2': {
+        {
+          name: 'migration-key2',
           version: '2.3.0',
           description: 'Update project to use new cache directory',
-          migrationScript: './2.3.0-migration.js',
+          scriptPath: './2.3.0-migration.js',
         },
-        'migration-key3': {
+        {
+          name: 'migration-key3',
           version: '2.0.0',
           description: 'Update project to use new cache directory',
-          migrationScript: './2.0.0-migration.js',
+          scriptPath: './2.0.0-migration.js',
         },
-        'migration-key4': {
+        {
+          name: 'migration-key4',
           version: '2.0.0',
           description: 'Update project to use new cache directory',
-          migrationScript: './2.0.0-migration.js',
+          scriptPath: './2.0.0-migration.js',
         },
-      });
-
-      expect(Object.keys(migrations)).toEqual(['migration-key3', 'migration-key4', 'migration-key2', 'migration-key1']);
-    });
-  });
-
-  describe('runMigration', () => {
-    it('should pass a context to the migration script', async () => {
-      const mockContext = new Context('/virtual');
-      const migrationFn = vi.fn().mockResolvedValue(mockContext);
-
-      vi.doMock('./test-migration.js', () => ({
-        default: migrationFn,
-      }));
-
-      const migration: MigrationMeta = {
-        version: '1.0.0',
-        description: 'test migration',
-        migrationScript: './test-migration.js',
-      };
-
-      const result = await runMigration(migration, mockContext);
-
-      expect(migrationFn).toHaveBeenCalledWith(mockContext);
-      expect(result).toBe(mockContext);
+      ]);
+
+      expect(migrations.map((m) => m.name)).toEqual([
+        'migration-key3',
+        'migration-key4',
+        'migration-key2',
+        'migration-key1',
+      ]);
     });
   });
 
@@ -144,25 +134,27 @@ describe('Migrations', () => {
     const migrationTwoFn = vi.fn();
     const consoleMock = vi.spyOn(console, 'log').mockImplementation(() => undefined);
 
-    vi.doMock('./migration-one.js', () => ({
+    vi.doMock('virtual-test-migration.js', async () => ({
       default: migrationOneFn,
     }));
-    vi.doMock('./migration-two.js', () => ({
+    vi.doMock('virtual-test-migration2.js', async () => ({
       default: migrationTwoFn,
     }));
 
-    const migrations: Record<string, MigrationMeta> = {
-      'migration-one': {
+    const migrations: Migration[] = [
+      {
+        name: 'migration-one',
         version: '1.0.0',
         description: '...',
-        migrationScript: './migration-one.js',
+        scriptPath: 'virtual-test-migration.js',
       },
-      'migration-two': {
+      {
+        name: 'migration-two',
         version: '1.2.0',
         description: '...',
-        migrationScript: './migration-two.js',
+        scriptPath: 'virtual-test-migration2.js',
       },
-    };
+    ];
 
     beforeEach(() => {
       migrationOneFn.mockImplementation(async (context: Context) => {
@@ -208,6 +200,7 @@ describe('Migrations', () => {
     it('should commit the changes for each migration if the CLI arg is present', async () => {
       await runMigrations(migrations, { commitEachMigration: true });
 
+      // 2 migration commits + 1 version update commit = 3 total
       expect(gitCommitNoVerify).toHaveBeenCalledTimes(3);
     });
 
@@ -216,6 +209,7 @@ describe('Migrations', () => {
 
       await runMigrations(migrations, { commitEachMigration: true });
 
+      // 1 migration commit (only migration-one has changes) + 1 version update commit = 2 total
       expect(gitCommitNoVerify).toHaveBeenCalledTimes(2);
     });