@grafana/create-plugin 3.4.0 → 3.6.0-canary.669.68b0597.0

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+# v3.5.0 (Fri Feb 02 2024)
+
+#### 🚀 Enhancement
+
+- Create-plugin: Use react-router v6 by default [#710](https://github.com/grafana/plugin-tools/pull/710) ([@leventebalogh](https://github.com/leventebalogh))
+
+#### Authors: 1
+
+- Levente Balogh ([@leventebalogh](https://github.com/leventebalogh))
+
+---
+
 # v3.4.0 (Fri Feb 02 2024)
 
 :tada: This release contains work from a new contributor! :tada:

package/dist/commands/generate.command.js

@@ -11,7 +11,7 @@ import { getPackageManagerFromUserAgent, getPackageManagerInstallCmd } from '../
 import { getExportPath } from '../utils/utils.path.js';
 import { renderTemplateFromFile } from '../utils/utils.templates.js';
 import { getVersion } from '../utils/utils.version.js';
-import { prettifyFiles } from './generate/prettify-files.js';
+import { prettifyFiles } from '../utils/utils.prettifyFiles.js';
 import { printGenerateSuccessMessage } from './generate/print-success-message.js';
 import { promptUser } from './generate/prompt-user.js';
 import { updateGoSdkAndModules } from './generate/update-go-sdk-and-packages.js';
@@ -36,7 +36,7 @@ export const generate = async (argv) => {
     if (answers.hasBackend) {
         await execPostScaffoldFunction(updateGoSdkAndModules, exportPath);
     }
-    await execPostScaffoldFunction(prettifyFiles, exportPath);
+    await execPostScaffoldFunction(prettifyFiles, { targetPath: exportPath });
     printGenerateSuccessMessage(answers);
 };
 function getTemplateData(answers) {
@@ -47,6 +47,7 @@ function getTemplateData(answers) {
     const { packageManagerName, packageManagerVersion } = getPackageManagerFromUserAgent();
     const packageManagerInstallCmd = getPackageManagerInstallCmd(packageManagerName);
     const isAppType = pluginType === PLUGIN_TYPES.app || pluginType === PLUGIN_TYPES.scenes;
+    const useReactRouterV6 = features.useReactRouterV6 && pluginType === PLUGIN_TYPES.app;
     const templateData = {
         ...answers,
         pluginId,
@@ -57,6 +58,8 @@ function getTemplateData(answers) {
         isNPM: packageManagerName === 'npm',
         version: currentVersion,
         bundleGrafanaUI: features.bundleGrafanaUI,
+        useReactRouterV6,
+        reactRouterVersion: useReactRouterV6 ? '6.22.0' : '5.2.0',
     };
     return templateData;
 }

package/dist/commands/update.command.js

@@ -3,9 +3,10 @@ import { TEXT, UDPATE_CONFIG } from '../constants.js';
 import { compileTemplateFiles, getTemplateData } from '../utils/utils.templates.js';
 import { confirmPrompt, selectPrompt, printMessage, printSuccessMessage, printRedBox } from '../utils/utils.console.js';
 import { updatePackageJson, hasNpmDependenciesToUpdate, getPackageJsonUpdatesAsText, updateNpmScripts, writePackageManagerInPackageJson, } from '../utils/utils.npm.js';
-import { getPackageManagerWithFallback } from '../utils/utils.packageManager.js';
 import { isGitDirectory, isGitDirectoryClean } from '../utils/utils.git.js';
 import { isPluginDirectory } from '../utils/utils.plugin.js';
+import { getPackageManagerWithFallback } from '../utils/utils.packageManager.js';
+import { prettifyFiles } from '../utils/utils.prettifyFiles.js';
 export const update = async (argv) => {
     try {
         if (!(await isGitDirectory()) && !argv.force) {
@@ -38,6 +39,8 @@ In case you want to proceed as is please use the ${chalk.bold('--force')} flag.)
         if (await confirmPrompt(TEXT.updateConfigPrompt)) {
             compileTemplateFiles(UDPATE_CONFIG.filesToOverride, getTemplateData());
             printSuccessMessage(TEXT.overrideFilesSuccess);
+            const prettifyMsg = await prettifyFiles({ targetPath: '.config', projectRoot: '.' });
+            printMessage(prettifyMsg);
         }
         else {
             printMessage(TEXT.overrideFilesAborted);
@@ -78,6 +81,8 @@ In case you want to proceed as is please use the ${chalk.bold('--force')} flag.)
         }
         const packageManager = getPackageManagerWithFallback();
         writePackageManagerInPackageJson(packageManager);
+        const prettifyMsg = await prettifyFiles({ targetPath: '.config', projectRoot: '.' });
+        printMessage(prettifyMsg);
         printSuccessMessage(TEXT.updateCommandSuccess);
     }
     catch (error) {

package/dist/utils/utils.config.js

@@ -51,6 +51,7 @@ function readRCFileSync(path) {
 }
 function createFeatureFlags(flags) {
     return {
+        useReactRouterV6: true,
         bundleGrafanaUI: false,
         ...flags,
     };

package/dist/utils/utils.packagejson.js

@@ -3,8 +3,8 @@ import { TEMPLATE_PATHS } from '../constants.js';
 import { readJsonFile } from './utils.files.js';
 import { getTemplateData, renderTemplateFromFile } from './utils.templates.js';
 import fs from 'node:fs';
-export function getPackageJson() {
-    return readJsonFile(path.join(process.cwd(), 'package.json'));
+export function getPackageJson(rootPath = process.cwd()) {
+    return readJsonFile(path.join(rootPath, 'package.json'));
 }
 export function getLatestPackageJson() {
     const packageJsonPath = path.join(TEMPLATE_PATHS.common, '_package.json');

package/dist/utils/utils.prettifyFiles.js

@@ -0,0 +1,31 @@
+import { exec as nodeExec } from 'node:child_process';
+import { promisify } from 'node:util';
+import fs from 'node:fs';
+import { getPackageJson } from './utils.packagejson.js';
+const exec = promisify(nodeExec);
+export async function prettifyFiles(options) {
+    const targetPath = options.targetPath ?? process.cwd();
+    const projectRoot = options.projectRoot ?? targetPath;
+    if (!isPrettierUsed(projectRoot)) {
+        return 'Prettify skipped, because it is not used in this project.';
+    }
+    if (!fs.existsSync(targetPath)) {
+        return '';
+    }
+    const prettierVersion = getPrettierVersion(projectRoot);
+    try {
+        let command = `npx -y prettier@${prettierVersion} . --write`;
+        await exec(command, { cwd: targetPath });
+    }
+    catch (error) {
+        throw new Error('There was a problem running prettier on the plugin files. Please run `npx -y prettier@2 . --write` manually in your plugin directory.');
+    }
+    return 'Successfully ran prettier against new plugin.';
+}
+function isPrettierUsed(projectRoot) {
+    return Boolean(getPrettierVersion(projectRoot));
+}
+function getPrettierVersion(projectRoot) {
+    const packageJson = getPackageJson(projectRoot);
+    return packageJson.devDependencies?.prettier || packageJson.dependencies?.prettier;
+}

package/dist/utils/utils.templates.js

@@ -5,7 +5,7 @@ import mkdirp from 'mkdirp';
 import { filterOutCommonFiles, isFile, isFileStartingWith } from './utils.files.js';
 import { renderHandlebarsTemplate } from './utils.handlebars.js';
 import { getPluginJson } from './utils.plugin.js';
-import { TEMPLATE_PATHS, EXPORT_PATH_PREFIX, EXTRA_TEMPLATE_VARIABLES } from '../constants.js';
+import { TEMPLATE_PATHS, EXPORT_PATH_PREFIX, EXTRA_TEMPLATE_VARIABLES, PLUGIN_TYPES } from '../constants.js';
 import { getPackageManagerWithFallback } from './utils.packageManager.js';
 import { getExportFileName } from '../utils/utils.files.js';
 import { getVersion } from './utils.version.js';
@@ -69,5 +69,7 @@ export function getTemplateData() {
         packageManagerVersion,
         version: currentVersion,
         bundleGrafanaUI: features.bundleGrafanaUI,
+        useReactRouterV6: features.useReactRouterV6 && pluginJson.type === PLUGIN_TYPES.app,
+        reactRouterVersion: features.useReactRouterV6 ? '6.22.0' : '5.2.0',
     };
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/create-plugin",
-  "version": "3.4.0",
+  "version": "3.6.0-canary.669.68b0597.0",
   "repository": {
     "directory": "packages/create-plugin",
     "url": "https://github.com/grafana/plugin-tools"
@@ -86,5 +86,5 @@
   "engines": {
     "node": ">=20"
   },
-  "gitHead": "750878c5c6952236d376adfec30c35510555eb72"
+  "gitHead": "68b05979a4745baaf52da1de8a5e4c002ecb5ca6"
 }

package/src/commands/generate.command.ts

@@ -12,7 +12,7 @@ import { getPackageManagerFromUserAgent, getPackageManagerInstallCmd } from '../
 import { getExportPath } from '../utils/utils.path.js';
 import { renderTemplateFromFile } from '../utils/utils.templates.js';
 import { getVersion } from '../utils/utils.version.js';
-import { prettifyFiles } from './generate/prettify-files.js';
+import { prettifyFiles } from '../utils/utils.prettifyFiles.js';
 import { printGenerateSuccessMessage } from './generate/print-success-message.js';
 import { promptUser } from './generate/prompt-user.js';
 import { updateGoSdkAndModules } from './generate/update-go-sdk-and-packages.js';
@@ -45,7 +45,7 @@ export const generate = async (argv: minimist.ParsedArgs) => {
   if (answers.hasBackend) {
     await execPostScaffoldFunction(updateGoSdkAndModules, exportPath);
   }
-  await execPostScaffoldFunction(prettifyFiles, exportPath);
+  await execPostScaffoldFunction(prettifyFiles, { targetPath: exportPath });
 
   printGenerateSuccessMessage(answers);
 };
@@ -59,6 +59,7 @@ function getTemplateData(answers: CliArgs) {
   const { packageManagerName, packageManagerVersion } = getPackageManagerFromUserAgent();
   const packageManagerInstallCmd = getPackageManagerInstallCmd(packageManagerName);
   const isAppType = pluginType === PLUGIN_TYPES.app || pluginType === PLUGIN_TYPES.scenes;
+  const useReactRouterV6 = features.useReactRouterV6 && pluginType === PLUGIN_TYPES.app;
   const templateData: TemplateData = {
     ...answers,
     pluginId,
@@ -69,6 +70,8 @@ function getTemplateData(answers: CliArgs) {
     isNPM: packageManagerName === 'npm',
     version: currentVersion,
     bundleGrafanaUI: features.bundleGrafanaUI,
+    useReactRouterV6,
+    reactRouterVersion: useReactRouterV6 ? '6.22.0' : '5.2.0',
   };
 
   return templateData;

package/src/commands/types.ts

@@ -19,4 +19,6 @@ export type TemplateData = {
   isNPM: boolean;
   version: string;
   bundleGrafanaUI: boolean;
+  useReactRouterV6: boolean;
+  reactRouterVersion: string;
 };

package/src/commands/update.command.ts

@@ -10,9 +10,10 @@ import {
   updateNpmScripts,
   writePackageManagerInPackageJson,
 } from '../utils/utils.npm.js';
-import { getPackageManagerWithFallback } from '../utils/utils.packageManager.js';
 import { isGitDirectory, isGitDirectoryClean } from '../utils/utils.git.js';
 import { isPluginDirectory } from '../utils/utils.plugin.js';
+import { getPackageManagerWithFallback } from '../utils/utils.packageManager.js';
+import { prettifyFiles } from '../utils/utils.prettifyFiles.js';
 
 export const update = async (argv: minimist.ParsedArgs) => {
   try {
@@ -58,7 +59,11 @@ In case you want to proceed as is please use the ${chalk.bold('--force')} flag.)
     // -----------------------------------
     if (await confirmPrompt(TEXT.updateConfigPrompt)) {
       compileTemplateFiles(UDPATE_CONFIG.filesToOverride, getTemplateData());
+
       printSuccessMessage(TEXT.overrideFilesSuccess);
+
+      const prettifyMsg = await prettifyFiles({ targetPath: '.config', projectRoot: '.' });
+      printMessage(prettifyMsg);
     } else {
       printMessage(TEXT.overrideFilesAborted);
       process.exit(0);
@@ -110,6 +115,9 @@ In case you want to proceed as is please use the ${chalk.bold('--force')} flag.)
     const packageManager = getPackageManagerWithFallback();
     writePackageManagerInPackageJson(packageManager);
 
+    const prettifyMsg = await prettifyFiles({ targetPath: '.config', projectRoot: '.' });
+    printMessage(prettifyMsg);
+
     // 4. Summary
     // -------------
     printSuccessMessage(TEXT.updateCommandSuccess);

package/src/utils/utils.config.ts

@@ -4,6 +4,10 @@ import { getVersion } from './utils.version.js';
 
 type FeatureFlags = {
   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;
 };
 
 type CreatePluginConfig = UserConfig & {
@@ -66,6 +70,7 @@ function readRCFileSync(path: string): CreatePluginConfig | undefined {
 
 function createFeatureFlags(flags?: FeatureFlags): FeatureFlags {
   return {
+    useReactRouterV6: true,
     bundleGrafanaUI: false,
     ...flags,
   };

package/src/utils/utils.packagejson.ts

@@ -10,8 +10,8 @@ export type PackageJson = {
   devDependencies: Record<string, string>;
   packageManager?: string;
 } & Record<string, any>;
-export function getPackageJson(): PackageJson {
-  return readJsonFile(path.join(process.cwd(), 'package.json'));
+export function getPackageJson(rootPath = process.cwd()): PackageJson {
+  return readJsonFile(path.join(rootPath, 'package.json'));
 }
 
 // Returns with a package.json that is generated based on the latest templates

package/src/utils/utils.prettifyFiles.ts

@@ -0,0 +1,48 @@
+import { exec as nodeExec } from 'node:child_process';
+import { promisify } from 'node:util';
+import fs from 'node:fs';
+import { getPackageJson } from './utils.packagejson.js';
+
+const exec = promisify(nodeExec);
+
+type PrettifyFilesArgs = {
+  // The path where we want to prettify files, defaults to the CWD
+  targetPath?: string;
+
+  // In case the `targetPath` would be set to a subdirectory, e.g. `.config/`. Defaults to `targetPath`.
+  projectRoot?: string;
+};
+
+export async function prettifyFiles(options: PrettifyFilesArgs) {
+  const targetPath = options.targetPath ?? process.cwd();
+  const projectRoot = options.projectRoot ?? targetPath;
+
+  if (!isPrettierUsed(projectRoot)) {
+    return 'Prettify skipped, because it is not used in this project.';
+  }
+
+  if (!fs.existsSync(targetPath)) {
+    return '';
+  }
+
+  const prettierVersion = getPrettierVersion(projectRoot);
+
+  try {
+    let command = `npx -y prettier@${prettierVersion} . --write`;
+    await exec(command, { cwd: targetPath });
+  } catch (error) {
+    throw new Error(
+      'There was a problem running prettier on the plugin files. Please run `npx -y prettier@2 . --write` manually in your plugin directory.'
+    );
+  }
+  return 'Successfully ran prettier against new plugin.';
+}
+
+function isPrettierUsed(projectRoot?: string) {
+  return Boolean(getPrettierVersion(projectRoot));
+}
+
+function getPrettierVersion(projectRoot?: string) {
+  const packageJson = getPackageJson(projectRoot);
+  return packageJson.devDependencies?.prettier || packageJson.dependencies?.prettier;
+}

package/src/utils/utils.templates.ts

@@ -5,7 +5,7 @@ import mkdirp from 'mkdirp';
 import { filterOutCommonFiles, isFile, isFileStartingWith } from './utils.files.js';
 import { renderHandlebarsTemplate } from './utils.handlebars.js';
 import { getPluginJson } from './utils.plugin.js';
-import { TEMPLATE_PATHS, EXPORT_PATH_PREFIX, EXTRA_TEMPLATE_VARIABLES } from '../constants.js';
+import { TEMPLATE_PATHS, EXPORT_PATH_PREFIX, EXTRA_TEMPLATE_VARIABLES, PLUGIN_TYPES } from '../constants.js';
 import { getPackageManagerWithFallback } from './utils.packageManager.js';
 import { getExportFileName } from '../utils/utils.files.js';
 import { getVersion } from './utils.version.js';
@@ -97,5 +97,7 @@ export function getTemplateData() {
     packageManagerVersion,
     version: currentVersion,
     bundleGrafanaUI: features.bundleGrafanaUI,
+    useReactRouterV6: features.useReactRouterV6 && pluginJson.type === PLUGIN_TYPES.app,
+    reactRouterVersion: features.useReactRouterV6 ? '6.22.0' : '5.2.0',
   };
 }

package/templates/app/src/components/App/App.tsx

@@ -1,21 +1,20 @@
 import React from 'react';
-import { Route, Switch } from 'react-router-dom';
+import { Route, Routes } from 'react-router-dom';
 import { AppRootProps } from '@grafana/data';
 import { ROUTES } from '../../constants';
 import { PageFour, PageOne, PageThree, PageTwo } from '../../pages';
-import { prefixRoute } from '../../utils/utils.routing';
 
 export function App(props: AppRootProps) {
   return (
-      <Switch>
-        <Route exact path={prefixRoute(ROUTES.Two)} component={PageTwo} />
-        <Route exact path={prefixRoute(`${ROUTES.Three}/:id?`)} component={PageThree} />
+      <Routes>
+        <Route path={ROUTES.Two} element={<PageTwo />} />
+        <Route path={`${ROUTES.Three}/:id?`} element={<PageThree />} />
 
         {/* Full-width page (this page will have no side navigation) */}
-        <Route exact path={prefixRoute(ROUTES.Four)} component={PageFour} />
+        <Route path={ROUTES.Four} element={<PageFour />} />
 
         {/* Default page */}
-        <Route component={PageOne} />
-      </Switch>
+        <Route path="*" element={<PageOne />} />
+      </Routes>
   );
 }

package/templates/common/.config/webpack/webpack.config.ts

@@ -49,8 +49,8 @@ const config = async (env): Promise<Configuration> => {
       'react-redux',
       'redux',
       'rxjs',
-      'react-router',
-      'react-router-dom',
+      'react-router',{{#unless useReactRouterV6}}
+      'react-router-dom',{{/unless}}
       'd3',
       'angular',{{#unless bundleGrafanaUI}}
       '@grafana/ui',{{/unless}}

package/templates/common/.cprc.json

@@ -2,5 +2,7 @@
   "features": {
     {{#if bundleGrafanaUI}}
     "bundleGrafanaUI": true{{/if}}
+    {{#if useReactRouterV6}}
+    "useReactRouterV6": true{{/if}}
   }
 }

package/templates/common/_package.json

@@ -30,8 +30,8 @@
     "@testing-library/react": "14.0.0",
     "@types/jest": "^29.5.0",
     "@types/lodash": "^4.14.194",
-    "@types/node": "^20.8.7",{{#if isAppType}}
-    "@types/react-router-dom": "^5.3.3",{{/if}}
+    "@types/node": "^20.8.7",{{#unless useReactRouterV6}}
+    "@types/react-router-dom": "^{{ reactRouterVersion }}",{{/unless}}
     "@types/testing-library__jest-dom": "5.14.8",
     "copy-webpack-plugin": "^11.0.0",
     "css-loader": "^6.7.3",
@@ -67,7 +67,7 @@
     "@grafana/scenes": "^1.28.0",{{/if_eq}}
     "react": "18.2.0",
     "react-dom": "18.2.0",{{#if isAppType}}
-    "react-router-dom": "5.3.3",
+    "react-router-dom": "^{{ reactRouterVersion }}",
     "rxjs": "7.8.0",{{/if}}
     "tslib": "2.5.3"
   },

package/dist/commands/generate/prettify-files.js

@@ -1,17 +0,0 @@
-import { exec as nodeExec } from 'node:child_process';
-import { promisify } from 'node:util';
-import fs from 'node:fs';
-const exec = promisify(nodeExec);
-export async function prettifyFiles(exportPath) {
-    if (!fs.existsSync(exportPath)) {
-        return '';
-    }
-    try {
-        let command = 'npx -y prettier@2 . --write';
-        await exec(command, { cwd: exportPath });
-    }
-    catch (error) {
-        throw new Error('There was a problem running prettier on the plugin files. Please run `npx -y prettier@2 . --write` manually in your plugin directory.');
-    }
-    return 'Successfully ran prettier against new plugin.';
-}

package/src/commands/generate/prettify-files.ts

@@ -1,21 +0,0 @@
-import { exec as nodeExec } from 'node:child_process';
-import { promisify } from 'node:util';
-import fs from 'node:fs';
-
-const exec = promisify(nodeExec);
-
-export async function prettifyFiles(exportPath: string) {
-  if (!fs.existsSync(exportPath)) {
-    return '';
-  }
-
-  try {
-    let command = 'npx -y prettier@2 . --write';
-    await exec(command, { cwd: exportPath });
-  } catch (error) {
-    throw new Error(
-      'There was a problem running prettier on the plugin files. Please run `npx -y prettier@2 . --write` manually in your plugin directory.'
-    );
-  }
-  return 'Successfully ran prettier against new plugin.';
-}