Add @backstage/cli-defaults package
Introduces a new `@backstage/cli-defaults` package that re-exports all standard CLI modules as a single array, simplifying dependency management for consumers. The CLI's `CliInitializer` is updated to support array exports alongside single module exports. The create-app template, changesets, and CLI fallback are updated to use `@backstage/cli-defaults` instead of listing 11 individual modules. Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com> Made-with: Cursor
This commit is contained in:
@@ -48,17 +48,7 @@
|
||||
},
|
||||
"dependencies": {
|
||||
"@backstage/cli-common": "workspace:^",
|
||||
"@backstage/cli-module-auth": "workspace:^",
|
||||
"@backstage/cli-module-build": "workspace:^",
|
||||
"@backstage/cli-module-config": "workspace:^",
|
||||
"@backstage/cli-module-create-github-app": "workspace:^",
|
||||
"@backstage/cli-module-info": "workspace:^",
|
||||
"@backstage/cli-module-lint": "workspace:^",
|
||||
"@backstage/cli-module-maintenance": "workspace:^",
|
||||
"@backstage/cli-module-migrate": "workspace:^",
|
||||
"@backstage/cli-module-new": "workspace:^",
|
||||
"@backstage/cli-module-test-jest": "workspace:^",
|
||||
"@backstage/cli-module-translations": "workspace:^",
|
||||
"@backstage/cli-defaults": "workspace:^",
|
||||
"@backstage/cli-node": "workspace:^",
|
||||
"@backstage/errors": "workspace:^",
|
||||
"@backstage/eslint-plugin": "workspace:^",
|
||||
|
||||
@@ -35,22 +35,13 @@ import { discoverCliModules } from './wiring/discoverCliModules';
|
||||
`No CLI modules found in the project root dependencies. ` +
|
||||
`Falling back to the built-in set of modules.\n` +
|
||||
`This fallback will be removed in a future release. ` +
|
||||
`Please add the CLI modules you need as devDependencies ` +
|
||||
`in your root package.json.\n`,
|
||||
`Please add @backstage/cli-defaults as a devDependency ` +
|
||||
`in your root package.json, or install individual ` +
|
||||
`@backstage/cli-module-* packages for fine-grained control.\n`,
|
||||
),
|
||||
);
|
||||
|
||||
initializer.add(import('@backstage/cli-module-build'));
|
||||
initializer.add(import('@backstage/cli-module-config'));
|
||||
initializer.add(import('@backstage/cli-module-create-github-app'));
|
||||
initializer.add(import('@backstage/cli-module-info'));
|
||||
initializer.add(import('@backstage/cli-module-lint'));
|
||||
initializer.add(import('@backstage/cli-module-maintenance'));
|
||||
initializer.add(import('@backstage/cli-module-migrate'));
|
||||
initializer.add(import('@backstage/cli-module-new'));
|
||||
initializer.add(import('@backstage/cli-module-test-jest'));
|
||||
initializer.add(import('@backstage/cli-module-translations'));
|
||||
initializer.add(import('@backstage/cli-module-auth'));
|
||||
initializer.add(import('@backstage/cli-defaults'));
|
||||
}
|
||||
|
||||
await initializer.run();
|
||||
|
||||
@@ -39,18 +39,23 @@ function isNodeHidden(node: CommandNode): boolean {
|
||||
return children.every(child => isNodeHidden(child));
|
||||
}
|
||||
|
||||
type UninitializedFeature = CliModule | Promise<{ default: CliModule }>;
|
||||
type UninitializedFeature =
|
||||
| CliModule
|
||||
| CliModule[]
|
||||
| Promise<{ default: CliModule | CliModule[] }>;
|
||||
|
||||
export class CliInitializer {
|
||||
private graph = new CommandGraph();
|
||||
private commandRegistry = new CommandRegistry(this.graph);
|
||||
#uninitiazedFeatures: Promise<CliModule>[] = [];
|
||||
#uninitiazedFeatures: Promise<CliModule | CliModule[]>[] = [];
|
||||
|
||||
add(feature: UninitializedFeature) {
|
||||
if (isPromise(feature)) {
|
||||
this.#uninitiazedFeatures.push(
|
||||
feature.then(f => unwrapFeature(f.default)),
|
||||
);
|
||||
} else if (Array.isArray(feature)) {
|
||||
this.#uninitiazedFeatures.push(Promise.resolve(feature));
|
||||
} else {
|
||||
this.#uninitiazedFeatures.push(Promise.resolve(feature));
|
||||
}
|
||||
@@ -68,9 +73,14 @@ export class CliInitializer {
|
||||
}
|
||||
|
||||
async #doInit() {
|
||||
const features = await Promise.all(this.#uninitiazedFeatures);
|
||||
for (const feature of features) {
|
||||
await this.#register(feature);
|
||||
const resolved = await Promise.all(this.#uninitiazedFeatures);
|
||||
for (const featureOrArray of resolved) {
|
||||
const features = Array.isArray(featureOrArray)
|
||||
? featureOrArray
|
||||
: [featureOrArray];
|
||||
for (const feature of features) {
|
||||
await this.#register(feature);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -186,8 +196,12 @@ export class CliInitializer {
|
||||
|
||||
/** @internal */
|
||||
export function unwrapFeature(
|
||||
feature: CliModule | { default: CliModule },
|
||||
): CliModule {
|
||||
feature: CliModule | CliModule[] | { default: CliModule | CliModule[] },
|
||||
): CliModule | CliModule[] {
|
||||
if (Array.isArray(feature)) {
|
||||
return feature;
|
||||
}
|
||||
|
||||
if ('$$type' in feature) {
|
||||
return feature;
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user