cli: added node-library template

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

.changeset/pretty-steaks-serve.md

@@ -0,0 +1,5 @@
+---
+'@backstage/cli': patch
+---
+
+Added a template for creating `node-library` packages with `yarn new`.

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

@@ -17,6 +17,7 @@
 export { frontendPlugin } from './frontendPlugin';
 export { backendPlugin } from './backendPlugin';
 export { backendModule } from './backendModule';
+export { nodeLibraryPackage } from './nodeLibraryPackage';
 export { webLibraryPackage } from './webLibraryPackage';
 export { pluginCommon } from './pluginCommon';
 export { pluginNode } from './pluginNode';

packages/cli/src/lib/new/factories/nodeLibraryPackage.test.ts

@@ -0,0 +1,152 @@
+/*
+ * Copyright 2022 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, join as joinPath } from 'path';
+import { paths } from '../../paths';
+import { Task } from '../../tasks';
+import { FactoryRegistry } from '../FactoryRegistry';
+import { createMockOutputStream, mockPaths } from './common/testUtils';
+import { nodeLibraryPackage } from './nodeLibraryPackage';
+
+describe('nodeLibraryPackage factory', () => {
+  beforeEach(() => {
+    mockPaths({
+      targetRoot: '/root',
+    });
+  });
+
+  afterEach(() => {
+    mockFs.restore();
+    jest.resetAllMocks();
+  });
+
+  it('should create a node library package', async () => {
+    const expectedNodeLibraryPackageName = 'test';
+
+    mockFs({
+      '/root': {
+        packages: mockFs.directory(),
+      },
+      [paths.resolveOwn('templates')]: mockFs.load(
+        paths.resolveOwn('templates'),
+      ),
+    });
+
+    const options = await FactoryRegistry.populateOptions(nodeLibraryPackage, {
+      id: 'test', // name of node library package
+    });
+
+    let modified = false;
+
+    const [output, mockStream] = createMockOutputStream();
+    jest.spyOn(process, 'stderr', 'get').mockReturnValue(mockStream);
+    jest.spyOn(Task, 'forCommand').mockResolvedValue();
+
+    await nodeLibraryPackage.create(options, {
+      private: true,
+      isMonoRepo: true,
+      defaultVersion: '1.0.0',
+      markAsModified: () => {
+        modified = true;
+      },
+      createTemporaryDirectory: () => fs.mkdtemp('test'),
+    });
+
+    expect(modified).toBe(true);
+
+    expect(output).toEqual([
+      '',
+      `Creating node-library package ${expectedNodeLibraryPackageName}`,
+      'Checking Prerequisites:',
+      `availability  ${joinPath('packages', expectedNodeLibraryPackageName)}`,
+      'creating      temp dir',
+      'Executing Template:',
+      'copying       .eslintrc.js',
+      'templating    README.md.hbs',
+      'templating    package.json.hbs',
+      'templating    index.ts.hbs',
+      'copying       setupTests.ts',
+      'Installing:',
+      `moving        ${joinPath('packages', expectedNodeLibraryPackageName)}`,
+    ]);
+
+    await expect(
+      fs.readJson(
+        `/root/packages/${expectedNodeLibraryPackageName}/package.json`,
+      ),
+    ).resolves.toEqual(
+      expect.objectContaining({
+        name: expectedNodeLibraryPackageName,
+        private: true,
+        version: '1.0.0',
+      }),
+    );
+
+    expect(Task.forCommand).toHaveBeenCalledTimes(2);
+    expect(Task.forCommand).toHaveBeenCalledWith('yarn install', {
+      cwd: resolvePath(`/root/packages/${expectedNodeLibraryPackageName}`),
+      optional: true,
+    });
+    expect(Task.forCommand).toHaveBeenCalledWith('yarn lint --fix', {
+      cwd: resolvePath(`/root/packages/${expectedNodeLibraryPackageName}`),
+      optional: true,
+    });
+  });
+
+  it('should create a node library plugin with options and codeowners', async () => {
+    const expectedNodeLibraryPackageName = 'test';
+
+    mockFs({
+      '/root': {
+        CODEOWNERS: '',
+        packages: mockFs.directory(),
+      },
+      [paths.resolveOwn('templates')]: mockFs.load(
+        paths.resolveOwn('templates'),
+      ),
+    });
+
+    const options = await FactoryRegistry.populateOptions(nodeLibraryPackage, {
+      id: 'test',
+      owner: '@backstage/test-owners',
+    });
+
+    const [, mockStream] = createMockOutputStream();
+    jest.spyOn(process, 'stderr', 'get').mockReturnValue(mockStream);
+    jest.spyOn(Task, 'forCommand').mockResolvedValue();
+
+    await nodeLibraryPackage.create(options, {
+      scope: 'internal',
+      private: true,
+      isMonoRepo: false,
+      defaultVersion: '1.0.0',
+      markAsModified: () => {},
+      createTemporaryDirectory: () => fs.mkdtemp('test'),
+    });
+
+    expect(Task.forCommand).toHaveBeenCalledTimes(2);
+    expect(Task.forCommand).toHaveBeenCalledWith('yarn install', {
+      cwd: resolvePath(`/root/${expectedNodeLibraryPackageName}`),
+      optional: true,
+    });
+    expect(Task.forCommand).toHaveBeenCalledWith('yarn lint --fix', {
+      cwd: resolvePath(`/root/${expectedNodeLibraryPackageName}`),
+      optional: true,
+    });
+  });
+});

packages/cli/src/lib/new/factories/nodeLibraryPackage.ts

@@ -0,0 +1,71 @@
+/*
+ * Copyright 2022 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 chalk from 'chalk';
+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 nodeLibraryPackage = createFactory<Options>({
+  name: 'node-library',
+  description: 'A new node-library package',
+  optionsDiscovery: async () => ({
+    codeOwnersPath: await getCodeownersFilePath(paths.targetRoot),
+  }),
+  optionsPrompts: [pluginIdPrompt(), ownerPrompt()],
+  async create(options: Options, ctx: CreateContext) {
+    const { id } = options;
+    const name = ctx.scope ? `@${ctx.scope}/${id}` : `${id}`;
+
+    Task.log();
+    Task.log(`Creating node-library package ${chalk.cyan(name)}`);
+
+    const targetDir = ctx.isMonoRepo
+      ? paths.resolveTargetRoot('packages', id)
+      : paths.resolveTargetRoot(`${id}`);
+
+    await executePluginPackageTemplate(ctx, {
+      targetDir,
+      templateName: 'node-library-package',
+      values: {
+        id,
+        name,
+        pluginVersion: ctx.defaultVersion,
+        privatePackage: ctx.private,
+        npmRegistry: ctx.npmRegistry,
+      },
+    });
+
+    if (options.owner) {
+      await addCodeownersEntry(`/packages/${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/node-library-package/.eslintrc.js

@@ -0,0 +1 @@
+module.exports = require('@backstage/cli/config/eslint-factory')(__dirname);

packages/cli/templates/node-library-package/README.md.hbs

@@ -0,0 +1,12 @@
+# {{name}}
+
+_This package was created through the Backstage CLI_.
+
+## Installation
+
+Install the package via Yarn:
+
+```sh
+cd <package-dir> # if within a monorepo
+yarn add {{name}}
+```

packages/cli/templates/node-library-package/package.json.hbs

@@ -0,0 +1,36 @@
+{
+  "name": "{{name}}",
+  "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",
+    "types": "dist/index.d.ts"
+  },
+  "backstage": {
+    "role": "node-library"
+  },
+  "scripts": {
+    "start": "backstage-cli package start",
+    "build": "backstage-cli package build",
+    "lint": "backstage-cli package lint",
+    "test": "backstage-cli package test",
+    "clean": "backstage-cli package clean",
+    "prepack": "backstage-cli package prepack",
+    "postpack": "backstage-cli package postpack"
+  },
+  "devDependencies": {
+    "@backstage/cli": "{{versionQuery '@backstage/cli'}}"
+  },
+  "files": [
+    "dist"
+  ]
+}

packages/cli/templates/node-library-package/src/index.ts.hbs

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

packages/cli/templates/node-library-package/src/setupTests.ts

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

packages/cli/templates/node-library-package/tsconfig.json

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