@grafana/create-plugin 6.2.0-canary.2233.18936706437.0 → 6.2.0-canary.2233.18946524692.0

package/README.md

@@ -122,45 +122,6 @@ For more information see our [documentation](https://grafana.com/developers/plug
 
 ---
 
-## Add optional features to your existing plugin
-
-You can add optional features to your plugin using the `add` command. This allows you to enhance your plugin with additional capabilities without starting from scratch.
-
-### Add internationalization (i18n) support
-
-Add translation support to make your plugin available in multiple languages:
-
-```bash
-# Run this command from the root of your plugin
-cd ./my-plugin
-
-npx @grafana/create-plugin@latest add i18n
-```
-
-This will:
-
-- Update your `plugin.json` with the selected languages
-- Create locale folders and translation files
-- Add the necessary dependencies to `package.json`
-- Configure your docker-compose.yaml with the required feature toggle
-- Add i18n imports to your module file
-- Set up the i18n extraction script
-
-The command will prompt you to select which locales you want to support. You can choose from common locales like:
-
-- English (US) - `en-US`
-- Spanish (Spain) - `es-ES`
-- French (France) - `fr-FR`
-- German (Germany) - `de-DE`
-- Swedish (Sweden) - `sv-SE`
-- And more...
-
-You can also add custom locale codes during the interactive prompt.
-
-For more information about plugin internationalization, see our [documentation](https://grafana.com/developers/plugin-tools/how-to-guides/plugin-internationalization).
-
----
-
 ## Contributing
 
 We are always grateful for contributions! See [CONTRIBUTING.md](../../CONTRIBUTING.md) for more information.

package/dist/additions/additions.js

@@ -1,11 +1,11 @@
-var defaultAdditions = {
-  additions: {
-    i18n: {
-      name: "i18n",
-      description: "Add internationalization (i18n) support to your plugin",
-      scriptPath: "./scripts/add-i18n.js"
-    }
+const additions = {
+  i18n: {
+    name: "i18n",
+    description: "Add internationalization (i18n) support to your plugin",
+    scriptPath: "./scripts/add-i18n.js",
+    featureName: "i18nEnabled"
   }
 };
+var defaultAdditions = { additions };
 
 export { defaultAdditions as default };

package/dist/additions/manager.js

@@ -1,5 +1,6 @@
 import { additionsDebug, printChanges } from './utils.js';
 import defaultAdditions from './additions.js';
+import { getConfig, isFeatureEnabled, setFeatureFlag } from '../utils/utils.config.js';
 import { Context } from '../migrations/context.js';
 import { gitCommitNoVerify } from '../utils/utils.git.js';
 import { output } from '../utils/utils.console.js';
@@ -70,6 +71,14 @@ Available additions: ${additionsList.join(", ")}`);
 }
 async function runAddition(addition, additionOptions = {}, runOptions = {}) {
   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]
@@ -84,6 +93,8 @@ async function runAddition(addition, additionOptions = {}, runOptions = {}) {
     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`);
     if (shouldCommit) {
       await gitCommitNoVerify(`chore: add ${addition.name} support via create-plugin`);
     }

package/dist/utils/utils.config.js

@@ -1,13 +1,16 @@
 import { argv, commandName } from './utils.cli.js';
 import { CURRENT_APP_VERSION } from './utils.version.js';
 import { DEFAULT_FEATURE_FLAGS } from '../constants.js';
+import { EOL } from 'node:os';
 import fs from 'node:fs';
 import { output } from './utils.console.js';
 import { partitionArr } from './utils.helpers.js';
 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);
@@ -92,5 +95,17 @@ 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, setRootConfig };
+export { getConfig, isFeatureEnabled, setFeatureFlag, setRootConfig };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/create-plugin",
-  "version": "6.2.0-canary.2233.18936706437.0",
+  "version": "6.2.0-canary.2233.18946524692.0",
   "repository": {
     "directory": "packages/create-plugin",
     "url": "https://github.com/grafana/plugin-tools"
@@ -61,5 +61,5 @@
   "engines": {
     "node": ">=20"
   },
-  "gitHead": "ada28e0f4004af9bf39d6350ab5a47dd35459365"
+  "gitHead": "66533b5a682753ffda37f33a185e8fa2fe2c8383"
 }

package/src/additions/additions.ts

@@ -1,15 +1,22 @@
-export type AdditionMeta = {
+export type AdditionMeta<TFeatureName extends string = string> = {
   name: string;
   description: string;
   scriptPath: string;
+  featureName: TFeatureName;
 };
 
-export default {
-  additions: {
-    i18n: {
-      name: 'i18n',
-      description: 'Add internationalization (i18n) support to your plugin',
-      scriptPath: './scripts/add-i18n.js',
-    },
+const additions = {
+  i18n: {
+    name: 'i18n',
+    description: 'Add internationalization (i18n) support to your plugin',
+    scriptPath: './scripts/add-i18n.js',
+    featureName: 'i18nEnabled',
   },
 };
+
+export default { additions };
+
+type AdditionValues = (typeof additions)[keyof typeof additions];
+export type AdditionFeatureName = AdditionValues['featureName'];
+
+export type TypedAdditionMeta = AdditionMeta<AdditionFeatureName>;

package/src/additions/manager.ts

@@ -1,5 +1,6 @@
 import { additionsDebug, flushChanges, formatFiles, installNPMDependencies, printChanges } from './utils.js';
 import defaultAdditions, { AdditionMeta } from './additions.js';
+import { getConfig, isFeatureEnabled, setFeatureFlag } from '../utils/utils.config.js';
 
 import { Context } from '../migrations/context.js';
 import { gitCommitNoVerify } from '../utils/utils.git.js';
@@ -100,6 +101,16 @@ export async function runAddition(
 ): 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],
@@ -119,6 +130,9 @@ export async function runAddition(
 
     installNPMDependencies(updatedContext);
 
+    await setFeatureFlag(addition.featureName, true);
+    additionsDebug(`Set feature flag '${addition.featureName}' to true in .cprc.json`);
+
     if (shouldCommit) {
       await gitCommitNoVerify(`chore: add ${addition.name} support via create-plugin`);
     }

package/src/utils/utils.config.ts

@@ -1,24 +1,36 @@
 import { argv, commandName } from './utils.cli.js';
 
+import type { AdditionFeatureName } from '../additions/additions.js';
 import { CURRENT_APP_VERSION } from './utils.version.js';
 import { DEFAULT_FEATURE_FLAGS } from '../constants.js';
+import { EOL } from 'node:os';
 import fs from 'node:fs';
 import { output } from './utils.console.js';
 import { partitionArr } from './utils.helpers.js';
 import path from 'node:path';
 import { writeFile } from 'node:fs/promises';
-import { EOL } from 'node:os';
 
-export type FeatureFlags = {
+type CoreFeatureFlags = {
   bundleGrafanaUI?: boolean;
 
   // If set to true, the plugin will be scaffolded with React Router v6. Defaults to true.
   // (Attention! We always scaffold new projects with React Router v6, so if you are changing this to `false` manually you will need to make changes to the React code as well.)
   useReactRouterV6?: boolean;
+  usePlaywright?: boolean;
   useExperimentalRspack?: boolean;
   useExperimentalUpdates?: boolean;
 };
 
+type AdditionFeatureFlags = {
+  [K in AdditionFeatureName]?: boolean;
+};
+
+export type FeatureFlags = CoreFeatureFlags & AdditionFeatureFlags;
+
+export function isFeatureEnabled(features: FeatureFlags, featureName: string): boolean {
+  return features[featureName as AdditionFeatureName] === true;
+}
+
 export type CreatePluginConfig = UserConfig & {
   version: string;
 };
@@ -132,3 +144,18 @@ export async function setRootConfig(configOverride: Partial<CreatePluginConfig>
 
   return updatedConfig;
 }
+
+export async function setFeatureFlag(featureName: string, enabled = true): Promise<void> {
+  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);
+}