From f39dfd344b8291b3459d6464aff8e554428a9322 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fredrik=20Adel=C3=B6w?= Date: Mon, 11 Mar 2024 15:25:59 +0100 Subject: [PATCH] tweak the cli template descriptions a bit for clarity MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Fredrik Adelöw --- .changeset/yellow-mirrors-breathe.md | 5 +++++ packages/cli/src/lib/new/factories/backendModule.ts | 3 ++- packages/cli/src/lib/new/factories/nodeLibraryPackage.ts | 3 ++- packages/cli/src/lib/new/factories/webLibraryPackage.ts | 3 ++- 4 files changed, 11 insertions(+), 3 deletions(-) create mode 100644 .changeset/yellow-mirrors-breathe.md diff --git a/.changeset/yellow-mirrors-breathe.md b/.changeset/yellow-mirrors-breathe.md new file mode 100644 index 0000000000..bba1b90551 --- /dev/null +++ b/.changeset/yellow-mirrors-breathe.md @@ -0,0 +1,5 @@ +--- +'@backstage/cli': patch +--- + +Tweak the descriptions of the CLI templates diff --git a/packages/cli/src/lib/new/factories/backendModule.ts b/packages/cli/src/lib/new/factories/backendModule.ts index 1450e7b6ce..698146a229 100644 --- a/packages/cli/src/lib/new/factories/backendModule.ts +++ b/packages/cli/src/lib/new/factories/backendModule.ts @@ -38,7 +38,8 @@ type Options = { export const backendModule = createFactory({ name: 'backend-module', - description: 'A new backend module', + description: + 'A new backend module that extends an existing backend plugin with additional features', optionsDiscovery: async () => ({ codeOwnersPath: await getCodeownersFilePath(paths.targetRoot), }), diff --git a/packages/cli/src/lib/new/factories/nodeLibraryPackage.ts b/packages/cli/src/lib/new/factories/nodeLibraryPackage.ts index 3fae1242a2..687caa7cd5 100644 --- a/packages/cli/src/lib/new/factories/nodeLibraryPackage.ts +++ b/packages/cli/src/lib/new/factories/nodeLibraryPackage.ts @@ -31,7 +31,8 @@ type Options = { export const nodeLibraryPackage = createFactory({ name: 'node-library', - description: 'A new node-library package', + description: + 'A new node-library package, exporting shared functionality for backend plugins and modules', optionsDiscovery: async () => ({ codeOwnersPath: await getCodeownersFilePath(paths.targetRoot), }), diff --git a/packages/cli/src/lib/new/factories/webLibraryPackage.ts b/packages/cli/src/lib/new/factories/webLibraryPackage.ts index 8f4488926d..45e1085ff3 100644 --- a/packages/cli/src/lib/new/factories/webLibraryPackage.ts +++ b/packages/cli/src/lib/new/factories/webLibraryPackage.ts @@ -31,7 +31,8 @@ type Options = { export const webLibraryPackage = createFactory({ name: 'web-library', - description: 'A new web-library package', + description: + 'A new web-library package, exporting shared functionality for frontend plugins', optionsDiscovery: async () => ({ codeOwnersPath: await getCodeownersFilePath(paths.targetRoot), }),