Skip to content

Create Plugin: Remove g/ui bundling code from templates #2371

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
sunker wants to merge 1 commit into
base: main
Choose a base branch
from
Draft

Create Plugin: Remove g/ui bundling code from templates #2371

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion packages/create-plugin/src/constants.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,6 @@ export const EXTRA_TEMPLATE_VARIABLES = {
};

export const DEFAULT_FEATURE_FLAGS = {
bundleGrafanaUI: false,
useExperimentalRspack: false,
useExperimentalUpdates: true,
};
Expand Down
1 change: 0 additions & 1 deletion packages/create-plugin/src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@ export type TemplateData = {
isAppType: boolean;
isNPM: boolean;
version: string;
bundleGrafanaUI: boolean;
scenesVersion: string;
useExperimentalRspack: boolean;
pluginExecutable?: string;
Expand Down
28 changes: 3 additions & 25 deletions packages/create-plugin/src/utils/tests/utils.config.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,13 +46,13 @@ describe('getConfig', () => {

it('should override default feature flags via cli args', async () => {
mocks.argv = {
'feature-flags': 'bundleGrafanaUI',
'feature-flags': 'useExperimentalRspack',
};
const config = getConfig(tmpDir);

expect(config).toEqual({
version: CURRENT_APP_VERSION,
features: { ...DEFAULT_FEATURE_FLAGS, bundleGrafanaUI: true },
features: { ...DEFAULT_FEATURE_FLAGS, useExperimentalRspack: true },
});
});
});
Expand Down Expand Up @@ -94,7 +94,7 @@ describe('getConfig', () => {
const userConfigPath = path.join(tmpDir, '.cprc.json');
const userConfig: UserConfig = {
features: {
bundleGrafanaUI: true,
useExperimentalRspack: true,
},
};

Expand All @@ -107,27 +107,5 @@ describe('getConfig', () => {
features: userConfig.features,
});
});

it('should give back the correct config when config files exist', async () => {
const rootConfigPath = path.join(tmpDir, '.config', '.cprc.json');
const userConfigPath = path.join(tmpDir, '.cprc.json');
const rootConfig: CreatePluginConfig = {
version: '1.0.0',
features: {},
};
const userConfig: UserConfig = {
features: {
bundleGrafanaUI: false,
},
};

await fs.mkdir(path.dirname(rootConfigPath), { recursive: true });
await fs.writeFile(rootConfigPath, JSON.stringify(rootConfig));
await fs.writeFile(userConfigPath, JSON.stringify(userConfig));

const config = getConfig(tmpDir);

expect(config).toEqual({ ...rootConfig, ...userConfig });
});
});
});
1 change: 0 additions & 1 deletion packages/create-plugin/src/utils/utils.config.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ import { writeFile } from 'node:fs/promises';
import { EOL } from 'node:os';

export type FeatureFlags = {
bundleGrafanaUI?: boolean;
useExperimentalRspack?: boolean;
useExperimentalUpdates?: boolean;
};
Expand Down
11 changes: 1 addition & 10 deletions packages/create-plugin/src/utils/utils.templates.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,4 @@
import {
DEFAULT_FEATURE_FLAGS,
EXPORT_PATH_PREFIX,
EXTRA_TEMPLATE_VARIABLES,
PLUGIN_TYPES,
TEMPLATE_PATHS,
} from '../constants.js';
import { EXPORT_PATH_PREFIX, EXTRA_TEMPLATE_VARIABLES, PLUGIN_TYPES, TEMPLATE_PATHS } from '../constants.js';
import { GenerateCliArgs, TemplateData } from '../types.js';
import { filterOutCommonFiles, isFile, isFileStartingWith } from './utils.files.js';
import {
Expand Down Expand Up @@ -95,7 +89,6 @@ export function renderTemplateFromFile(templateFile: string, data?: any) {
export function getTemplateData(cliArgs?: GenerateCliArgs): TemplateData {
const { features } = getConfig();
const currentVersion = CURRENT_APP_VERSION;
const bundleGrafanaUI = features.bundleGrafanaUI ?? DEFAULT_FEATURE_FLAGS.bundleGrafanaUI;
const isAppType = (pluginType: string) => pluginType === PLUGIN_TYPES.app || pluginType === PLUGIN_TYPES.scenes;
const isNPM = (packageManagerName: string) => packageManagerName === 'npm';
const frontendBundler = features.useExperimentalRspack ? 'rspack' : 'webpack';
Expand All @@ -120,7 +113,6 @@ export function getTemplateData(cliArgs?: GenerateCliArgs): TemplateData {
isAppType: isAppType(cliArgs.pluginType),
isNPM: isNPM(packageManagerName),
version: currentVersion,
bundleGrafanaUI,
scenesVersion: '^6.10.4',
useExperimentalRspack: Boolean(features.useExperimentalRspack),
frontendBundler,
Expand All @@ -144,7 +136,6 @@ export function getTemplateData(cliArgs?: GenerateCliArgs): TemplateData {
isAppType: isAppType(pluginJson.type),
isNPM: isNPM(packageManagerName),
version: currentVersion,
bundleGrafanaUI,
scenesVersion: '^6.10.4',
pluginExecutable: pluginJson.executable,
useExperimentalRspack: Boolean(features.useExperimentalRspack),
Expand Down
1 change: 0 additions & 1 deletion packages/create-plugin/templates/common/.cprc.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
{
"features": {
"bundleGrafanaUI": {{ bundleGrafanaUI }},
"useExperimentalRspack": {{ useExperimentalRspack }}
}
}
Loading