diff --git a/packages/cli-common/report.api.md b/packages/cli-common/report.api.md index ba649cacc9..74d5a24999 100644 --- a/packages/cli-common/report.api.md +++ b/packages/cli-common/report.api.md @@ -28,6 +28,12 @@ export function findPaths(searchDir: string): Paths; // @public export function isChildPath(base: string, path: string): boolean; +// @public +export const knownBackendPluginPackageNameByPluginId: Record; + +// @public +export const knownFrontendPluginPackageNameByPluginId: Record; + // @public export type OwnPaths = { dir: string; diff --git a/packages/cli-common/src/index.ts b/packages/cli-common/src/index.ts index e49eac0ee0..bfa0716097 100644 --- a/packages/cli-common/src/index.ts +++ b/packages/cli-common/src/index.ts @@ -33,3 +33,7 @@ export { type RunOnOutput, } from './run'; export { ExitCodeError } from './errors'; +export { + knownBackendPluginPackageNameByPluginId, + knownFrontendPluginPackageNameByPluginId, +} from './knownPluginPackages'; diff --git a/packages/cli/src/lib/knownPluginPackages.ts b/packages/cli-common/src/knownPluginPackages.ts similarity index 86% rename from packages/cli/src/lib/knownPluginPackages.ts rename to packages/cli-common/src/knownPluginPackages.ts index 88bfdf25e0..ae0d3f8942 100644 --- a/packages/cli/src/lib/knownPluginPackages.ts +++ b/packages/cli-common/src/knownPluginPackages.ts @@ -29,6 +29,11 @@ const knownPluginIds = [ 'techdocs', ]; +/** + * Maps known plugin IDs to their corresponding backend package names. + * + * @public + */ export const knownBackendPluginPackageNameByPluginId: Record = Object.fromEntries( knownPluginIds.map(pluginId => [ @@ -37,6 +42,11 @@ export const knownBackendPluginPackageNameByPluginId: Record = ]), ); +/** + * Maps known plugin IDs to their corresponding frontend package names. + * + * @public + */ export const knownFrontendPluginPackageNameByPluginId: Record = Object.fromEntries( knownPluginIds.map(pluginId => [pluginId, `@backstage/plugin-${pluginId}`]), diff --git a/packages/cli-module-maintenance/src/commands/repo/fix.ts b/packages/cli-module-maintenance/src/commands/repo/fix.ts index 34b7c93288..ffc044f42a 100644 --- a/packages/cli-module-maintenance/src/commands/repo/fix.ts +++ b/packages/cli-module-maintenance/src/commands/repo/fix.ts @@ -30,7 +30,7 @@ import { extname, } from 'node:path'; import { targetPaths } from '@backstage/cli-common'; -import { knownBackendPluginPackageNameByPluginId } from '../../../../lib/knownPluginPackages'; +import { knownBackendPluginPackageNameByPluginId } from '@backstage/cli-common'; const SCRIPT_EXTS = ['.js', '.jsx', '.ts', '.tsx', '.json']; diff --git a/packages/cli-module-new/src/lib/preparation/collectPortableTemplateInput.ts b/packages/cli-module-new/src/lib/preparation/collectPortableTemplateInput.ts index 2e7170f81f..a38432a66a 100644 --- a/packages/cli-module-new/src/lib/preparation/collectPortableTemplateInput.ts +++ b/packages/cli-module-new/src/lib/preparation/collectPortableTemplateInput.ts @@ -30,7 +30,7 @@ import { resolvePackageParams } from './resolvePackageParams'; import { knownBackendPluginPackageNameByPluginId, knownFrontendPluginPackageNameByPluginId, -} from '../../../../lib/knownPluginPackages'; +} from '@backstage/cli-common'; type CollectTemplateParamsOptions = { config: PortableTemplateConfig;