@grafana/create-plugin 3.3.0 → 3.5.0

package/CHANGELOG.md

@@ -1,3 +1,36 @@
+# 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:
+
+Thank you, Nicolas Ventura ([@6nv](https://github.com/6nv)), for all your work!
+
+#### 🚀 Enhancement
+
+- Update create-plugin workflow action versions [#711](https://github.com/grafana/plugin-tools/pull/711) ([@6nv](https://github.com/6nv))
+
+#### 🐛 Bug Fix
+
+- Fix broken livereload injection when using Grafana 10.2.3 [#696](https://github.com/grafana/plugin-tools/pull/696) ([@samjewell](https://github.com/samjewell))
+
+#### Authors: 2
+
+- Nicolas Ventura ([@6nv](https://github.com/6nv))
+- Sam Jewell ([@samjewell](https://github.com/samjewell))
+
+---
+
 # v3.3.0 (Fri Feb 02 2024)
 
 #### 🚀 Enhancement

package/dist/commands/generate.command.js

@@ -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/utils/utils.config.js

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

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.3.0",
+  "version": "3.5.0",
   "repository": {
     "directory": "packages/create-plugin",
     "url": "https://github.com/grafana/plugin-tools"
@@ -86,5 +86,5 @@
   "engines": {
     "node": ">=20"
   },
-  "gitHead": "46c7ec2fd92c02ad7089085a330f63fc61d27d89"
+  "gitHead": "7ba4714d92f47bb41a9bb83fdedbc4497eecc9f2"
 }

package/src/commands/generate.command.ts

@@ -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/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.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/Dockerfile

@@ -13,4 +13,4 @@ ENV GF_DEFAULT_APP_MODE "development"
 
 # Inject livereload script into grafana index.html
 USER root
-RUN sed -i 's/<\/body><\/html>/<script src=\"http:\/\/localhost:35729\/livereload.js\"><\/script><\/body><\/html>/g' /usr/share/grafana/public/views/index.html
+RUN sed -i 's|</body>|<script src="http://localhost:35729/livereload.js"></script></body>|g' /usr/share/grafana/public/views/index.html

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/templates/github/ci/.github/workflows/ci.yml

@@ -17,14 +17,14 @@ jobs:
     env:
       GRAFANA_ACCESS_POLICY_TOKEN: $\{{ secrets.GRAFANA_ACCESS_POLICY_TOKEN }}
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 {{#if_eq packageManagerName "pnpm"}}
       # pnpm action uses the packageManager field in package.json to
       # understand which version to install.
       - uses: pnpm/action-setup@v2
 {{/if_eq}}
       - name: Setup Node.js environment
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: '20'
           cache: '{{ packageManagerName }}'
@@ -51,20 +51,20 @@ jobs:
 
       - name: Setup Go environment
         if: steps.check-for-backend.outputs.has-backend == 'true'
-        uses: actions/setup-go@v3
+        uses: actions/setup-go@v5
         with:
           go-version: '1.21'
 
       - name: Test backend
         if: steps.check-for-backend.outputs.has-backend == 'true'
-        uses: magefile/mage-action@v2
+        uses: magefile/mage-action@v3
         with:
           version: latest
           args: coverage
 
       - name: Build backend
         if: steps.check-for-backend.outputs.has-backend == 'true'
-        uses: magefile/mage-action@v2
+        uses: magefile/mage-action@v3
         with:
           version: latest
           args: buildAll
@@ -90,7 +90,7 @@ jobs:
         run: docker-compose down
 
       - name: Archive E2E output
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         if: steps.check-for-e2e.outputs.has-e2e == 'true' && steps.run-e2e-tests.outcome != 'success'
         with:
           name: cypress-videos
@@ -121,7 +121,7 @@ jobs:
           zip $\{{ steps.metadata.outputs.archive }} $\{{ steps.metadata.outputs.plugin-id }} -r
 
       - name: Archive Build
-        uses: actions/upload-artifact@v3
+        uses: actions/upload-artifact@v4
         with:
           name: $\{{ steps.metadata.outputs.plugin-id }}-$\{{ steps.metadata.outputs.plugin-version }}
           path: $\{{ steps.metadata.outputs.plugin-id }}

package/templates/github/ci/.github/workflows/release.yml

@@ -15,7 +15,7 @@ jobs:
   release:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
       - uses: grafana/plugin-actions/build-plugin@release
         # Uncomment to enable plugin signing
         # (For more info on how to generate the access policy token see https://grafana.com/developers/plugin-tools/publish-a-plugin/sign-a-plugin#generate-an-access-policy-token)

package/templates/github/is-compatible/.github/workflows/is-compatible.yml

@@ -5,14 +5,14 @@ jobs:
   compatibilitycheck:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 {{#if_eq packageManagerName "pnpm"}}
       # pnpm action uses the packageManager field in package.json to
       # understand which version to install.
       - uses: pnpm/action-setup@v2
 {{/if_eq}}
       - name: Setup Node.js environment
-        uses: actions/setup-node@v3
+        uses: actions/setup-node@v4
         with:
           node-version: '20'
           cache: '{{ packageManagerName }}'