From b46970c8800548c15fd0e59e124a3214aacb3c27 Mon Sep 17 00:00:00 2001 From: Patrik Oldsberg Date: Tue, 17 Mar 2026 20:55:10 +0100 Subject: [PATCH] Move known plugin package constants from cli-common to cli-internal The known plugin package ID mappings don't need to be part of the public API surface. Move them to @internal/cli and update consumers. Signed-off-by: Patrik Oldsberg Made-with: Cursor --- .changeset/clever-insects-tan.md | 3 +-- packages/cli-common/report.api.md | 6 ------ packages/cli-common/src/index.ts | 4 ---- packages/cli-internal/src/index.ts | 4 ++++ .../{cli-common => cli-internal}/src/knownPluginPackages.ts | 4 ---- packages/cli-module-maintenance/package.json | 4 ++-- packages/cli-module-maintenance/src/commands/repo/fix.ts | 4 ++-- .../src/lib/preparation/collectPortableTemplateInput.ts | 4 ++-- 8 files changed, 11 insertions(+), 22 deletions(-) rename packages/{cli-common => cli-internal}/src/knownPluginPackages.ts (98%) diff --git a/.changeset/clever-insects-tan.md b/.changeset/clever-insects-tan.md index 502882e116..c04490a833 100644 --- a/.changeset/clever-insects-tan.md +++ b/.changeset/clever-insects-tan.md @@ -1,6 +1,5 @@ --- '@backstage/cli-module-maintenance': patch -'@backstage/cli-common': patch --- -Exposes `knownBackendPluginPackageNameByPluginId` and `knownFrontendPluginPackageNameByPluginId` from `@backstage/cli-common` for auto-filling plugin package names. +Added auto-fill of `backstage.pluginPackage` metadata for known plugins during `repo fix`. diff --git a/packages/cli-common/report.api.md b/packages/cli-common/report.api.md index 74d5a24999..ba649cacc9 100644 --- a/packages/cli-common/report.api.md +++ b/packages/cli-common/report.api.md @@ -28,12 +28,6 @@ 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 bfa0716097..e49eac0ee0 100644 --- a/packages/cli-common/src/index.ts +++ b/packages/cli-common/src/index.ts @@ -33,7 +33,3 @@ export { type RunOnOutput, } from './run'; export { ExitCodeError } from './errors'; -export { - knownBackendPluginPackageNameByPluginId, - knownFrontendPluginPackageNameByPluginId, -} from './knownPluginPackages'; diff --git a/packages/cli-internal/src/index.ts b/packages/cli-internal/src/index.ts index 281b998d92..dfd8968c6a 100644 --- a/packages/cli-internal/src/index.ts +++ b/packages/cli-internal/src/index.ts @@ -31,3 +31,7 @@ export { resetSecretStore, type SecretStore, } from './secretStore'; +export { + knownBackendPluginPackageNameByPluginId, + knownFrontendPluginPackageNameByPluginId, +} from './knownPluginPackages'; diff --git a/packages/cli-common/src/knownPluginPackages.ts b/packages/cli-internal/src/knownPluginPackages.ts similarity index 98% rename from packages/cli-common/src/knownPluginPackages.ts rename to packages/cli-internal/src/knownPluginPackages.ts index 43e33f4cc2..c5d13beef1 100644 --- a/packages/cli-common/src/knownPluginPackages.ts +++ b/packages/cli-internal/src/knownPluginPackages.ts @@ -44,8 +44,6 @@ const knownFrontendPluginIds = [ /** * Maps known plugin IDs to their corresponding backend package names. - * - * @public */ export const knownBackendPluginPackageNameByPluginId: Record = Object.fromEntries( @@ -57,8 +55,6 @@ export const knownBackendPluginPackageNameByPluginId: Record = /** * Maps known plugin IDs to their corresponding frontend package names. - * - * @public */ export const knownFrontendPluginPackageNameByPluginId: Record = Object.fromEntries( diff --git a/packages/cli-module-maintenance/package.json b/packages/cli-module-maintenance/package.json index 24f7a9b70a..585de9d6cd 100644 --- a/packages/cli-module-maintenance/package.json +++ b/packages/cli-module-maintenance/package.json @@ -19,6 +19,7 @@ "license": "Apache-2.0", "main": "src/index.ts", "types": "src/index.ts", + "bin": "bin/backstage-cli-module-maintenance", "files": [ "dist", "bin" @@ -42,6 +43,5 @@ "devDependencies": { "@backstage/cli": "workspace:^", "@types/fs-extra": "^11.0.0" - }, - "bin": "bin/backstage-cli-module-maintenance" + } } diff --git a/packages/cli-module-maintenance/src/commands/repo/fix.ts b/packages/cli-module-maintenance/src/commands/repo/fix.ts index 81e7a37d80..c9e6a965bf 100644 --- a/packages/cli-module-maintenance/src/commands/repo/fix.ts +++ b/packages/cli-module-maintenance/src/commands/repo/fix.ts @@ -29,11 +29,11 @@ import { relative as relativePath, extname, } from 'node:path'; +import { targetPaths } from '@backstage/cli-common'; import { - targetPaths, knownBackendPluginPackageNameByPluginId, knownFrontendPluginPackageNameByPluginId, -} from '@backstage/cli-common'; +} from '@internal/cli'; 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 b2b89262a2..341caae504 100644 --- a/packages/cli-module-new/src/lib/preparation/collectPortableTemplateInput.ts +++ b/packages/cli-module-new/src/lib/preparation/collectPortableTemplateInput.ts @@ -16,11 +16,11 @@ import inquirer, { DistinctQuestion } from 'inquirer'; import { getCodeownersFilePath, parseOwnerIds } from '../codeowners'; +import { targetPaths } from '@backstage/cli-common'; import { - targetPaths, knownBackendPluginPackageNameByPluginId, knownFrontendPluginPackageNameByPluginId, -} from '@backstage/cli-common'; +} from '@internal/cli'; import { PortableTemplateConfig,