cli: added create factory and template for plugin common package

Signed-off-by: Patrik Oldsberg <poldsberg@gmail.com>

packages/cli/src/lib/create/factories/index.ts

@@ -16,3 +16,4 @@
 
 export { frontendPlugin } from './frontendPlugin';
 export { backendPlugin } from './backendPlugin';
+export { pluginCommon } from './pluginCommon';

packages/cli/src/lib/create/factories/pluginCommon.test.ts

@@ -0,0 +1,123 @@
+/*
+ * Copyright 2021 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import fs from 'fs-extra';
+import mockFs from 'mock-fs';
+import { resolve as resolvePath } from 'path';
+import { WriteStream } from 'tty';
+import { paths } from '../../paths';
+import { Task } from '../../tasks';
+import { FactoryRegistry } from '../FactoryRegistry';
+import { pluginCommon } from './pluginCommon';
+
+function createMockOutputStream() {
+  const output = new Array<string>();
+  return [
+    output,
+    {
+      cursorTo: () => {},
+      clearLine: () => {},
+      moveCursor: () => {},
+      write: (msg: string) =>
+        // Clean up colors and whitespace
+        // eslint-disable-next-line no-control-regex
+        output.push(msg.replace(/\x1B\[\d\dm/g, '').trim()),
+    } as unknown as WriteStream & { fd: any },
+  ] as const;
+}
+
+describe('pluginCommon factory', () => {
+  beforeEach(() => {
+    jest.spyOn(paths, 'targetRoot', 'get').mockReturnValue('/root');
+    jest
+      .spyOn(paths, 'resolveTargetRoot')
+      .mockImplementation((...ps) => resolvePath('/root', ...ps));
+  });
+
+  afterEach(() => {
+    mockFs.restore();
+    jest.resetAllMocks();
+  });
+
+  it('should create a common plugin package', async () => {
+    mockFs({
+      '/root': {
+        plugins: mockFs.directory(),
+      },
+      [paths.resolveOwn('templates')]: mockFs.load(
+        paths.resolveOwn('templates'),
+      ),
+    });
+
+    const options = await FactoryRegistry.populateOptions(pluginCommon, {
+      id: 'test',
+    });
+
+    let modified = false;
+
+    const [output, mockStream] = createMockOutputStream();
+    jest.spyOn(process, 'stderr', 'get').mockReturnValue(mockStream);
+    jest.spyOn(Task, 'forCommand').mockResolvedValue();
+
+    await pluginCommon.create(options, {
+      private: true,
+      isMonoRepo: true,
+      defaultVersion: '1.0.0',
+      markAsModified: () => {
+        modified = true;
+      },
+      createTemporaryDirectory: () => fs.mkdtemp('test'),
+    });
+
+    expect(modified).toBe(true);
+
+    expect(output).toEqual([
+      'Checking Prerequisites:',
+      'availability  plugins/test-common ✔',
+      'creating      temp dir ✔',
+      'Executing Template:',
+      'copying       .eslintrc.js ✔',
+      'templating    README.md.hbs ✔',
+      'templating    package.json.hbs ✔',
+      'copying       tsconfig.json ✔',
+      'copying       index.ts ✔',
+      'copying       setupTests.ts ✔',
+      'Installing:',
+      'moving        plugins/test-common ✔',
+    ]);
+
+    await expect(
+      fs.readJson('/root/plugins/test-common/package.json'),
+    ).resolves.toEqual(
+      expect.objectContaining({
+        name: 'plugin-test-common',
+        description: 'Common functionalities for the test-common plugin',
+        private: true,
+        version: '1.0.0',
+      }),
+    );
+
+    expect(Task.forCommand).toHaveBeenCalledTimes(2);
+    expect(Task.forCommand).toHaveBeenCalledWith('yarn install', {
+      cwd: '/root/plugins/test-common',
+      optional: true,
+    });
+    expect(Task.forCommand).toHaveBeenCalledWith('yarn lint --fix', {
+      cwd: '/root/plugins/test-common',
+      optional: true,
+    });
+  });
+});

packages/cli/src/lib/create/factories/pluginCommon.ts

@@ -0,0 +1,67 @@
+/*
+ * Copyright 2021 The Backstage Authors
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+import { paths } from '../../paths';
+import { addCodeownersEntry, getCodeownersFilePath } from '../../codeowners';
+import { createFactory, CreateContext } from '../types';
+import { Task } from '../../tasks';
+import { ownerPrompt, pluginIdPrompt } from './common/prompts';
+import { executePluginPackageTemplate } from './common/tasks';
+
+type Options = {
+  id: string;
+  owner?: string;
+  codeOwnersPath?: string;
+};
+
+export const pluginCommon = createFactory<Options>({
+  name: 'plugin-common',
+  description: 'A new isomorphic common plugin package',
+  optionsDiscovery: async () => ({
+    codeOwnersPath: await getCodeownersFilePath(paths.targetRoot),
+  }),
+  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 targetDir = ctx.isMonoRepo
+      ? paths.resolveTargetRoot('plugins', id)
+      : paths.resolveTargetRoot(`backstage-plugin-${id}`);
+
+    await executePluginPackageTemplate(ctx, {
+      targetDir,
+      templateName: 'default-common-plugin-package',
+      values: {
+        id,
+        name,
+        privatePackage: ctx.private,
+        npmRegistry: ctx.npmRegistry,
+        pluginVersion: ctx.defaultVersion,
+      },
+    });
+
+    if (options.owner) {
+      await addCodeownersEntry(`/plugins/${id}`, options.owner);
+    }
+
+    await Task.forCommand('yarn install', { cwd: targetDir, optional: true });
+    await Task.forCommand('yarn lint --fix', {
+      cwd: targetDir,
+      optional: true,
+    });
+  },
+});

packages/cli/templates/default-common-plugin-package/.eslintrc.js

@@ -0,0 +1,3 @@
+module.exports = {
+  extends: [require.resolve('@backstage/cli/config/eslint')],
+};

packages/cli/templates/default-common-plugin-package/README.md.hbs

@@ -0,0 +1,5 @@
+# {{name}}
+
+Welcome to the common package for the {{id}} plugin!
+
+_This plugin was created through the Backstage CLI_

packages/cli/templates/default-common-plugin-package/package.json.hbs

@@ -0,0 +1,32 @@
+{
+  "name": "{{name}}",
+  "description": "Common functionalities for the {{id}} plugin",
+  "version": "{{pluginVersion}}",
+  "main": "src/index.ts",
+  "types": "src/index.ts",
+  "license": "Apache-2.0",
+{{#if privatePackage}}  "private": {{privatePackage}},
+{{/if}}
+  "publishConfig": {
+{{#if npmRegistry}}    "registry": "{{npmRegistry}}",
+{{/if}}
+    "access": "public",
+    "main": "dist/index.cjs.js",
+    "module": "dist/index.esm.js",
+    "types": "dist/index.d.ts"
+  },
+  "scripts": {
+    "build": "backstage-cli build",
+    "lint": "backstage-cli lint",
+    "test": "backstage-cli test",
+    "prepack": "backstage-cli prepack",
+    "postpack": "backstage-cli postpack",
+    "clean": "backstage-cli clean"
+  },
+  "devDependencies": {
+    "@backstage/cli": "{{versionQuery '@backstage/cli'}}"
+  },
+  "files": [
+    "dist"
+  ]
+}

packages/cli/templates/default-common-plugin-package/src/index.ts

@@ -0,0 +1,16 @@
+/**
+ * Common functionalities for the {{id}} plugin.
+ */
+
+/**
+ * In this package you might for example declare types that are common
+ * between the frontend and backend plugin packages.
+ */
+export type CommonType = {
+  field: string
+}
+
+/**
+ * Or you might declare some common constants.
+ */
+export const COMMON_CONSTANT = 1

packages/cli/templates/default-common-plugin-package/src/setupTests.ts

@@ -0,0 +1 @@
+export {};

packages/cli/templates/default-common-plugin-package/tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "extends": "@backstage/cli/config/tsconfig.json",
+  "include": ["src"],
+  "exclude": ["node_modules"],
+  "compilerOptions": {
+    "outDir": "dist-types",
+    "rootDir": "."
+  }
+}