Merge pull request #23474 from backstage/freben/templar

tweak the cli template descriptions a bit for clarity
backstage · Mar 11, 2024 · 580dcf8 · 580dcf8
2 parents 3938ab9 + f39dfd3
commit 580dcf8
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 3 deletions.
diff --git a/.changeset/yellow-mirrors-breathe.md 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
@@ -38,7 +38,8 @@ type Options = {
 
 export const backendModule = createFactory<Options>({
   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
@@ -31,7 +31,8 @@ type Options = {
 
 export const nodeLibraryPackage = createFactory<Options>({
   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
@@ -31,7 +31,8 @@ type Options = {
 
 export const webLibraryPackage = createFactory<Options>({
   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),
   }),