@grafana/create-plugin 4.14.0-canary.984.f879305.0 → 4.14.0

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+# v4.14.0 (Mon Jul 01 2024)
+
+#### 🚀 Enhancement
+
+- Create-Plugin: Add version comment to bundled Javascript [#970](https://github.com/grafana/plugin-tools/pull/970) ([@jackw](https://github.com/jackw))
+
+#### Authors: 1
+
+- Jack Westbrook ([@jackw](https://github.com/jackw))
+
+---
+
 # v4.12.0 (Tue Jun 11 2024)
 
 #### 🚀 Enhancement

package/dist/utils/tests/utils.config.test.js

@@ -8,7 +8,6 @@ import { DEFAULT_FEATURE_FLAGS } from '../../constants.js';
 const mocks = vi.hoisted(() => {
     return {
         commandName: 'generate',
-        argv: {},
     };
 });
 vi.mock('../utils.cli.js', async () => mocks);
@@ -21,7 +20,6 @@ describe('getConfig', () => {
     describe('Command: Generate', () => {
         beforeEach(() => {
             mocks.commandName = 'generate';
-            mocks.argv = {};
         });
         it('should give back a default config', async () => {
             const config = getConfig(tmpDir);
@@ -30,17 +28,6 @@ describe('getConfig', () => {
                 features: DEFAULT_FEATURE_FLAGS,
             });
         });
-        it('should override default feature flags via cli args', async () => {
-            mocks.argv = {
-                useReactRouterV6: false,
-                bundleGrafanaUI: true,
-            };
-            const config = getConfig(tmpDir);
-            expect(config).toEqual({
-                version: getVersion(),
-                features: { ...DEFAULT_FEATURE_FLAGS, useReactRouterV6: false, bundleGrafanaUI: true },
-            });
-        });
     });
     describe('Command: Update', () => {
         beforeEach(() => {

package/dist/utils/utils.config.js

@@ -1,7 +1,7 @@
 import fs from 'node:fs';
 import path from 'node:path';
 import { getVersion } from './utils.version.js';
-import { argv, commandName } from './utils.cli.js';
+import { commandName } from './utils.cli.js';
 import { DEFAULT_FEATURE_FLAGS } from '../constants.js';
 export function getConfig(workDir = process.cwd()) {
     const rootConfig = getRootConfig(workDir);
@@ -59,15 +59,7 @@ function readRCFileSync(path) {
 }
 function createFeatureFlags(flags) {
     if (commandName === 'generate') {
-        const flags = Object.entries(DEFAULT_FEATURE_FLAGS).reduce((acc, [flag, value]) => {
-            if (argv.hasOwnProperty(flag)) {
-                return { ...acc, [flag]: argv[flag] };
-            }
-            else {
-                return { ...acc, [flag]: value };
-            }
-        }, {});
-        return flags;
+        return DEFAULT_FEATURE_FLAGS;
     }
     return flags ?? {};
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/create-plugin",
-  "version": "4.14.0-canary.984.f879305.0",
+  "version": "4.14.0",
   "repository": {
     "directory": "packages/create-plugin",
     "url": "https://github.com/grafana/plugin-tools"
@@ -87,5 +87,5 @@
   "engines": {
     "node": ">=20"
   },
-  "gitHead": "f879305ada6bb8020506aad36715fc10770f963d"
+  "gitHead": "732bf7759cc0b6b2b696b9ca4451a9a65a6b732e"
 }

package/src/utils/tests/utils.config.test.ts

@@ -9,7 +9,6 @@ import { DEFAULT_FEATURE_FLAGS } from '../../constants.js';
 const mocks = vi.hoisted(() => {
   return {
     commandName: 'generate',
-    argv: {},
   };
 });
 
@@ -26,7 +25,6 @@ describe('getConfig', () => {
   describe('Command: Generate', () => {
     beforeEach(() => {
       mocks.commandName = 'generate';
-      mocks.argv = {};
     });
 
     it('should give back a default config', async () => {
@@ -37,19 +35,6 @@ describe('getConfig', () => {
         features: DEFAULT_FEATURE_FLAGS,
       });
     });
-
-    it('should override default feature flags via cli args', async () => {
-      mocks.argv = {
-        useReactRouterV6: false,
-        bundleGrafanaUI: true,
-      };
-      const config = getConfig(tmpDir);
-
-      expect(config).toEqual({
-        version: getVersion(),
-        features: { ...DEFAULT_FEATURE_FLAGS, useReactRouterV6: false, bundleGrafanaUI: true },
-      });
-    });
   });
 
   describe('Command: Update', () => {

package/src/utils/utils.config.ts

@@ -1,7 +1,7 @@
 import fs from 'node:fs';
 import path from 'node:path';
 import { getVersion } from './utils.version.js';
-import { argv, commandName } from './utils.cli.js';
+import { commandName } from './utils.cli.js';
 import { DEFAULT_FEATURE_FLAGS } from '../constants.js';
 
 export type FeatureFlags = {
@@ -84,17 +84,9 @@ function readRCFileSync(path: string): CreatePluginConfig | undefined {
 }
 
 function createFeatureFlags(flags?: FeatureFlags): FeatureFlags {
-  // For new scaffolds override any defaults with args passed in the CLI.
+  // Default values for new scaffoldings
   if (commandName === 'generate') {
-    const flags = Object.entries(DEFAULT_FEATURE_FLAGS).reduce((acc, [flag, value]) => {
-      if (argv.hasOwnProperty(flag)) {
-        return { ...acc, [flag]: argv[flag] };
-      } else {
-        return { ...acc, [flag]: value };
-      }
-    }, {} as FeatureFlags);
-
-    return flags;
+    return DEFAULT_FEATURE_FLAGS;
   }
 
   return flags ?? {};

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

@@ -29,6 +29,11 @@ export function getPluginJson() {
   return require(path.resolve(process.cwd(), `${SOURCE_DIR}/plugin.json`));
 }
 
+export function getCPConfigVersion() {
+  const cprcJson = path.resolve(__dirname, '../', '.cprc.json');
+  return fs.existsSync(cprcJson) ? require(cprcJson).version : { version: 'unknown' };
+}
+
 export function hasReadme() {
   return fs.existsSync(path.resolve(process.cwd(), SOURCE_DIR, 'README.md'));
 }

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

@@ -11,12 +11,14 @@ import ForkTsCheckerWebpackPlugin from 'fork-ts-checker-webpack-plugin';
 import LiveReloadPlugin from 'webpack-livereload-plugin';
 import path from 'path';
 import ReplaceInFileWebpackPlugin from 'replace-in-file-webpack-plugin';
-import { Configuration } from 'webpack';
+import TerserPlugin from 'terser-webpack-plugin';
+import { type Configuration, BannerPlugin } from 'webpack';
 
-import { getPackageJson, getPluginJson, hasReadme, getEntries, isWSL } from './utils';
+import { getPackageJson, getPluginJson, hasReadme, getEntries, isWSL, getCPConfigVersion } from './utils';
 import { SOURCE_DIR, DIST_DIR } from './constants';
 
 const pluginJson = getPluginJson();
+const cpVersion = getCPConfigVersion();
 
 const config = async (env): Promise<Configuration> => {
   const baseConfig: Configuration = {
@@ -133,6 +135,19 @@ const config = async (env): Promise<Configuration> => {
       ],
     },
 
+    optimization: {
+      minimize: Boolean(env.production),
+      minimizer: [
+        new TerserPlugin({
+          terserOptions: {
+            format: {
+              comments: (_, { type, value }) => type === 'comment2' && value.trim().startsWith('[create-plugin]'),
+            },
+          },
+        }),
+      ],
+    },
+
     output: {
       clean: {
         keep: new RegExp(`(.*?_(amd64|arm(64)?)(.exe)?|go_plugin_build_manifest)`),
@@ -147,6 +162,12 @@ const config = async (env): Promise<Configuration> => {
     },
 
     plugins: [
+      // Insert create plugin version information into the bundle
+      new BannerPlugin({
+        banner: "/* [create-plugin] version: " + cpVersion + " */",
+        raw: true,
+        entryOnly: true,
+      }),
       new CopyWebpackPlugin({
         patterns: [
           // If src/README.md exists use it; otherwise the root README

package/templates/common/npmrc

@@ -9,6 +9,7 @@ public-hoist-pattern[]="*prettier*"
 
 # Hoist all types packages to the root for better TS support
 public-hoist-pattern[]="@types/*"
+public-hoist-pattern[]="*terser-webpack-plugin*"
 {{#unless usePlaywright}}
 # @grafana/e2e expects cypress to exist in the root of the node_modules directory
 public-hoist-pattern[]="*cypress*"{{/unless}}