@backstage/repo-tools 0.4.0 → 0.5.0-next.0

package/CHANGELOG.md

@@ -1,5 +1,20 @@
 # @backstage/repo-tools
 
+## 0.5.0-next.0
+
+### Minor Changes
+
+- aea8f8d329: **BREAKING**: API Reports generated for sub-path exports now place the name as a suffix rather than prefix, for example `api-report-alpha.md` instead of `alpha-api-report.md`. When upgrading to this version you'll need to re-create any such API reports and delete the old ones.
+- 38340678c3: Adds a new command `schema openapi generate-client` that creates a Typescript client with Backstage flavor, including the discovery API and fetch API. This command doesn't currently generate a complete client and needs to be wrapped or exported manually by a separate Backstage plugin. See `@backstage/catalog-client/src/generated` for example output.
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/catalog-model@1.4.3
+  - @backstage/cli-common@0.1.13
+  - @backstage/cli-node@0.2.0
+  - @backstage/errors@1.2.3
+
 ## 0.4.0
 
 ### Minor Changes

package/dist/cjs/{api-reports-2b0ee2bf.cjs.js → api-reports-0697bd2a.cjs.js}

@@ -263,8 +263,8 @@ async function runApiExtraction({
       "./dist-types",
       packageDir
     );
-    const prefix = name === "index" ? "" : `${name}-`;
-    const reportFileName = `${prefix}api-report.md`;
+    const suffix = name === "index" ? "" : `-${name}`;
+    const reportFileName = `api-report${suffix}.md`;
     const reportPath = path.resolve(projectFolder, reportFileName);
     const warningCountBefore = await countApiReportWarnings(reportPath);
     const extractorConfig = apiExtractor.ExtractorConfig.prepare({
@@ -280,7 +280,7 @@ async function runApiExtraction({
           reportFolder: projectFolder,
           reportTempFolder: path.resolve(
             outputDir,
-            `${prefix}<unscopedPackageName>`
+            `<unscopedPackageName>${suffix}`
           )
         },
         docModel: {
@@ -289,7 +289,7 @@ async function runApiExtraction({
           enabled: name === "index",
           apiJsonFilePath: path.resolve(
             outputDir,
-            `${prefix}<unscopedPackageName>.api.json`
+            `<unscopedPackageName>${suffix}.api.json`
           )
         },
         dtsRollup: {
@@ -1150,4 +1150,4 @@ function parseArrayOption(value) {
 }
 
 exports.buildApiReports = buildApiReports;
-//# sourceMappingURL=api-reports-2b0ee2bf.cjs.js.map
+//# sourceMappingURL=api-reports-0697bd2a.cjs.js.map

package/dist/cjs/constants-866c449d.cjs.js

@@ -0,0 +1,43 @@
+'use strict';
+
+const YAML_SCHEMA_PATH = "src/schema/openapi.yaml";
+const TS_MODULE = "src/schema/openapi.generated";
+const TS_SCHEMA_PATH = `${TS_MODULE}.ts`;
+const OUTPUT_PATH = "src/generated";
+const OPENAPI_IGNORE_FILES = [
+  // Get rid of the default files.
+  "*.md",
+  // The rest of these have to be explicit, otherwise they get added if this was a *.*
+  "apis/baseapi.ts",
+  "apis/exception.ts",
+  "auth/*",
+  "http/*",
+  "middleware.ts",
+  "servers.ts",
+  "util.ts",
+  "configuration.ts",
+  "rxjsStub.ts",
+  ".gitignore",
+  // Override the created version.
+  "apis/*.ts",
+  "!apis/*.client.ts",
+  "models/*.ts",
+  "!models/*.model.ts",
+  // Always include index.ts files.
+  "!index.ts",
+  "!**/index.ts",
+  // Weird API typings.
+  "types/ObjectParamAPI.ts",
+  "types/ObservableAPI.ts",
+  "types/PromiseAPI.ts",
+  "git_push.sh",
+  "package.json",
+  "tsconfig.json"
+];
+
+exports.OPENAPI_IGNORE_FILES = OPENAPI_IGNORE_FILES;
+exports.OUTPUT_PATH = OUTPUT_PATH;
+exports.TS_MODULE = TS_MODULE;
+exports.TS_SCHEMA_PATH = TS_SCHEMA_PATH;
+exports.YAML_SCHEMA_PATH = YAML_SCHEMA_PATH;
+//# sourceMappingURL=constants-866c449d.cjs.js.map

package/dist/cjs/{generate-f300e17f.cjs.js → generate-4d90ec26.cjs.js}

@@ -5,7 +5,8 @@ var YAML = require('js-yaml');
 var chalk = require('chalk');
 var path = require('path');
 var paths = require('./paths-9ab9b8a8.cjs.js');
-var constants = require('./constants-f7b16ffc.cjs.js');
+var runner = require('./runner-0e5fc9a8.cjs.js');
+var constants = require('./constants-866c449d.cjs.js');
 var util = require('util');
 var child_process = require('child_process');
 require('@backstage/cli-common');
@@ -52,7 +53,7 @@ export const createOpenApiRouter = async (
   }
 }
 async function bulkCommand(paths = []) {
-  const resultsList = await constants.runner(
+  const resultsList = await runner.runner(
     paths,
     (dir) => generate(dir, { skipMissingYamlFile: true })
   );
@@ -77,4 +78,4 @@ async function bulkCommand(paths = []) {
 }
 
 exports.bulkCommand = bulkCommand;
-//# sourceMappingURL=generate-f300e17f.cjs.js.map
+//# sourceMappingURL=generate-4d90ec26.cjs.js.map

package/dist/cjs/generate-be7745a5.cjs.js

@@ -0,0 +1,83 @@
+'use strict';
+
+var chalk = require('chalk');
+var path = require('path');
+var constants = require('./constants-866c449d.cjs.js');
+var paths = require('./paths-9ab9b8a8.cjs.js');
+var fs = require('fs-extra');
+var exec = require('./exec-7bf444eb.cjs.js');
+require('@backstage/cli-common');
+require('@backstage/cli-node');
+require('minimatch');
+require('util');
+require('child_process');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var chalk__default = /*#__PURE__*/_interopDefaultLegacy(chalk);
+var fs__default = /*#__PURE__*/_interopDefaultLegacy(fs);
+
+async function generate(spec, outputDirectory) {
+  const resolvedOpenapiPath = path.resolve(spec);
+  const resolvedOutputDirectory = path.resolve(outputDirectory, constants.OUTPUT_PATH);
+  fs.mkdirpSync(resolvedOutputDirectory);
+  await fs__default["default"].mkdirp(resolvedOutputDirectory);
+  await fs__default["default"].writeFile(
+    path.resolve(resolvedOutputDirectory, ".openapi-generator-ignore"),
+    constants.OPENAPI_IGNORE_FILES.join("\n")
+  );
+  await exec.exec(
+    // The actual main.js file for the binary isn't executable but yarn does _something_ to make it executable.
+    // TODO (sennyeya@): Make this use the actual binary
+    `yarn openapi-generator-cli`,
+    [
+      "generate",
+      "-i",
+      resolvedOpenapiPath,
+      "-o",
+      resolvedOutputDirectory,
+      "-g",
+      "typescript",
+      "-c",
+      "templates/typescript-backstage.yaml",
+      "--generator-key",
+      "v3.0"
+    ],
+    {
+      maxBuffer: Number.MAX_VALUE,
+      cwd: paths.paths.ownDir,
+      env: {
+        ...process.env
+        // PWD: outputDirectory,
+      }
+    }
+  );
+  await exec.exec(
+    `yarn backstage-cli package lint --fix ${resolvedOutputDirectory}`
+  );
+  if (paths.paths.resolveTargetRoot("node_modules/.bin/prettier")) {
+    await exec.exec(`yarn prettier --write ${resolvedOutputDirectory}`);
+  }
+  fs__default["default"].removeSync(path.resolve(resolvedOutputDirectory, ".openapi-generator-ignore"));
+  fs__default["default"].rmSync(path.resolve(resolvedOutputDirectory, ".openapi-generator"), {
+    recursive: true,
+    force: true
+  });
+}
+async function singleCommand({
+  inputSpec,
+  outputDirectory
+}) {
+  try {
+    await generate(inputSpec, outputDirectory);
+    console.log(chalk__default["default"].green(`Generated client for ${inputSpec}`));
+  } catch (err) {
+    console.log();
+    console.log(chalk__default["default"].red(`Client generation failed in ${outputDirectory}:`));
+    console.log(err);
+    process.exit(1);
+  }
+}
+
+exports.singleCommand = singleCommand;
+//# sourceMappingURL=generate-be7745a5.cjs.js.map

package/dist/cjs/{index-80206881.cjs.js → index-ed4aaab1.cjs.js}

@@ -3,7 +3,8 @@
 var fs = require('fs-extra');
 var path = require('path');
 var chalk = require('chalk');
-var constants = require('./constants-f7b16ffc.cjs.js');
+var runner = require('./runner-0e5fc9a8.cjs.js');
+var constants = require('./constants-866c449d.cjs.js');
 var paths = require('./paths-9ab9b8a8.cjs.js');
 var exec = require('./exec-7bf444eb.cjs.js');
 require('p-limit');
@@ -63,7 +64,7 @@ async function test(directoryPath, { port }, options) {
   }
 }
 async function bulkCommand(paths = [], options) {
-  const resultsList = await constants.runner(
+  const resultsList = await runner.runner(
     paths,
     (dir, runnerOptions) => test(dir, runnerOptions, options),
     {
@@ -92,4 +93,4 @@ async function bulkCommand(paths = [], options) {
 }
 
 exports.bulkCommand = bulkCommand;
-//# sourceMappingURL=index-80206881.cjs.js.map
+//# sourceMappingURL=index-ed4aaab1.cjs.js.map

package/dist/cjs/{init-1a47015e.cjs.js → init-9d8f5e0f.cjs.js}

@@ -2,15 +2,16 @@
 
 var fs = require('fs-extra');
 var path = require('path');
-var constants = require('./constants-f7b16ffc.cjs.js');
+var constants = require('./constants-866c449d.cjs.js');
 var paths = require('./paths-9ab9b8a8.cjs.js');
+var runner = require('./runner-0e5fc9a8.cjs.js');
 var chalk = require('chalk');
 var exec = require('./exec-7bf444eb.cjs.js');
-require('p-limit');
-require('portfinder');
 require('@backstage/cli-common');
 require('@backstage/cli-node');
 require('minimatch');
+require('p-limit');
+require('portfinder');
 require('util');
 require('child_process');
 
@@ -60,7 +61,7 @@ capture:
   }
 }
 async function initCommand(paths = []) {
-  const resultsList = await constants.runner(paths, (dir) => init(dir), {
+  const resultsList = await runner.runner(paths, (dir) => init(dir), {
     concurrencyLimit: 5
   });
   let failed = false;
@@ -82,4 +83,4 @@ async function initCommand(paths = []) {
 }
 
 exports["default"] = initCommand;
-//# sourceMappingURL=init-1a47015e.cjs.js.map
+//# sourceMappingURL=init-9d8f5e0f.cjs.js.map

package/dist/cjs/{lint-fa452310.cjs.js → lint-e06bf899.cjs.js}

@@ -6,7 +6,8 @@ var ruleset = require('@apisyouwonthate/style-guide');
 var fs = require('fs-extra');
 var chalk = require('chalk');
 var path = require('path');
-var constants = require('./constants-f7b16ffc.cjs.js');
+var runner = require('./runner-0e5fc9a8.cjs.js');
+var constants = require('./constants-866c449d.cjs.js');
 var spectralRulesets = require('@stoplight/spectral-rulesets');
 var types = require('@stoplight/types');
 var spectralFormatters = require('@stoplight/spectral-formatters');
@@ -69,7 +70,7 @@ async function lint(directoryPath, config) {
   }
 }
 async function bulkCommand(paths = [], options) {
-  const resultsList = await constants.runner(
+  const resultsList = await runner.runner(
     paths,
     (dir) => lint(dir, { skipMissingYamlFile: true, strict: !!options.strict })
   );
@@ -92,4 +93,4 @@ async function bulkCommand(paths = [], options) {
 }
 
 exports.bulkCommand = bulkCommand;
-//# sourceMappingURL=lint-fa452310.cjs.js.map
+//# sourceMappingURL=lint-e06bf899.cjs.js.map

package/dist/cjs/{constants-f7b16ffc.cjs.js → runner-0e5fc9a8.cjs.js}

@@ -45,12 +45,5 @@ async function runner(paths$1, command, options) {
   return resultsList;
 }
 
-const YAML_SCHEMA_PATH = "src/schema/openapi.yaml";
-const TS_MODULE = "src/schema/openapi.generated";
-const TS_SCHEMA_PATH = `${TS_MODULE}.ts`;
-
-exports.TS_MODULE = TS_MODULE;
-exports.TS_SCHEMA_PATH = TS_SCHEMA_PATH;
-exports.YAML_SCHEMA_PATH = YAML_SCHEMA_PATH;
 exports.runner = runner;
-//# sourceMappingURL=constants-f7b16ffc.cjs.js.map
+//# sourceMappingURL=runner-0e5fc9a8.cjs.js.map

package/dist/cjs/{verify-7bbbd05f.cjs.js → verify-fbf86a43.cjs.js}

@@ -6,8 +6,9 @@ var lodash = require('lodash');
 var path = require('path');
 var chalk = require('chalk');
 var Parser = require('@apidevtools/swagger-parser');
-var constants = require('./constants-f7b16ffc.cjs.js');
+var runner = require('./runner-0e5fc9a8.cjs.js');
 var paths = require('./paths-9ab9b8a8.cjs.js');
+var constants = require('./constants-866c449d.cjs.js');
 require('p-limit');
 require('portfinder');
 require('@backstage/cli-common');
@@ -62,7 +63,7 @@ async function verify(directoryPath) {
   }
 }
 async function bulkCommand(paths = []) {
-  const resultsList = await constants.runner(paths, (dir) => verify(dir));
+  const resultsList = await runner.runner(paths, (dir) => verify(dir));
   let failed = false;
   for (const { relativeDir, resultText } of resultsList) {
     if (resultText) {
@@ -80,4 +81,4 @@ async function bulkCommand(paths = []) {
 }
 
 exports.bulkCommand = bulkCommand;
-//# sourceMappingURL=verify-7bbbd05f.cjs.js.map
+//# sourceMappingURL=verify-fbf86a43.cjs.js.map

package/dist/index.cjs.js

@@ -49,16 +49,25 @@ function registerSchemaCommand(program) {
   const openApiCommand = command.command("openapi [command]").description("Tooling for OpenApi schema");
   openApiCommand.command("verify [paths...]").description(
     "Verify that all OpenAPI schemas are valid and have a matching `schemas/openapi.generated.ts` file."
-  ).action(lazy(() => Promise.resolve().then(function () { return require('./cjs/verify-7bbbd05f.cjs.js'); }).then((m) => m.bulkCommand)));
+  ).action(
+    lazy(() => Promise.resolve().then(function () { return require('./cjs/verify-fbf86a43.cjs.js'); }).then((m) => m.bulkCommand))
+  );
   openApiCommand.command("generate [paths...]").description(
     "Generates a Typescript file from an OpenAPI yaml spec. For use with the `@backstage/backend-openapi-utils` ApiRouter type."
-  ).action(lazy(() => Promise.resolve().then(function () { return require('./cjs/generate-f300e17f.cjs.js'); }).then((m) => m.bulkCommand)));
+  ).action(
+    lazy(() => Promise.resolve().then(function () { return require('./cjs/generate-4d90ec26.cjs.js'); }).then((m) => m.bulkCommand))
+  );
   openApiCommand.command("lint [paths...]").description("Lint OpenAPI schemas.").option(
     "--strict",
     "Fail on any linting severity messages, not just errors."
-  ).action(lazy(() => Promise.resolve().then(function () { return require('./cjs/lint-fa452310.cjs.js'); }).then((m) => m.bulkCommand)));
-  openApiCommand.command("test [paths...]").description("Test OpenAPI schemas against written tests").option("--update", "Update the spec on failure.").action(lazy(() => Promise.resolve().then(function () { return require('./cjs/index-80206881.cjs.js'); }).then((m) => m.bulkCommand)));
-  openApiCommand.command("init <paths...>").description("Creates any config needed for the test command.").action(lazy(() => Promise.resolve().then(function () { return require('./cjs/init-1a47015e.cjs.js'); }).then((m) => m.default)));
+  ).action(lazy(() => Promise.resolve().then(function () { return require('./cjs/lint-e06bf899.cjs.js'); }).then((m) => m.bulkCommand)));
+  openApiCommand.command("test [paths...]").description("Test OpenAPI schemas against written tests").option("--update", "Update the spec on failure.").action(lazy(() => Promise.resolve().then(function () { return require('./cjs/index-ed4aaab1.cjs.js'); }).then((m) => m.bulkCommand)));
+  openApiCommand.command("init <paths...>").description("Creates any config needed for the test command.").action(lazy(() => Promise.resolve().then(function () { return require('./cjs/init-9d8f5e0f.cjs.js'); }).then((m) => m.default)));
+  openApiCommand.command("generate-client").requiredOption("--input-spec <file>").requiredOption("--output-directory <directory>").action(
+    lazy(
+      () => Promise.resolve().then(function () { return require('./cjs/generate-be7745a5.cjs.js'); }).then((m) => m.singleCommand)
+    )
+  );
 }
 function registerCommands(program) {
   program.command("api-reports [paths...]").option("--ci", "CI run checks that there is no changes on API reports").option("--tsc", "executes the tsc compilation before extracting the APIs").option("--docs", "generates the api documentation").option(
@@ -84,7 +93,7 @@ function registerCommands(program) {
     "Turn on release tag validation for the public, beta, and alpha APIs"
   ).description("Generate an API report for selected packages").action(
     lazy(
-      () => Promise.resolve().then(function () { return require('./cjs/api-reports-2b0ee2bf.cjs.js'); }).then((m) => m.buildApiReports)
+      () => Promise.resolve().then(function () { return require('./cjs/api-reports-0697bd2a.cjs.js'); }).then((m) => m.buildApiReports)
     )
   );
   program.command("type-deps").description("Find inconsistencies in types of all packages and plugins").action(lazy(() => Promise.resolve().then(function () { return require('./cjs/type-deps-5eacd931.cjs.js'); }).then((m) => m.default)));
@@ -116,7 +125,7 @@ function lazy(getActionFunc) {
   };
 }
 
-var version = "0.4.0";
+var version = "0.5.0-next.0";
 
 const main = (argv) => {
   commander.program.name("backstage-repo-tools").version(version);

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@backstage/repo-tools",
   "description": "CLI for Backstage repo tooling ",
-  "version": "0.4.0",
+  "version": "0.5.0-next.0",
   "publishConfig": {
     "access": "public"
   },
@@ -39,6 +39,7 @@
     "@manypkg/get-packages": "^1.1.3",
     "@microsoft/api-documenter": "^7.22.33",
     "@microsoft/api-extractor": "^7.36.4",
+    "@openapitools/openapi-generator-cli": "^2.7.0",
     "@stoplight/spectral-core": "^1.18.0",
     "@stoplight/spectral-formatters": "^1.1.0",
     "@stoplight/spectral-functions": "^1.7.2",
@@ -61,7 +62,7 @@
     "yaml-diff-patch": "^2.0.0"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.24.0",
+    "@backstage/cli": "^0.25.0-next.1",
     "@backstage/types": "^1.1.1",
     "@types/is-glob": "^4.0.2",
     "@types/mock-fs": "^4.13.0",