From 2069f642018dcb41f489eeee04ed712b40bcb57a Mon Sep 17 00:00:00 2001 From: Patrik Oldsberg Date: Sun, 15 Mar 2026 21:51:07 +0100 Subject: [PATCH] Remove extra exports from CLI module packages CLI modules should only export the module itself as a default export. Remove the named `buildPlugin` export from cli-module-build and the unused `configOption` export from cli-module-config. Also remove the API report warning skip for CLI module packages. Signed-off-by: Patrik Oldsberg Made-with: Cursor --- package.json | 8 ++++---- packages/cli-module-build/report.api.md | 7 ++----- packages/cli-module-build/src/index.ts | 4 +--- packages/cli-module-config/report.api.md | 10 ---------- packages/cli-module-config/src/index.ts | 7 ------- 5 files changed, 7 insertions(+), 29 deletions(-) diff --git a/package.json b/package.json index a302681d2f..c443b8aa81 100644 --- a/package.json +++ b/package.json @@ -21,15 +21,15 @@ "plugins/*" ], "scripts": { - "build-storybook": "storybook build --output-dir dist-storybook", - "build-storybook:chromatic": "STORYBOOK_STORY_SET=chromatic storybook build --stats-json --output-dir dist-storybook", "build:all": "backstage-cli repo build --all", "build:api-docs": "LANG=en_EN yarn build:api-reports --docs --exclude 'plugins/@(api-docs|api-docs-module-protoc-gen-doc|app-visualizer|catalog-graph|catalog-import|catalog-unprocessed-entities|config-schema|example-todo-list|example-todo-list-backend)'", "build:api-reports": "yarn build:api-reports:only --tsc", - "build:api-reports:only": "LANG=en_US.UTF-8 NODE_OPTIONS=--max-old-space-size=8192 backstage-repo-tools api-reports --sql-reports --allow-warnings 'packages/backend-app-api,packages/cli-module-*,packages/core-components,plugins/+(catalog|catalog-import|kubernetes)' -o ae-undocumented,ae-wrong-input-file-type --validate-release-tags", + "build:api-reports:only": "LANG=en_US.UTF-8 NODE_OPTIONS=--max-old-space-size=8192 backstage-repo-tools api-reports --sql-reports --allow-warnings 'packages/backend-app-api,packages/core-components,plugins/+(catalog|catalog-import|kubernetes)' -o ae-undocumented,ae-wrong-input-file-type --validate-release-tags", "build:backend": "yarn workspace example-backend build", "build:knip-reports": "backstage-repo-tools knip-reports", "build:plugins-report": "node ./scripts/build-plugins-report", + "build-storybook": "storybook build --output-dir dist-storybook", + "build-storybook:chromatic": "STORYBOOK_STORY_SET=chromatic storybook build --stats-json --output-dir dist-storybook", "clean": "backstage-cli repo clean", "create-plugin": "echo \"use 'yarn new' instead\"", "dev": "echo \"use 'yarn start' instead\"", @@ -52,10 +52,10 @@ "snyk:test": "npx snyk test --yarn-workspaces --strict-out-of-sync=false", "snyk:test:package": "yarn snyk:test --include", "start": "backstage-cli repo start", - "start-backend": "echo \"Use 'yarn start example-backend' instead\"", "start:docker": "docker compose -f docker-compose.deps.yml up --wait && BACKSTAGE_ENV=docker yarn start", "start:legacy": "yarn start example-app-legacy example-backend", "start:microsite": "cd microsite/ && yarn start", + "start-backend": "echo \"Use 'yarn start example-backend' instead\"", "storybook": "storybook dev -p 6006", "sync-issue-templates": "node ./.github/ISSUE_TEMPLATE/sync.js", "techdocs-cli": "node scripts/techdocs-cli.js", diff --git a/packages/cli-module-build/report.api.md b/packages/cli-module-build/report.api.md index 6309f5b839..34634dd448 100644 --- a/packages/cli-module-build/report.api.md +++ b/packages/cli-module-build/report.api.md @@ -5,12 +5,9 @@ ```ts import { CliModule } from '@backstage/cli-node'; -// Warning: (ae-missing-release-tag) "buildPlugin" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) -// // @public (undocumented) -const buildPlugin: CliModule; -export { buildPlugin }; -export default buildPlugin; +const _default: CliModule; +export default _default; // (No @packageDocumentation comment for this package) ``` diff --git a/packages/cli-module-build/src/index.ts b/packages/cli-module-build/src/index.ts index b2fb597249..887a4b562c 100644 --- a/packages/cli-module-build/src/index.ts +++ b/packages/cli-module-build/src/index.ts @@ -17,7 +17,7 @@ import { createCliModule } from '@backstage/cli-node'; import packageJson from '../package.json'; -export const buildPlugin = createCliModule({ +export default createCliModule({ packageJson, init: async reg => { reg.addCommand({ @@ -85,5 +85,3 @@ export const buildPlugin = createCliModule({ }); }, }); - -export default buildPlugin; diff --git a/packages/cli-module-config/report.api.md b/packages/cli-module-config/report.api.md index 185bec4e05..740aef21fb 100644 --- a/packages/cli-module-config/report.api.md +++ b/packages/cli-module-config/report.api.md @@ -5,16 +5,6 @@ ```ts import { CliModule } from '@backstage/cli-node'; -// Warning: (ae-missing-release-tag) "configOption" is part of the package's API, but it is missing a release tag (@alpha, @beta, @public, or @internal) -// -// @public (undocumented) -export const configOption: readonly [ - '--config ', - 'Config files to load instead of app-config.yaml', - (opt: string, opts: string[]) => string[], - string[], -]; - // @public (undocumented) const _default: CliModule; export default _default; diff --git a/packages/cli-module-config/src/index.ts b/packages/cli-module-config/src/index.ts index af2a7143b7..a041f32d6e 100644 --- a/packages/cli-module-config/src/index.ts +++ b/packages/cli-module-config/src/index.ts @@ -16,13 +16,6 @@ import { createCliModule } from '@backstage/cli-node'; import packageJson from '../package.json'; -export const configOption = [ - '--config ', - 'Config files to load instead of app-config.yaml', - (opt: string, opts: string[]) => (opts ? [...opts, opt] : [opt]), - Array(), -] as const; - export default createCliModule({ packageJson, init: async reg => {