@backstage/cli 0.8.2 → 0.9.0

package/dist/cjs/{tasks-9bd3e946.cjs.js → tasks-802f087f.cjs.js}

@@ -2,11 +2,14 @@
 
 var fs = require('fs-extra');
 var path = require('path');
+var index = require('./index-25ca4442.cjs.js');
 var chalk = require('chalk');
 var handlebars = require('handlebars');
 var ora = require('ora');
+var util = require('util');
 var recursive = require('recursive-readdir');
-var index = require('./index-6fee1c9a.cjs.js');
+var child_process = require('child_process');
+var errors = require('@backstage/errors');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
@@ -22,13 +25,13 @@ const USER_ID_RE = /^@[-\w]+$/;
 const EMAIL_RE = /^[^@]+@[-.\w]+\.[-\w]+$/i;
 const DEFAULT_OWNER = "@backstage/maintainers";
 async function getCodeownersFilePath(rootDir) {
-  const paths = [
+  const possiblePaths = [
     path__default['default'].join(rootDir, ".github", "CODEOWNERS"),
     path__default['default'].join(rootDir, ".gitlab", "CODEOWNERS"),
     path__default['default'].join(rootDir, "docs", "CODEOWNERS"),
     path__default['default'].join(rootDir, "CODEOWNERS")
   ];
-  for (const p of paths) {
+  for (const p of possiblePaths) {
     if (await fs__default['default'].pathExists(p)) {
       return p;
     }
@@ -51,8 +54,19 @@ function parseOwnerIds(spaceSeparatedOwnerIds) {
   }
   return ids;
 }
-async function addCodeownersEntry(codeownersFilePath, ownedPath, ownerIds) {
-  const allLines = (await fs__default['default'].readFile(codeownersFilePath, "utf8")).split("\n");
+async function addCodeownersEntry(ownedPath, ownerStr, codeownersFilePath) {
+  const ownerIds = parseOwnerIds(ownerStr);
+  if (!ownerIds || ownerIds.length === 0) {
+    return false;
+  }
+  let filePath = codeownersFilePath;
+  if (!filePath) {
+    filePath = await getCodeownersFilePath(index.paths.targetRoot);
+    if (!filePath) {
+      return false;
+    }
+  }
+  const allLines = (await fs__default['default'].readFile(filePath, "utf8")).split("\n");
   const commentLines = [];
   for (const line of allLines) {
     if (line[0] !== "#") {
@@ -75,24 +89,26 @@ async function addCodeownersEntry(codeownersFilePath, ownedPath, ownerIds) {
     return [entryPath, ...entry.ownerIds].join(" ");
   });
   const newLines = [...commentLines, "", ...newDeclarationLines, ""];
-  await fs__default['default'].writeFile(codeownersFilePath, newLines.join("\n"), "utf8");
+  await fs__default['default'].writeFile(filePath, newLines.join("\n"), "utf8");
+  return true;
 }
 
+const exec = util.promisify(child_process.exec);
 const TASK_NAME_MAX_LENGTH = 14;
 class Task {
   static log(name = "") {
-    process.stdout.write(`${chalk__default['default'].green(name)}
+    process.stderr.write(`${chalk__default['default'].green(name)}
 `);
   }
   static error(message = "") {
-    process.stdout.write(`
+    process.stderr.write(`
 ${chalk__default['default'].red(message)}
 
 `);
   }
   static section(name) {
     const title = chalk__default['default'].green(`${name}:`);
-    process.stdout.write(`
+    process.stderr.write(`
  ${title}
 `);
   }
@@ -107,13 +123,34 @@ ${chalk__default['default'].red(message)}
       color: "green"
     }).start();
     try {
-      await taskFunc();
+      const result = await taskFunc();
       spinner.succeed();
+      return result;
     } catch (error) {
       spinner.fail();
       throw error;
     }
   }
+  static async forCommand(command, options) {
+    try {
+      await Task.forItem("executing", command, async () => {
+        await exec(command, {cwd: options == null ? void 0 : options.cwd});
+      });
+    } catch (error) {
+      errors.assertError(error);
+      if (error.stderr) {
+        process.stderr.write(error.stderr);
+      }
+      if (error.stdout) {
+        process.stdout.write(error.stdout);
+      }
+      if (options == null ? void 0 : options.optional) {
+        Task.error(`Warning: Failed to execute command ${chalk__default['default'].cyan(command)}`);
+      } else {
+        throw new Error(`Failed to execute command '${chalk__default['default'].cyan(command)}', ${error}`);
+      }
+    }
+  }
 }
 async function templatingTask(templateDir, destinationDir, context, versionProvider) {
   const files = await recursive__default['default'](templateDir).catch((error) => {
@@ -127,7 +164,9 @@ async function templatingTask(templateDir, destinationDir, context, versionProvi
       await Task.forItem("templating", path.basename(file), async () => {
         const destination = destinationFile.replace(/\.hbs$/, "");
         const template = await fs__default['default'].readFile(file);
-        const compiled = handlebars__default['default'].compile(template.toString());
+        const compiled = handlebars__default['default'].compile(template.toString(), {
+          strict: true
+        });
         const contents = compiled({name: path.basename(destination), ...context}, {
           helpers: {
             versionQuery(name, versionHint) {
@@ -152,10 +191,37 @@ async function templatingTask(templateDir, destinationDir, context, versionProvi
     }
   }
 }
+async function addPackageDependency(path, options) {
+  try {
+    const pkgJson = await fs__default['default'].readJson(path);
+    const normalize = (obj) => {
+      if (Object.keys(obj).length === 0) {
+        return void 0;
+      }
+      return Object.fromEntries(Object.keys(obj).sort().map((key) => [key, obj[key]]));
+    };
+    pkgJson.dependencies = normalize({
+      ...pkgJson.dependencies,
+      ...options.dependencies
+    });
+    pkgJson.devDependencies = normalize({
+      ...pkgJson.devDependencies,
+      ...options.devDependencies
+    });
+    pkgJson.peerDependencies = normalize({
+      ...pkgJson.peerDependencies,
+      ...options.peerDependencies
+    });
+    await fs__default['default'].writeJson(path, pkgJson, {spaces: 2});
+  } catch (error) {
+    throw new Error(`Failed to add package dependencies, ${error}`);
+  }
+}
 
 exports.Task = Task;
 exports.addCodeownersEntry = addCodeownersEntry;
+exports.addPackageDependency = addPackageDependency;
 exports.getCodeownersFilePath = getCodeownersFilePath;
 exports.parseOwnerIds = parseOwnerIds;
 exports.templatingTask = templatingTask;
-//# sourceMappingURL=tasks-9bd3e946.cjs.js.map
+//# sourceMappingURL=tasks-802f087f.cjs.js.map

package/dist/cjs/{testCommand-e32fbd45.cjs.js → testCommand-11d07d1b.cjs.js}

@@ -1,7 +1,7 @@
 'use strict';
 
-var index = require('./index-6fee1c9a.cjs.js');
-var run = require('./run-59c4395e.cjs.js');
+var index = require('./index-25ca4442.cjs.js');
+var run = require('./run-924136d8.cjs.js');
 require('commander');
 require('chalk');
 require('fs-extra');
@@ -45,4 +45,4 @@ var testCommand = async (cmd) => {
 };
 
 exports.default = testCommand;
-//# sourceMappingURL=testCommand-e32fbd45.cjs.js.map
+//# sourceMappingURL=testCommand-11d07d1b.cjs.js.map

package/dist/cjs/{validate-9523a11e.cjs.js → validate-3cc188fa.cjs.js}

@@ -1,9 +1,9 @@
 'use strict';
 
-var config = require('./config-24fce3c1.cjs.js');
+var config = require('./config-10d49423.cjs.js');
 require('@backstage/config-loader');
 require('@backstage/config');
-require('./index-6fee1c9a.cjs.js');
+require('./index-25ca4442.cjs.js');
 require('commander');
 require('chalk');
 require('fs-extra');
@@ -22,4 +22,4 @@ var validate = async (cmd) => {
 };
 
 exports.default = validate;
-//# sourceMappingURL=validate-9523a11e.cjs.js.map
+//# sourceMappingURL=validate-3cc188fa.cjs.js.map

package/dist/index.cjs.js

@@ -2,7 +2,7 @@
 
 require('commander');
 require('chalk');
-require('./cjs/index-6fee1c9a.cjs.js');
+require('./cjs/index-25ca4442.cjs.js');
 require('fs-extra');
 require('semver');
 require('@backstage/cli-common');

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@backstage/cli",
   "description": "CLI for developing Backstage plugins and apps",
-  "version": "0.8.2",
+  "version": "0.9.0",
   "private": false,
   "publishConfig": {
     "access": "public"
@@ -28,16 +28,16 @@
     "backstage-cli": "bin/backstage-cli"
   },
   "dependencies": {
-    "@backstage/cli-common": "^0.1.5",
+    "@backstage/cli-common": "^0.1.6",
     "@backstage/config": "^0.1.11",
-    "@backstage/config-loader": "^0.7.2",
+    "@backstage/config-loader": "^0.8.0",
     "@backstage/errors": "^0.1.4",
     "@backstage/types": "^0.1.1",
     "@hot-loader/react-dom": "^16.13.0",
     "@lerna/package-graph": "^4.0.0",
     "@lerna/project": "^4.0.0",
     "@octokit/request": "^5.4.12",
-    "@rollup/plugin-commonjs": "^17.1.0",
+    "@rollup/plugin-commonjs": "^21.0.1",
     "@rollup/plugin-json": "^4.0.2",
     "@rollup/plugin-node-resolve": "^13.0.0",
     "@rollup/plugin-yaml": "^3.0.0",
@@ -82,7 +82,7 @@
     "jest": "^26.0.1",
     "jest-css-modules": "^2.1.0",
     "jest-transform-yaml": "^0.1.1",
-    "json-schema": "^0.3.0",
+    "json-schema": "^0.4.0",
     "lodash": "^4.17.21",
     "mini-css-extract-plugin": "^2.4.2",
     "node-libs-browser": "^2.2.1",
@@ -117,13 +117,13 @@
     "yn": "^4.0.0"
   },
   "devDependencies": {
-    "@backstage/backend-common": "^0.9.9",
+    "@backstage/backend-common": "^0.9.10",
     "@backstage/config": "^0.1.11",
-    "@backstage/core-app-api": "^0.1.20",
-    "@backstage/core-components": "^0.7.3",
-    "@backstage/core-plugin-api": "^0.1.13",
-    "@backstage/dev-utils": "^0.2.12",
-    "@backstage/test-utils": "^0.1.21",
+    "@backstage/core-app-api": "^0.1.21",
+    "@backstage/core-components": "^0.7.4",
+    "@backstage/core-plugin-api": "^0.2.0",
+    "@backstage/dev-utils": "^0.2.13",
+    "@backstage/test-utils": "^0.1.22",
     "@backstage/theme": "^0.2.13",
     "@types/diff": "^5.0.0",
     "@types/express": "^4.17.6",
@@ -234,5 +234,5 @@
       }
     }
   },
-  "gitHead": "5bdaccc40b4a814cf0b45d429f15a3afacc2f60b"
+  "gitHead": "ddfdcd2b44dc9848cf550cea5346d5f9916a36d9"
 }

package/templates/default-backend-plugin/package.json.hbs

@@ -4,41 +4,43 @@
   "main": "src/index.ts",
   "types": "src/index.ts",
   "license": "Apache-2.0",
-  {{#if privatePackage}} "private": {{privatePackage}},
-  {{/if}}
+{{#if privatePackage}}
+  "private": {{privatePackage}},
+{{/if}}
   "publishConfig": {
-    {{#if npmRegistry}} "registry": "{{npmRegistry}}",
-    {{/if}}
-      "access": "public",
-      "main": "dist/index.cjs.js",
-      "types": "dist/index.d.ts"
-    },
-    "scripts": {
-      "start": "backstage-cli backend:dev",
-      "build": "backstage-cli backend:build",
-      "lint": "backstage-cli lint",
-      "test": "backstage-cli test",
-      "prepack": "backstage-cli prepack",
-      "postpack": "backstage-cli postpack",
-      "clean": "backstage-cli clean"
-    },
-    "dependencies": {
-      "@backstage/backend-common": "{{versionQuery '@backstage/backend-common'}}",
-      "@backstage/config": "{{versionQuery '@backstage/config'}}",
-      "@types/express": "{{versionQuery '@types/express' '4.17.6'}}",
-      "express": "{{versionQuery 'express' '4.17.1'}}",
-      "express-promise-router": "{{versionQuery 'express-promise-router' '4.1.0'}}",
-      "winston": "{{versionQuery 'winston' '3.2.1'}}",
-      "cross-fetch": "{{versionQuery 'cross-fetch' '3.0.6'}}",
-      "yn": "{{versionQuery 'yn' '4.0.0'}}"
-    },
-    "devDependencies": {
-      "@backstage/cli": "{{versionQuery '@backstage/cli'}}",
-      "@types/supertest": "{{versionQuery '@types/supertest' '2.0.8'}}",
-      "supertest": "{{versionQuery 'supertest' '4.0.2'}}",
-      "msw": "{{versionQuery 'msw' '0.35.0'}}"
-    },
-    "files": [
-      "dist"
-    ]
-  }
+{{#if npmRegistry}}
+    "registry": "{{npmRegistry}}",
+{{/if}}
+    "access": "public",
+    "main": "dist/index.cjs.js",
+    "types": "dist/index.d.ts"
+  },
+  "scripts": {
+    "start": "backstage-cli backend:dev",
+    "build": "backstage-cli backend:build",
+    "lint": "backstage-cli lint",
+    "test": "backstage-cli test",
+    "prepack": "backstage-cli prepack",
+    "postpack": "backstage-cli postpack",
+    "clean": "backstage-cli clean"
+  },
+  "dependencies": {
+    "@backstage/backend-common": "{{versionQuery '@backstage/backend-common'}}",
+    "@backstage/config": "{{versionQuery '@backstage/config'}}",
+    "@types/express": "{{versionQuery '@types/express' '4.17.6'}}",
+    "express": "{{versionQuery 'express' '4.17.1'}}",
+    "express-promise-router": "{{versionQuery 'express-promise-router' '4.1.0'}}",
+    "winston": "{{versionQuery 'winston' '3.2.1'}}",
+    "cross-fetch": "{{versionQuery 'cross-fetch' '3.0.6'}}",
+    "yn": "{{versionQuery 'yn' '4.0.0'}}"
+  },
+  "devDependencies": {
+    "@backstage/cli": "{{versionQuery '@backstage/cli'}}",
+    "@types/supertest": "{{versionQuery '@types/supertest' '2.0.8'}}",
+    "supertest": "{{versionQuery 'supertest' '4.0.2'}}",
+    "msw": "{{versionQuery 'msw' '0.35.0'}}"
+  },
+  "files": [
+    "dist"
+  ]
+}

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

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

package/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_

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

@@ -0,0 +1,34 @@
+{
+  "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"
+  ]
+}

package/templates/default-common-plugin-package/src/index.ts.hbs

@@ -0,0 +1,19 @@
+/***/
+/**
+ * Common functionalities for the {{id}} plugin.
+ *
+ * @packageDocumentation
+ */
+
+/**
+ * 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

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

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

package/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": "."
+  }
+}

package/templates/default-plugin/package.json.hbs

@@ -4,10 +4,12 @@
   "main": "src/index.ts",
   "types": "src/index.ts",
   "license": "Apache-2.0",
-{{#if privatePackage}}  "private": {{privatePackage}},
+{{#if privatePackage}}
+  "private": {{privatePackage}},
 {{/if}}
   "publishConfig": {
-{{#if npmRegistry}}    "registry": "{{npmRegistry}}",
+{{#if npmRegistry}}
+  "registry": "{{npmRegistry}}",
 {{/if}}
     "access": "public",
     "main": "dist/index.esm.js",

package/templates/scaffolder-module/.eslintrc.js

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

package/templates/scaffolder-module/README.md.hbs

@@ -0,0 +1,5 @@
+# {{name}}
+
+The {{id}} module for [@backstage/plugin-scaffolder-backend](https://www.npmjs.com/package/@backstage/plugin-scaffolder-backend).
+
+_This plugin was created through the Backstage CLI_

package/templates/scaffolder-module/package.json.hbs

@@ -0,0 +1,37 @@
+{
+  "name": "{{name}}",
+  "description": "The {{id}} module for @backstage/plugin-scaffolder-backend",
+  "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"
+  },
+  "scripts": {
+    "build": "backstage-cli build --output cjs,types",
+    "lint": "backstage-cli lint",
+    "test": "backstage-cli test",
+    "prepack": "backstage-cli prepack",
+    "postpack": "backstage-cli postpack",
+    "clean": "backstage-cli clean"
+  },
+  "dependencies": {
+    "@backstage/plugin-scaffolder-backend": "{{versionQuery '@backstage/plugin-scaffolder-backend'}}"
+  },
+  "devDependencies": {
+    "@backstage/backend-common": "{{versionQuery '@backstage/backend-common'}}",
+    "@backstage/cli": "{{versionQuery '@backstage/cli'}}"
+  },
+  "files": [
+    "dist"
+  ]
+}

package/templates/scaffolder-module/src/actions/example/example.test.ts

@@ -0,0 +1,50 @@
+/*
+ * 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 { PassThrough } from 'stream';
+import { createAcmeExampleAction } from './example';
+import { getVoidLogger } from '@backstage/backend-common';
+
+describe('acme:example', () => {
+  afterEach(() => {
+    jest.resetAllMocks();
+  });
+
+  it('should call action', async () => {
+    const action = createAcmeExampleAction();
+
+    const logger = getVoidLogger();
+    jest.spyOn(logger, 'info');
+
+    await action.handler({
+      input: {
+        myParameter: 'test',
+      },
+      workspacePath: '/tmp',
+      logger,
+      logStream: new PassThrough(),
+      output: jest.fn(),
+      createTemporaryDirectory() {
+        // Usage of mock-fs is recommended for testing of filesystem operations
+        throw new Error('Not implemented');
+      },
+    });
+
+    expect(logger.info).toHaveBeenCalledWith(
+      'Running example template with parameters: test',
+    );
+  });
+});

package/templates/scaffolder-module/src/actions/example/example.ts

@@ -0,0 +1,57 @@
+/*
+ * 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 { createTemplateAction } from '@backstage/plugin-scaffolder-backend';
+
+/**
+ * Creates an `acme:example` Scaffolder action.
+ *
+ * @remarks
+ *
+ * See {@link https://example.com} for more information.
+ *
+ * @public
+ */
+export function createAcmeExampleAction() {
+  // For more information on how to define custom actions, see
+  //   https://backstage.io/docs/features/software-templates/writing-custom-actions
+  return createTemplateAction<{
+    myParameter: string;
+  }>({
+    id: 'acme:example',
+    description: 'Runs Yeoman on an installed Yeoman generator',
+    schema: {
+      input: {
+        type: 'object',
+        required: ['myParameter'],
+        properties: {
+          myParameter: {
+            title: 'An example parameter',
+            description: 'This is the schema for our example parameter',
+            type: 'string',
+          },
+        },
+      },
+    },
+    async handler(ctx) {
+      ctx.logger.info(
+        `Running example template with parameters: ${ctx.input.myParameter}`,
+      );
+
+      await new Promise(resolve => setTimeout(resolve, 1000));
+    },
+  });
+}

package/templates/scaffolder-module/src/actions/example/index.ts

@@ -0,0 +1 @@
+export { createAcmeExampleAction } from './example';

package/templates/scaffolder-module/src/actions/index.ts

@@ -0,0 +1 @@
+export * from './example';

package/templates/scaffolder-module/src/index.ts.hbs

@@ -0,0 +1,8 @@
+/***/
+/**
+ * The {{id}} module for @backstage/plugin-scaffolder-backend.
+ *
+ * @packageDocumentation
+ */
+
+export * from './actions';

package/templates/scaffolder-module/tsconfig.json

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