@backstage/cli 0.8.2 → 0.10.1

package/dist/cjs/{testCommand-e32fbd45.cjs.js → testCommand-1c515cf7.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-b2152549.cjs.js');
+var run = require('./run-8388d249.cjs.js');
 require('commander');
 require('chalk');
 require('fs-extra');
@@ -44,5 +44,5 @@ var testCommand = async (cmd) => {
   await require("jest").run(args);
 };
 
-exports.default = testCommand;
-//# sourceMappingURL=testCommand-e32fbd45.cjs.js.map
+exports["default"] = testCommand;
+//# sourceMappingURL=testCommand-1c515cf7.cjs.js.map

package/dist/cjs/{validate-9523a11e.cjs.js → validate-9907afbb.cjs.js}

@@ -1,9 +1,9 @@
 'use strict';
 
-var config = require('./config-24fce3c1.cjs.js');
+var config = require('./config-91083c1e.cjs.js');
 require('@backstage/config-loader');
 require('@backstage/config');
-require('./index-6fee1c9a.cjs.js');
+require('./index-b2152549.cjs.js');
 require('commander');
 require('chalk');
 require('fs-extra');
@@ -21,5 +21,5 @@ var validate = async (cmd) => {
   });
 };
 
-exports.default = validate;
-//# sourceMappingURL=validate-9523a11e.cjs.js.map
+exports["default"] = validate;
+//# sourceMappingURL=validate-9907afbb.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-b2152549.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.10.1",
   "private": false,
   "publishConfig": {
     "access": "public"
@@ -28,19 +28,19 @@
     "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/errors": "^0.1.4",
+    "@backstage/config-loader": "^0.8.1",
+    "@backstage/errors": "^0.1.5",
     "@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-json": "^4.0.2",
+    "@rollup/plugin-commonjs": "^21.0.1",
+    "@rollup/plugin-json": "^4.1.0",
     "@rollup/plugin-node-resolve": "^13.0.0",
-    "@rollup/plugin-yaml": "^3.0.0",
+    "@rollup/plugin-yaml": "^3.1.0",
     "@spotify/eslint-config-base": "^12.0.0",
     "@spotify/eslint-config-react": "^12.0.0",
     "@spotify/eslint-config-typescript": "^12.0.0",
@@ -62,7 +62,7 @@
     "css-loader": "^5.2.6",
     "dashify": "^2.0.0",
     "diff": "^5.0.0",
-    "esbuild": "^0.8.56",
+    "esbuild": "^0.14.1",
     "eslint": "^7.30.0",
     "eslint-config-prettier": "^8.3.0",
     "eslint-formatter-friendly": "^7.0.0",
@@ -82,27 +82,26 @@
     "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",
     "ora": "^5.3.0",
     "postcss": "^8.1.0",
     "process": "^0.11.10",
-    "react": "^16.0.0",
-    "react-dev-utils": "^11.0.4",
+    "react-dev-utils": "^12.0.0-next.47",
     "react-hot-loader": "^4.12.21",
     "recursive-readdir": "^2.2.2",
     "replace-in-file": "^6.0.0",
-    "rollup": "2.44.x",
-    "rollup-plugin-dts": "^3.0.1",
-    "rollup-plugin-esbuild": "2.6.x",
+    "rollup": "^2.60.2",
+    "rollup-plugin-dts": "^4.0.1",
+    "rollup-plugin-esbuild": "^4.7.2",
     "rollup-plugin-peer-deps-external": "^2.2.2",
     "rollup-plugin-postcss": "^4.0.0",
     "rollup-pluginutils": "^2.8.2",
     "run-script-webpack-plugin": "^0.0.11",
     "semver": "^7.3.2",
-    "style-loader": "^1.2.1",
+    "style-loader": "^3.3.1",
     "sucrase": "^3.20.2",
     "tar": "^6.1.2",
     "terser-webpack-plugin": "^5.1.3",
@@ -117,14 +116,14 @@
     "yn": "^4.0.0"
   },
   "devDependencies": {
-    "@backstage/backend-common": "^0.9.9",
+    "@backstage/backend-common": "^0.9.13",
     "@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/theme": "^0.2.13",
+    "@backstage/core-app-api": "^0.2.0",
+    "@backstage/core-components": "^0.8.0",
+    "@backstage/core-plugin-api": "^0.3.0",
+    "@backstage/dev-utils": "^0.2.14",
+    "@backstage/test-utils": "^0.1.24",
+    "@backstage/theme": "^0.2.14",
     "@types/diff": "^5.0.0",
     "@types/express": "^4.17.6",
     "@types/fs-extra": "^9.0.1",
@@ -234,5 +233,5 @@
       }
     }
   },
-  "gitHead": "5bdaccc40b4a814cf0b45d429f15a3afacc2f60b"
+  "gitHead": "562be0b43016294e27af3ad024191bb86b13b1c1"
 }

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-backend-plugin/src/run.ts.hbs

@@ -18,7 +18,7 @@ import { getRootLogger } from '@backstage/backend-common';
 import yn from 'yn';
 import { startStandaloneServer } from './service/standaloneServer';
 
-const port = process.env.PLUGIN_PORT ? Number(process.env.PLUGIN_PORT) : 7000;
+const port = process.env.PLUGIN_PORT ? Number(process.env.PLUGIN_PORT) : 7007;
 const enableCors = yn(process.env.PLUGIN_CORS, { default: false });
 const logger = getRootLogger();
 

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",
@@ -30,10 +32,11 @@
     "@material-ui/core": "{{versionQuery '@material-ui/core' '4.12.2'}}",
     "@material-ui/icons": "{{versionQuery '@material-ui/icons' '4.9.1'}}",
     "@material-ui/lab": "{{versionQuery '@material-ui/lab' '4.0.0-alpha.57'}}",
-    "react": "{{versionQuery 'react' '16.13.1'}}",
-    "react-dom": "{{versionQuery 'react-dom' '16.13.1'}}",
     "react-use": "{{versionQuery 'react-use' '17.2.4'}}"
   },
+  "peerDependencies": {
+    "react": "{{versionQuery 'react' '^16.13.1 || ^17.0.0'}}"
+  },
   "devDependencies": {
     "@backstage/cli": "{{versionQuery '@backstage/cli'}}",
     "@backstage/core-app-api": "{{versionQuery '@backstage/core-app-api'}}",

package/templates/default-plugin/src/routes.ts.hbs

@@ -1,5 +1,5 @@
 import { createRouteRef } from '@backstage/core-plugin-api';
 
 export const rootRouteRef = createRouteRef({
-  title: '{{ id }}',
+  id: '{{ id }}',
 });

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

package/dist/cjs/buildImage-6b35526c.cjs.js

@@ -1,77 +0,0 @@
-'use strict';
-
-var chalk = require('chalk');
-var fs = require('fs-extra');
-var path = require('path');
-var index$1 = require('./index-26bec8ac.cjs.js');
-var index = require('./index-6fee1c9a.cjs.js');
-var run = require('./run-59c4395e.cjs.js');
-var parallel = require('./parallel-a4714c72.cjs.js');
-require('os');
-require('tar');
-require('commander');
-require('semver');
-require('@backstage/cli-common');
-require('@backstage/config/package.json');
-require('@backstage/errors');
-require('child_process');
-require('util');
-
-function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
-
-var fs__default = /*#__PURE__*/_interopDefaultLegacy(fs);
-
-const PKG_PATH = "package.json";
-var buildImage = async (cmd) => {
-  if (cmd.args.includes("--help")) {
-    await run.run("docker", ["image", "build", "--help"]);
-    return;
-  }
-  console.warn(chalk.yellow(`
-The backend:build-image command is deprecated and will be removed in the future.
-Please use the backend:bundle command instead along with your own Docker setup.
-
-  https://backstage.io/docs/deployment/docker
-`));
-  const pkgPath = index.paths.resolveTarget(PKG_PATH);
-  const pkg = await fs__default['default'].readJson(pkgPath);
-  const appConfigs = await findAppConfigs();
-  const npmrc = await fs__default['default'].pathExists(index.paths.resolveTargetRoot(".npmrc")) ? [".npmrc"] : [];
-  const tempDistWorkspace = await index$1.createDistWorkspace([pkg.name], {
-    buildDependencies: Boolean(cmd.build),
-    files: [
-      "package.json",
-      "yarn.lock",
-      ...npmrc,
-      ...appConfigs,
-      {src: index.paths.resolveTarget("Dockerfile"), dest: "Dockerfile"}
-    ],
-    parallel: parallel.parseParallel(process.env[parallel.PARALLEL_ENV_VAR]),
-    skeleton: "skeleton.tar"
-  });
-  console.log(`Dist workspace ready at ${tempDistWorkspace}`);
-  await run.run("docker", ["image", "build", ".", ...cmd.args], {
-    cwd: tempDistWorkspace
-  });
-  await fs__default['default'].remove(tempDistWorkspace);
-};
-async function findAppConfigs() {
-  const files = [];
-  for (const name of await fs__default['default'].readdir(index.paths.targetRoot)) {
-    if (name.startsWith("app-config.") && name.endsWith(".yaml")) {
-      files.push(name);
-    }
-  }
-  if (index.paths.targetRoot !== index.paths.targetDir) {
-    const dirPath = path.relative(index.paths.targetRoot, index.paths.targetDir);
-    for (const name of await fs__default['default'].readdir(index.paths.targetDir)) {
-      if (name.startsWith("app-config.") && name.endsWith(".yaml")) {
-        files.push(path.join(dirPath, name));
-      }
-    }
-  }
-  return files;
-}
-
-exports.default = buildImage;
-//# sourceMappingURL=buildImage-6b35526c.cjs.js.map