@grafana/create-plugin 6.5.0-canary.2320.20227367050.0 → 6.5.0-canary.2320.20231018478.0

package/dist/codemods/additions/scripts/i18n/config-updates.js

@@ -1,7 +1,10 @@
 import { coerce, gte } from 'semver';
 import { parseDocument, stringify } from 'yaml';
+import * as recast from 'recast';
+import * as typeScriptParser from 'recast/parsers/typescript.js';
 import { additionsDebug } from '../../../utils.js';
 
+const { builders } = recast.types;
 function updateDockerCompose(context) {
   if (!context.doesFileExist("docker-compose.yaml")) {
     additionsDebug("docker-compose.yaml not found, skipping");
@@ -109,5 +112,159 @@ export default defineConfig({
     additionsDebug("Error creating i18next.config.ts:", error);
   }
 }
+function addI18nextToExternalsArray(externalsArray) {
+  const hasI18next = externalsArray.elements.some((element) => {
+    if (element && (element.type === "Literal" || element.type === "StringLiteral") && typeof element.value === "string") {
+      return element.value === "i18next";
+    }
+    return false;
+  });
+  if (hasI18next) {
+    additionsDebug("'i18next' already in externals array");
+    return false;
+  }
+  let insertIndex = -1;
+  for (let i = 0; i < externalsArray.elements.length; i++) {
+    const element = externalsArray.elements[i];
+    if (element && (element.type === "Literal" || element.type === "StringLiteral") && element.value === "rxjs") {
+      insertIndex = i + 1;
+      break;
+    }
+  }
+  if (insertIndex === -1) {
+    for (let i = externalsArray.elements.length - 1; i >= 0; i--) {
+      const element = externalsArray.elements[i];
+      if (element && element.type !== "FunctionExpression" && element.type !== "ArrowFunctionExpression") {
+        insertIndex = i + 1;
+        break;
+      }
+    }
+    if (insertIndex === -1) {
+      insertIndex = externalsArray.elements.length;
+    }
+  }
+  externalsArray.elements.splice(insertIndex, 0, builders.literal("i18next"));
+  additionsDebug(`Added 'i18next' to externals array at position ${insertIndex}`);
+  return true;
+}
+function ensureI18nextExternal(context) {
+  try {
+    additionsDebug("Checking for externals configuration...");
+    const externalsPath = ".config/bundler/externals.ts";
+    if (context.doesFileExist(externalsPath)) {
+      additionsDebug(`Found ${externalsPath}, checking for i18next...`);
+      const externalsContent = context.getFile(externalsPath);
+      if (externalsContent) {
+        try {
+          const ast = recast.parse(externalsContent, {
+            parser: typeScriptParser
+          });
+          let hasChanges = false;
+          recast.visit(ast, {
+            visitVariableDeclarator(path) {
+              const { node } = path;
+              if (node.id.type === "Identifier" && node.id.name === "externals" && node.init && node.init.type === "ArrayExpression") {
+                additionsDebug("Found externals array in externals.ts");
+                if (addI18nextToExternalsArray(node.init)) {
+                  hasChanges = true;
+                }
+              }
+              return this.traverse(path);
+            }
+          });
+          if (hasChanges) {
+            const output = recast.print(ast, {
+              tabWidth: 2,
+              trailingComma: true,
+              lineTerminator: "\n"
+            });
+            context.updateFile(externalsPath, output.code);
+            additionsDebug(`Updated ${externalsPath} with i18next external`);
+          }
+          return;
+        } catch (error) {
+          additionsDebug(`Error updating ${externalsPath}:`, error);
+        }
+      }
+    }
+    const webpackConfigPath = ".config/webpack/webpack.config.ts";
+    additionsDebug(`Checking for ${webpackConfigPath}...`);
+    if (context.doesFileExist(webpackConfigPath)) {
+      additionsDebug(`Found ${webpackConfigPath}, checking for inline externals...`);
+      const webpackContent = context.getFile(webpackConfigPath);
+      if (webpackContent) {
+        try {
+          const ast = recast.parse(webpackContent, {
+            parser: typeScriptParser
+          });
+          let hasChanges = false;
+          let foundExternals = false;
+          recast.visit(ast, {
+            visitObjectExpression(path) {
+              const { node } = path;
+              const properties = node.properties;
+              if (properties) {
+                for (const prop of properties) {
+                  if (prop && (prop.type === "Property" || prop.type === "ObjectProperty")) {
+                    const key = "key" in prop ? prop.key : null;
+                    const value = "value" in prop ? prop.value : null;
+                    if (key && key.type === "Identifier" && key.name === "externals" && value && value.type === "ArrayExpression") {
+                      foundExternals = true;
+                      additionsDebug("Found externals property in webpack.config.ts");
+                      if (addI18nextToExternalsArray(value)) {
+                        hasChanges = true;
+                      }
+                    }
+                  }
+                }
+              }
+              return this.traverse(path);
+            },
+            visitProperty(path) {
+              const { node } = path;
+              if (node.key && node.key.type === "Identifier" && node.key.name === "externals" && node.value && node.value.type === "ArrayExpression") {
+                if (!foundExternals) {
+                  foundExternals = true;
+                  additionsDebug("Found externals property in webpack.config.ts (via visitProperty)");
+                }
+                if (addI18nextToExternalsArray(node.value)) {
+                  hasChanges = true;
+                }
+              }
+              return this.traverse(path);
+            }
+          });
+          if (!foundExternals) {
+            additionsDebug("No externals property found in webpack.config.ts");
+          }
+          if (hasChanges) {
+            const output = recast.print(ast, {
+              tabWidth: 2,
+              trailingComma: true,
+              lineTerminator: "\n"
+            });
+            context.updateFile(webpackConfigPath, output.code);
+            additionsDebug(`Updated ${webpackConfigPath} with i18next external`);
+          } else if (foundExternals) {
+            additionsDebug("i18next already present in externals, no changes needed");
+          }
+          return;
+        } catch (error) {
+          additionsDebug(`Error updating ${webpackConfigPath}:`, error);
+          additionsDebug(`Error details: ${error instanceof Error ? error.message : String(error)}`);
+        }
+      } else {
+        additionsDebug(`File ${webpackConfigPath} exists but content is empty`);
+      }
+    } else {
+      additionsDebug(`File ${webpackConfigPath} does not exist`);
+    }
+    additionsDebug("No externals configuration found, skipping i18next external check");
+  } catch (error) {
+    additionsDebug(
+      `Unexpected error in ensureI18nextExternal: ${error instanceof Error ? error.message : String(error)}`
+    );
+  }
+}
 
-export { createI18nextConfig, updateDockerCompose, updatePluginJson };
+export { createI18nextConfig, ensureI18nextExternal, updateDockerCompose, updatePluginJson };

package/dist/codemods/additions/scripts/i18n/index.js

@@ -1,6 +1,6 @@
 import * as v from 'valibot';
 import { additionsDebug } from '../../../utils.js';
-import { updateDockerCompose, updatePluginJson, createI18nextConfig } from './config-updates.js';
+import { updateDockerCompose, updatePluginJson, createI18nextConfig, ensureI18nextExternal } from './config-updates.js';
 import { addI18nInitialization, createLoadResourcesFile } from './code-generation.js';
 import { addI18nDependency, addSemverDependency, updateEslintConfig, addI18nextCli } from './tooling.js';
 import { checkNeedsBackwardCompatibility, createLocaleFiles } from './utils.js';
@@ -43,6 +43,11 @@ function i18nAddition(context, options) {
   }
   addI18nextCli(context);
   createI18nextConfig(context);
+  try {
+    ensureI18nextExternal(context);
+  } catch (error) {
+    additionsDebug(`Error ensuring i18next external: ${error instanceof Error ? error.message : String(error)}`);
+  }
   return context;
 }
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/create-plugin",
-  "version": "6.5.0-canary.2320.20227367050.0",
+  "version": "6.5.0-canary.2320.20231018478.0",
   "repository": {
     "directory": "packages/create-plugin",
     "url": "https://github.com/grafana/plugin-tools"
@@ -56,5 +56,5 @@
   "engines": {
     "node": ">=20"
   },
-  "gitHead": "d76c5b7a65c1d44699de403e8692e51e129df9f0"
+  "gitHead": "2c9b13a41672a1b9e24a92b61a39533bcee266a6"
 }

package/src/codemods/additions/scripts/i18n/config-updates.ts

@@ -1,9 +1,13 @@
 import { coerce, gte } from 'semver';
 import { parseDocument, stringify } from 'yaml';
+import * as recast from 'recast';
+import * as typeScriptParser from 'recast/parsers/typescript.js';
 
 import type { Context } from '../../../context.js';
 import { additionsDebug } from '../../../utils.js';
 
+const { builders } = recast.types;
+
 export function updateDockerCompose(context: Context): void {
   if (!context.doesFileExist('docker-compose.yaml')) {
     additionsDebug('docker-compose.yaml not found, skipping');
@@ -137,3 +141,221 @@ export default defineConfig({
     additionsDebug('Error creating i18next.config.ts:', error);
   }
 }
+
+/**
+ * Adds 'i18next' to an externals array if it's not already present
+ * @returns true if changes were made, false otherwise
+ */
+function addI18nextToExternalsArray(externalsArray: recast.types.namedTypes.ArrayExpression): boolean {
+  // Check if 'i18next' is already in the array
+  const hasI18next = externalsArray.elements.some((element) => {
+    if (
+      element &&
+      (element.type === 'Literal' || element.type === 'StringLiteral') &&
+      typeof element.value === 'string'
+    ) {
+      return element.value === 'i18next';
+    }
+    return false;
+  });
+
+  if (hasI18next) {
+    additionsDebug("'i18next' already in externals array");
+    return false;
+  }
+
+  // Find the position after 'rxjs' to insert 'i18next'
+  let insertIndex = -1;
+  for (let i = 0; i < externalsArray.elements.length; i++) {
+    const element = externalsArray.elements[i];
+    if (element && (element.type === 'Literal' || element.type === 'StringLiteral') && element.value === 'rxjs') {
+      insertIndex = i + 1;
+      break;
+    }
+  }
+
+  // If 'rxjs' not found, append to the end (before the function at the end)
+  if (insertIndex === -1) {
+    // Find the last non-function element
+    for (let i = externalsArray.elements.length - 1; i >= 0; i--) {
+      const element = externalsArray.elements[i];
+      if (element && element.type !== 'FunctionExpression' && element.type !== 'ArrowFunctionExpression') {
+        insertIndex = i + 1;
+        break;
+      }
+    }
+    // If still not found, append at the end
+    if (insertIndex === -1) {
+      insertIndex = externalsArray.elements.length;
+    }
+  }
+
+  // Insert 'i18next' at the found position
+  externalsArray.elements.splice(insertIndex, 0, builders.literal('i18next'));
+  additionsDebug(`Added 'i18next' to externals array at position ${insertIndex}`);
+  return true;
+}
+
+export function ensureI18nextExternal(context: Context): void {
+  try {
+    additionsDebug('Checking for externals configuration...');
+
+    // Try new structure first: .config/bundler/externals.ts
+    const externalsPath = '.config/bundler/externals.ts';
+    if (context.doesFileExist(externalsPath)) {
+      additionsDebug(`Found ${externalsPath}, checking for i18next...`);
+      const externalsContent = context.getFile(externalsPath);
+      if (externalsContent) {
+        try {
+          const ast = recast.parse(externalsContent, {
+            parser: typeScriptParser,
+          });
+
+          let hasChanges = false;
+
+          // Find the externals array
+          recast.visit(ast, {
+            visitVariableDeclarator(path) {
+              const { node } = path;
+
+              if (
+                node.id.type === 'Identifier' &&
+                node.id.name === 'externals' &&
+                node.init &&
+                node.init.type === 'ArrayExpression'
+              ) {
+                additionsDebug('Found externals array in externals.ts');
+                if (addI18nextToExternalsArray(node.init)) {
+                  hasChanges = true;
+                }
+              }
+
+              return this.traverse(path);
+            },
+          });
+
+          // Only update the file if we made changes
+          if (hasChanges) {
+            const output = recast.print(ast, {
+              tabWidth: 2,
+              trailingComma: true,
+              lineTerminator: '\n',
+            });
+            context.updateFile(externalsPath, output.code);
+            additionsDebug(`Updated ${externalsPath} with i18next external`);
+          }
+          return;
+        } catch (error) {
+          additionsDebug(`Error updating ${externalsPath}:`, error);
+        }
+      }
+    }
+
+    // Fall back to legacy structure: .config/webpack/webpack.config.ts with inline externals
+    const webpackConfigPath = '.config/webpack/webpack.config.ts';
+    additionsDebug(`Checking for ${webpackConfigPath}...`);
+    if (context.doesFileExist(webpackConfigPath)) {
+      additionsDebug(`Found ${webpackConfigPath}, checking for inline externals...`);
+      const webpackContent = context.getFile(webpackConfigPath);
+      if (webpackContent) {
+        try {
+          const ast = recast.parse(webpackContent, {
+            parser: typeScriptParser,
+          });
+
+          let hasChanges = false;
+          let foundExternals = false;
+
+          // Find the externals property in the Configuration object
+          // It can be in baseConfig or any variable with an object initializer
+          recast.visit(ast, {
+            visitObjectExpression(path) {
+              const { node } = path;
+              const properties = node.properties;
+
+              if (properties) {
+                for (const prop of properties) {
+                  // Handle both Property and ObjectProperty types
+                  if (prop && (prop.type === 'Property' || prop.type === 'ObjectProperty')) {
+                    const key = 'key' in prop ? prop.key : null;
+                    const value = 'value' in prop ? prop.value : null;
+
+                    if (
+                      key &&
+                      key.type === 'Identifier' &&
+                      key.name === 'externals' &&
+                      value &&
+                      value.type === 'ArrayExpression'
+                    ) {
+                      foundExternals = true;
+                      additionsDebug('Found externals property in webpack.config.ts');
+                      if (addI18nextToExternalsArray(value)) {
+                        hasChanges = true;
+                      }
+                      // Don't break, continue to check all object expressions
+                    }
+                  }
+                }
+              }
+
+              return this.traverse(path);
+            },
+            visitProperty(path) {
+              const { node } = path;
+
+              // Also check properties directly (fallback)
+              if (
+                node.key &&
+                node.key.type === 'Identifier' &&
+                node.key.name === 'externals' &&
+                node.value &&
+                node.value.type === 'ArrayExpression'
+              ) {
+                if (!foundExternals) {
+                  foundExternals = true;
+                  additionsDebug('Found externals property in webpack.config.ts (via visitProperty)');
+                }
+                if (addI18nextToExternalsArray(node.value)) {
+                  hasChanges = true;
+                }
+              }
+
+              return this.traverse(path);
+            },
+          });
+
+          if (!foundExternals) {
+            additionsDebug('No externals property found in webpack.config.ts');
+          }
+
+          // Only update the file if we made changes
+          if (hasChanges) {
+            const output = recast.print(ast, {
+              tabWidth: 2,
+              trailingComma: true,
+              lineTerminator: '\n',
+            });
+            context.updateFile(webpackConfigPath, output.code);
+            additionsDebug(`Updated ${webpackConfigPath} with i18next external`);
+          } else if (foundExternals) {
+            additionsDebug('i18next already present in externals, no changes needed');
+          }
+          return;
+        } catch (error) {
+          additionsDebug(`Error updating ${webpackConfigPath}:`, error);
+          additionsDebug(`Error details: ${error instanceof Error ? error.message : String(error)}`);
+        }
+      } else {
+        additionsDebug(`File ${webpackConfigPath} exists but content is empty`);
+      }
+    } else {
+      additionsDebug(`File ${webpackConfigPath} does not exist`);
+    }
+
+    additionsDebug('No externals configuration found, skipping i18next external check');
+  } catch (error) {
+    additionsDebug(
+      `Unexpected error in ensureI18nextExternal: ${error instanceof Error ? error.message : String(error)}`
+    );
+  }
+}

package/src/codemods/additions/scripts/i18n/index.ts

@@ -2,7 +2,7 @@ import * as v from 'valibot';
 
 import type { Context } from '../../../context.js';
 import { additionsDebug } from '../../../utils.js';
-import { updateDockerCompose, updatePluginJson, createI18nextConfig } from './config-updates.js';
+import { updateDockerCompose, updatePluginJson, createI18nextConfig, ensureI18nextExternal } from './config-updates.js';
 import { addI18nInitialization, createLoadResourcesFile } from './code-generation.js';
 import { updateEslintConfig, addI18nDependency, addSemverDependency, addI18nextCli } from './tooling.js';
 import { checkNeedsBackwardCompatibility, createLocaleFiles } from './utils.js';
@@ -77,5 +77,12 @@ export default function i18nAddition(context: Context, options: I18nOptions): Co
   // 10. Create i18next.config.ts
   createI18nextConfig(context);
 
+  // 11. Ensure i18next is in externals array
+  try {
+    ensureI18nextExternal(context);
+  } catch (error) {
+    additionsDebug(`Error ensuring i18next external: ${error instanceof Error ? error.message : String(error)}`);
+  }
+
   return context;
 }