From bd3ae04de9e990ed9bad2c8051cb491721f18d94 Mon Sep 17 00:00:00 2001
From: Patrik Oldsberg <poldsberg@gmail.com>
Date: Sat, 13 Nov 2021 15:26:23 +0100
Subject: [PATCH] cli: fixes for common package factory

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>
---
 .../src/lib/create/factories/pluginCommon.test.ts   |  9 +++++++--
 .../cli/src/lib/create/factories/pluginCommon.ts    | 13 ++++++++-----
 .../src/{index.ts => index.ts.hbs}                  |  3 +++
 3 files changed, 18 insertions(+), 7 deletions(-)
 rename packages/cli/templates/default-common-plugin-package/src/{index.ts => index.ts.hbs} (90%)

diff --git a/packages/cli/src/lib/create/factories/pluginCommon.test.ts b/packages/cli/src/lib/create/factories/pluginCommon.test.ts
index 73edc5159b..e329e2588f 100644
--- a/packages/cli/src/lib/create/factories/pluginCommon.test.ts
+++ b/packages/cli/src/lib/create/factories/pluginCommon.test.ts
@@ -29,6 +29,11 @@ describe('pluginCommon factory', () => {
     });
   });
 
+  afterEach(() => {
+    mockFs.restore();
+    jest.resetAllMocks();
+  });
+
   it('should create a common plugin package', async () => {
     mockFs({
       '/root': {
@@ -72,7 +77,7 @@ describe('pluginCommon factory', () => {
       'templating    README.md.hbs ✔',
       'templating    package.json.hbs ✔',
       'copying       tsconfig.json ✔',
-      'copying       index.ts ✔',
+      'templating    index.ts.hbs ✔',
       'copying       setupTests.ts ✔',
       'Installing:',
       'moving        plugins/test-common ✔',
@@ -83,7 +88,7 @@ describe('pluginCommon factory', () => {
     ).resolves.toEqual(
       expect.objectContaining({
         name: 'plugin-test-common',
-        description: 'Common functionalities for the test-common plugin',
+        description: 'Common functionalities for the test plugin',
         private: true,
         version: '1.0.0',
       }),
diff --git a/packages/cli/src/lib/create/factories/pluginCommon.ts b/packages/cli/src/lib/create/factories/pluginCommon.ts
index 97b1eccec7..af42d74b0b 100644
--- a/packages/cli/src/lib/create/factories/pluginCommon.ts
+++ b/packages/cli/src/lib/create/factories/pluginCommon.ts
@@ -36,15 +36,18 @@ export const pluginCommon = createFactory<Options>({
   }),
   optionsPrompts: [pluginIdPrompt(), ownerPrompt()],
   async create(options: Options, ctx: CreateContext) {
-    const id = `${options.id}-common`;
-    const name = ctx.scope ? `@${ctx.scope}/plugin-${id}` : `plugin-${id}`;
+    const { id } = options;
+    const suffix = `${id}-common`;
+    const name = ctx.scope
+      ? `@${ctx.scope}/plugin-${suffix}`
+      : `plugin-${suffix}`;
 
     Task.log();
     Task.log(`Creating backend plugin ${chalk.cyan(name)}`);
 
     const targetDir = ctx.isMonoRepo
-      ? paths.resolveTargetRoot('plugins', id)
-      : paths.resolveTargetRoot(`backstage-plugin-${id}`);
+      ? paths.resolveTargetRoot('plugins', suffix)
+      : paths.resolveTargetRoot(`backstage-plugin-${suffix}`);
 
     await executePluginPackageTemplate(ctx, {
       targetDir,
@@ -59,7 +62,7 @@ export const pluginCommon = createFactory<Options>({
     });
 
     if (options.owner) {
-      await addCodeownersEntry(`/plugins/${id}`, options.owner);
+      await addCodeownersEntry(`/plugins/${suffix}`, options.owner);
     }
 
     await Task.forCommand('yarn install', { cwd: targetDir, optional: true });
diff --git a/packages/cli/templates/default-common-plugin-package/src/index.ts b/packages/cli/templates/default-common-plugin-package/src/index.ts.hbs
similarity index 90%
rename from packages/cli/templates/default-common-plugin-package/src/index.ts
rename to packages/cli/templates/default-common-plugin-package/src/index.ts.hbs
index 6ee452b5bb..2e1150d74e 100644
--- a/packages/cli/templates/default-common-plugin-package/src/index.ts
+++ b/packages/cli/templates/default-common-plugin-package/src/index.ts.hbs
@@ -1,5 +1,8 @@
+/***/
 /**
  * Common functionalities for the {{id}} plugin.
+ *
+ * @packageDocumentation
  */
 
 /**