@grafana/create-plugin 4.15.0 → 4.16.1-canary.994.189ce88.0

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+# v4.16.0 (Mon Jul 08 2024)
+
+#### 🚀 Enhancement
+
+- Create Plugin: Allow setting feature flags via cli args [#984](https://github.com/grafana/plugin-tools/pull/984) ([@jackw](https://github.com/jackw))
+
+#### Authors: 1
+
+- Jack Westbrook ([@jackw](https://github.com/jackw))
+
+---
+
 # v4.15.0 (Thu Jul 04 2024)
 
 #### 🚀 Enhancement

package/LICENSE

@@ -186,7 +186,7 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright [yyyy] [name of copyright owner]
+   Copyright 2024 Grafana Labs
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.

package/dist/constants.js

@@ -60,7 +60,7 @@ export const MIGRATION_CONFIG = {
     devNpmDependenciesToRemove: ['@grafana/toolkit', '@grafana/runtime', '@grafana/data', '@grafana/ui'],
 };
 export const UDPATE_CONFIG = {
-    filesToOverride: ['.config/'],
+    filesToOverride: ['.config/', '.cprc.json'],
 };
 export const TEXT = {
     overrideFilesPrompt: '**The following files will be overriden, would you like to continue?**',

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

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

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

@@ -0,0 +1,52 @@
+import { partitionArr } from '../utils.helpers.js';
+describe('partitionArr', () => {
+    it('should partition an array of numbers based on a predicate', () => {
+        const arr = [1, 2, 3, 4, 5, 6];
+        const isEven = (num) => num % 2 === 0;
+        const result = partitionArr(arr, isEven);
+        expect(result).toEqual([
+            [2, 4, 6],
+            [1, 3, 5],
+        ]);
+    });
+    it('should partition an array of strings based on a predicate', () => {
+        const arr = ['apple', 'banana', 'cherry', 'date'];
+        const startsWithA = (str) => str[0] === 'a';
+        const result = partitionArr(arr, startsWithA);
+        expect(result).toEqual([['apple'], ['banana', 'cherry', 'date']]);
+    });
+    it('should return two empty arrays if the input array is empty', () => {
+        const arr = [];
+        const isEven = (num) => num % 2 === 0;
+        const result = partitionArr(arr, isEven);
+        expect(result).toEqual([[], []]);
+    });
+    it('should place all items in the first partition if all match the predicate', () => {
+        const arr = [2, 4, 6, 8];
+        const isEven = (num) => num % 2 === 0;
+        const result = partitionArr(arr, isEven);
+        expect(result).toEqual([[2, 4, 6, 8], []]);
+    });
+    it('should place all items in the second partition if none match the predicate', () => {
+        const arr = [1, 3, 5, 7];
+        const isEven = (num) => num % 2 === 0;
+        const result = partitionArr(arr, isEven);
+        expect(result).toEqual([[], [1, 3, 5, 7]]);
+    });
+    it('should work with a complex object array and predicate', () => {
+        const arr = [
+            { name: 'Alice', age: 25 },
+            { name: 'Bob', age: 30 },
+            { name: 'Charlie', age: 35 },
+        ];
+        const isUnder30 = (person) => person.age < 30;
+        const result = partitionArr(arr, isUnder30);
+        expect(result).toEqual([
+            [{ name: 'Alice', age: 25 }],
+            [
+                { name: 'Bob', age: 30 },
+                { name: 'Charlie', age: 35 },
+            ],
+        ]);
+    });
+});

package/dist/utils/utils.config.js

@@ -1,8 +1,11 @@
 import fs from 'node:fs';
 import path from 'node:path';
 import { getVersion } from './utils.version.js';
-import { commandName } from './utils.cli.js';
+import { argv, commandName } from './utils.cli.js';
 import { DEFAULT_FEATURE_FLAGS } from '../constants.js';
+import { printBox } from './utils.console.js';
+import { partitionArr } from './utils.helpers.js';
+let hasShownConfigWarnings = false;
 export function getConfig(workDir = process.cwd()) {
     const rootConfig = getRootConfig(workDir);
     const userConfig = getUserConfig(workDir);
@@ -58,8 +61,24 @@ function readRCFileSync(path) {
     }
 }
 function createFeatureFlags(flags) {
-    if (commandName === 'generate') {
-        return DEFAULT_FEATURE_FLAGS;
+    const featureFlags = commandName === 'generate' ? DEFAULT_FEATURE_FLAGS : flags ?? {};
+    const cliArgFlags = parseFeatureFlagsFromCliArgs();
+    return { ...featureFlags, ...cliArgFlags };
+}
+function parseFeatureFlagsFromCliArgs() {
+    const flagsfromCliArgs = argv['feature-flags'] ? argv['feature-flags'].split(',') : [];
+    const availableFeatureFlags = Object.keys(DEFAULT_FEATURE_FLAGS);
+    const [knownFlags, unknownFlags] = partitionArr(flagsfromCliArgs, (item) => availableFeatureFlags.includes(item));
+    if (unknownFlags.length > 0 && !hasShownConfigWarnings) {
+        printBox({
+            title: 'Warning! Unknown feature flags detected.',
+            subtitle: ``,
+            content: `The following feature-flags are unknown: ${unknownFlags.join(', ')}.\n\nAvailable feature-flags are: ${availableFeatureFlags.join(', ')}`,
+            color: 'yellow',
+        });
+        hasShownConfigWarnings = true;
     }
-    return flags ?? {};
+    return knownFlags.reduce((acc, flag) => {
+        return { ...acc, [flag]: true };
+    }, {});
 }

package/dist/utils/utils.helpers.js

@@ -0,0 +1,3 @@
+export function partitionArr(arr, pred) {
+    return arr.reduce((acc, i) => (acc[pred(i) ? 0 : 1].push(i), acc), [[], []]);
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@grafana/create-plugin",
-  "version": "4.15.0",
+  "version": "4.16.1-canary.994.189ce88.0",
   "repository": {
     "directory": "packages/create-plugin",
     "url": "https://github.com/grafana/plugin-tools"
@@ -87,5 +87,5 @@
   "engines": {
     "node": ">=20"
   },
-  "gitHead": "10a4a8648f2f2794df271011c3bd062d47e323d6"
+  "gitHead": "189ce8870ba0be391aef344afc4782cbe1d60412"
 }

package/src/constants.ts

@@ -85,7 +85,7 @@ export const MIGRATION_CONFIG = {
 
 export const UDPATE_CONFIG = {
   // Files that should be overriden between configuration version updates.
-  filesToOverride: ['.config/'],
+  filesToOverride: ['.config/', '.cprc.json'],
 };
 
 // prettier-ignore

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

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

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

@@ -0,0 +1,58 @@
+import { partitionArr } from '../utils.helpers.js';
+
+describe('partitionArr', () => {
+  it('should partition an array of numbers based on a predicate', () => {
+    const arr = [1, 2, 3, 4, 5, 6];
+    const isEven = (num: number) => num % 2 === 0;
+    const result = partitionArr(arr, isEven);
+    expect(result).toEqual([
+      [2, 4, 6],
+      [1, 3, 5],
+    ]);
+  });
+
+  it('should partition an array of strings based on a predicate', () => {
+    const arr = ['apple', 'banana', 'cherry', 'date'];
+    const startsWithA = (str: string) => str[0] === 'a';
+    const result = partitionArr(arr, startsWithA);
+    expect(result).toEqual([['apple'], ['banana', 'cherry', 'date']]);
+  });
+
+  it('should return two empty arrays if the input array is empty', () => {
+    const arr: number[] = [];
+    const isEven = (num: number) => num % 2 === 0;
+    const result = partitionArr(arr, isEven);
+    expect(result).toEqual([[], []]);
+  });
+
+  it('should place all items in the first partition if all match the predicate', () => {
+    const arr = [2, 4, 6, 8];
+    const isEven = (num: number) => num % 2 === 0;
+    const result = partitionArr(arr, isEven);
+    expect(result).toEqual([[2, 4, 6, 8], []]);
+  });
+
+  it('should place all items in the second partition if none match the predicate', () => {
+    const arr = [1, 3, 5, 7];
+    const isEven = (num: number) => num % 2 === 0;
+    const result = partitionArr(arr, isEven);
+    expect(result).toEqual([[], [1, 3, 5, 7]]);
+  });
+
+  it('should work with a complex object array and predicate', () => {
+    const arr = [
+      { name: 'Alice', age: 25 },
+      { name: 'Bob', age: 30 },
+      { name: 'Charlie', age: 35 },
+    ];
+    const isUnder30 = (person: { name: string; age: number }) => person.age < 30;
+    const result = partitionArr(arr, isUnder30);
+    expect(result).toEqual([
+      [{ name: 'Alice', age: 25 }],
+      [
+        { name: 'Bob', age: 30 },
+        { name: 'Charlie', age: 35 },
+      ],
+    ]);
+  });
+});

package/src/utils/utils.config.ts

@@ -1,8 +1,10 @@
 import fs from 'node:fs';
 import path from 'node:path';
 import { getVersion } from './utils.version.js';
-import { commandName } from './utils.cli.js';
+import { argv, commandName } from './utils.cli.js';
 import { DEFAULT_FEATURE_FLAGS } from '../constants.js';
+import { printBox } from './utils.console.js';
+import { partitionArr } from './utils.helpers.js';
 
 export type FeatureFlags = {
   bundleGrafanaUI?: boolean;
@@ -21,6 +23,9 @@ export type UserConfig = {
   features: FeatureFlags;
 };
 
+// TODO: Create a config manager of sorts so we don't call getConfig multiple times rendering multiple warnings.
+let hasShownConfigWarnings = false;
+
 export function getConfig(workDir = process.cwd()): CreatePluginConfig {
   const rootConfig = getRootConfig(workDir);
   const userConfig = getUserConfig(workDir);
@@ -83,11 +88,32 @@ function readRCFileSync(path: string): CreatePluginConfig | undefined {
   }
 }
 
+// This function creates feature flags based on the defaults for generate command else flags read from config.
+// In all cases it will override the flags with the featureFlag cli arg values.
 function createFeatureFlags(flags?: FeatureFlags): FeatureFlags {
-  // Default values for new scaffoldings
-  if (commandName === 'generate') {
-    return DEFAULT_FEATURE_FLAGS;
+  const featureFlags = commandName === 'generate' ? DEFAULT_FEATURE_FLAGS : flags ?? {};
+  const cliArgFlags = parseFeatureFlagsFromCliArgs();
+  return { ...featureFlags, ...cliArgFlags };
+}
+
+function parseFeatureFlagsFromCliArgs() {
+  const flagsfromCliArgs: string[] = argv['feature-flags'] ? argv['feature-flags'].split(',') : [];
+  const availableFeatureFlags = Object.keys(DEFAULT_FEATURE_FLAGS);
+  const [knownFlags, unknownFlags] = partitionArr(flagsfromCliArgs, (item) => availableFeatureFlags.includes(item));
+
+  if (unknownFlags.length > 0 && !hasShownConfigWarnings) {
+    printBox({
+      title: 'Warning! Unknown feature flags detected.',
+      subtitle: ``,
+      content: `The following feature-flags are unknown: ${unknownFlags.join(
+        ', '
+      )}.\n\nAvailable feature-flags are: ${availableFeatureFlags.join(', ')}`,
+      color: 'yellow',
+    });
+    hasShownConfigWarnings = true;
   }
 
-  return flags ?? {};
+  return knownFlags.reduce((acc, flag) => {
+    return { ...acc, [flag]: true };
+  }, {} as FeatureFlags);
 }

package/src/utils/utils.helpers.ts

@@ -0,0 +1,3 @@
+export function partitionArr<T>(arr: T[], pred: (item: T) => boolean): [T[], T[]] {
+  return arr.reduce<[T[], T[]]>((acc, i) => (acc[pred(i) ? 0 : 1].push(i), acc), [[], []]);
+}

package/templates/common/.cprc.json

@@ -1,8 +1,6 @@
 {
   "features": {
-    {{#if bundleGrafanaUI}}
-    "bundleGrafanaUI": true{{/if}}
-    {{#if useReactRouterV6}}
-    "useReactRouterV6": true{{/if}}
+    "bundleGrafanaUI": {{ bundleGrafanaUI }},
+    "useReactRouterV6": {{ useReactRouterV6 }}
   }
 }