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

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

@@ -0,0 +1,61 @@
+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/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/create-plugin",
-  "version": "6.2.0-canary.2233.19097561440.0",
+  "version": "6.2.0-canary.2233.19133609453.0",
   "repository": {
     "directory": "packages/create-plugin",
     "url": "https://github.com/grafana/plugin-tools"
@@ -59,5 +59,5 @@
   "engines": {
     "node": ">=20"
   },
-  "gitHead": "51cedf8d3738d2ca2401063cd1cae3f06140ce63"
+  "gitHead": "d84f5bcb2be40efa1f28ad4a86b52a8a1566e85c"
 }

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

@@ -0,0 +1,111 @@
+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

@@ -0,0 +1,79 @@
+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;
+}