@backstage/repo-tools 0.10.0-next.2 → 0.11.0-next.0

package/CHANGELOG.md

@@ -1,5 +1,46 @@
 # @backstage/repo-tools
 
+## 0.11.0-next.0
+
+### Minor Changes
+
+- 47fdbb4: Adds a `--watch` mode to the `schema openapi generate` command for a better local schema writing experience.
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/backend-plugin-api@1.0.2-next.0
+  - @backstage/catalog-model@1.7.0
+  - @backstage/cli-common@0.1.14
+  - @backstage/cli-node@0.2.9
+  - @backstage/config-loader@1.9.1
+  - @backstage/errors@1.2.4
+
+## 0.10.0
+
+### Minor Changes
+
+- 30c2be9: Update @microsoft/api-extractor and use their api report resolution.
+  Change api report format from `api-report.md` to `report.api.md`
+- 8eb3033: Adds a new command `backstage-repo-tools peer-deps` for validating your usage of peer dependencies in your plugins. It currently supports react related peer dependencies. It also has a `--fix` mode for quickly fixing any issues that it finds.
+
+### Patch Changes
+
+- 1f6706f: Properly log instructions when APIs do not match
+- 35e735b: Fix issues with warnings in API reports not being checked or reported.
+
+  Due to the recent version bump of API Extractor you may now see a lot of `ae-undocumented` warnings,
+  these can be ignored using the `-o` option, for example, `backstage-repo-tools api-reports -o ae-undocumented,ae-wrong-input-file-type`.
+
+- 248793e: Updated dependency `@useoptic/optic` to `^1.0.0`.
+- Updated dependencies
+  - @backstage/cli-node@0.2.9
+  - @backstage/backend-plugin-api@1.0.1
+  - @backstage/catalog-model@1.7.0
+  - @backstage/cli-common@0.1.14
+  - @backstage/config-loader@1.9.1
+  - @backstage/errors@1.2.4
+
 ## 0.10.0-next.2
 
 ### Patch Changes

package/dist/commands/api-reports/api-extractor.cjs.js

@@ -250,7 +250,7 @@ async function runApiExtraction({
     for (const packageEntryPoint of packageEntryPoints) {
       const suffix = packageEntryPoint.name === "index" ? "" : `-${packageEntryPoint.name}`;
       const reportFileName = `report${suffix}`;
-      const reportPath = path.resolve(projectFolder, reportFileName);
+      const reportPath = path.resolve(projectFolder, `${reportFileName}.api.md`);
       const warningCountBefore = await countApiReportWarnings(reportPath);
       const extractorConfig = apiExtractor.ExtractorConfig.prepare({
         configObject: {

package/dist/commands/index.cjs.js

@@ -23,7 +23,7 @@ function registerPackageCommand(program) {
     "Command to generate a client and/or a server stub from an OpenAPI spec."
   ).option("--client-additional-properties [properties]").description(
     "Additional properties that can be passed to @openapitools/openapi-generator-cli"
-  ).action(
+  ).option("--watch").description("Watch the OpenAPI spec for changes and regenerate on save.").action(
     lazy(
       () => Promise.resolve().then(function () { return require('./package/schema/openapi/generate/index.cjs.js'); }).then((m) => m.command)
     )

package/dist/commands/package/schema/openapi/generate/client.cjs.js

@@ -14,7 +14,7 @@ function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'defau
 var chalk__default = /*#__PURE__*/_interopDefaultCompat(chalk);
 var fs__default = /*#__PURE__*/_interopDefaultCompat(fs);
 
-async function generate(outputDirectory, clientAdditionalProperties) {
+async function generate(outputDirectory, clientAdditionalProperties, abortSignal) {
   const resolvedOpenapiPath = await helpers.getPathToCurrentOpenApiSpec();
   const resolvedOutputDirectory = paths.paths.resolveTargetRoot(
     outputDirectory,
@@ -48,6 +48,7 @@ async function generate(outputDirectory, clientAdditionalProperties) {
       additionalProperties
     ],
     {
+      signal: abortSignal?.signal,
       maxBuffer: Number.MAX_VALUE,
       cwd: backendPluginApi.resolvePackagePath("@backstage/repo-tools"),
       env: {
@@ -56,11 +57,15 @@ async function generate(outputDirectory, clientAdditionalProperties) {
     }
   );
   await exec.exec(
-    `yarn backstage-cli package lint --fix ${resolvedOutputDirectory}`
+    `yarn backstage-cli package lint --fix ${resolvedOutputDirectory}`,
+    [],
+    { signal: abortSignal?.signal }
   );
   const prettier = paths.paths.resolveTargetRoot("node_modules/.bin/prettier");
   if (prettier) {
-    await exec.exec(`${prettier} --write ${resolvedOutputDirectory}`);
+    await exec.exec(`${prettier} --write ${resolvedOutputDirectory}`, [], {
+      signal: abortSignal?.signal
+    });
   }
   fs__default.default.removeSync(path.resolve(resolvedOutputDirectory, ".openapi-generator-ignore"));
   fs__default.default.rmSync(path.resolve(resolvedOutputDirectory, ".openapi-generator"), {
@@ -68,17 +73,29 @@ async function generate(outputDirectory, clientAdditionalProperties) {
     force: true
   });
 }
-async function command(outputPackage, clientAdditionalProperties) {
+async function command(outputPackage, clientAdditionalProperties, {
+  abortSignal,
+  isWatch = false
+} = {}) {
   try {
-    await generate(outputPackage, clientAdditionalProperties);
+    await generate(outputPackage, clientAdditionalProperties, abortSignal);
     console.log(
       chalk__default.default.green(`Generated client in ${outputPackage}/${constants.OUTPUT_PATH}`)
     );
   } catch (err) {
-    console.log();
-    console.log(chalk__default.default.red(`Client generation failed:`));
-    console.log(err);
-    process.exit(1);
+    if (err.name === "AbortError") {
+      console.debug("Server generation aborted.");
+      return;
+    }
+    if (isWatch) {
+      console.log(chalk__default.default.red(`Client generation failed:`));
+      console.group();
+      console.log(chalk__default.default.red(err.message));
+      console.groupEnd();
+    } else {
+      console.log(chalk__default.default.red(`Client generation failed.`));
+      console.log(chalk__default.default.red(err.message));
+    }
   }
 }
 

package/dist/commands/package/schema/openapi/generate/index.cjs.js

@@ -3,10 +3,15 @@
 var chalk = require('chalk');
 var client = require('./client.cjs.js');
 var server = require('./server.cjs.js');
+var chokidar = require('chokidar');
+var helpers = require('../../../../../lib/openapi/helpers.cjs.js');
+var lodash = require('lodash');
+var runner = require('../../../../../lib/runner.cjs.js');
 
 function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
 
 var chalk__default = /*#__PURE__*/_interopDefaultCompat(chalk);
+var chokidar__default = /*#__PURE__*/_interopDefaultCompat(chokidar);
 
 async function command(opts) {
   if (!opts.clientPackage && !opts.server) {
@@ -15,11 +20,64 @@ async function command(opts) {
     );
     process.exit(1);
   }
-  if (opts.clientPackage) {
-    await client.command(opts.clientPackage, opts.clientAdditionalProperties);
-  }
-  if (opts.server) {
-    await server.command();
+  const sharedCommand = async (abortSignal) => {
+    const resolvedOpenapiPath = await helpers.getPathToCurrentOpenApiSpec();
+    await helpers.loadAndValidateOpenApiYaml(resolvedOpenapiPath);
+    const promises = [];
+    const options = {
+      isWatch: opts.watch,
+      abortSignal
+    };
+    if (opts.clientPackage) {
+      promises.push(
+        client.command(
+          opts.clientPackage,
+          opts.clientAdditionalProperties,
+          options
+        )
+      );
+    }
+    if (opts.server) {
+      promises.push(server.command(options));
+    }
+    await Promise.all(promises);
+  };
+  if (opts.watch) {
+    try {
+      const resolvedOpenapiPath = await helpers.getPathToCurrentOpenApiSpec();
+      let abortController = new AbortController();
+      const watcher = chokidar__default.default.watch(resolvedOpenapiPath);
+      const debouncedCommand = lodash.debounce(() => {
+        console.log("Detected changes! Regenerating...");
+        abortController.abort();
+        abortController = new AbortController();
+        sharedCommand(abortController).catch((err) => {
+          console.error(chalk__default.default.red("Error: ", err));
+        });
+      }, 500);
+      watcher.on("change", () => {
+        debouncedCommand();
+      });
+      watcher.on("error", (error) => {
+        console.error("Error happened", error);
+      });
+      watcher.on("ready", async () => {
+        console.log(
+          "Watching for changes in OpenAPI spec. Press Ctrl+C to stop."
+        );
+      });
+      debouncedCommand();
+      await runner.block();
+    } catch (err) {
+      console.error(chalk__default.default.red("Error: ", err));
+      process.exit(1);
+    }
+  } else {
+    try {
+      await sharedCommand();
+    } catch (err) {
+      process.exit(1);
+    }
   }
 }
 

package/dist/commands/package/schema/openapi/generate/server.cjs.js

@@ -16,7 +16,7 @@ var YAML__default = /*#__PURE__*/_interopDefaultCompat(YAML);
 var chalk__default = /*#__PURE__*/_interopDefaultCompat(chalk);
 
 const exec = util.promisify(child_process.exec);
-async function generate() {
+async function generate(abortSignal) {
   const openapiPath = await helpers.getPathToCurrentOpenApiSpec();
   const yaml = YAML__default.default.load(await fs__default.default.readFile(openapiPath, "utf8"));
   const tsPath = paths.paths.resolveTarget(constants.TS_SCHEMA_PATH);
@@ -34,21 +34,37 @@ export const createOpenApiRouter = async (
 ) => createValidatedOpenApiRouter<typeof spec>(spec, options);
 `
   );
-  await exec(`yarn backstage-cli package lint --fix ${tsPath}`);
+  await exec(`yarn backstage-cli package lint --fix ${tsPath}`, {
+    signal: abortSignal?.signal
+  });
   if (await paths.paths.resolveTargetRoot("node_modules/.bin/prettier")) {
     await exec(`yarn prettier --write ${tsPath}`, {
-      cwd: paths.paths.targetRoot
+      cwd: paths.paths.targetRoot,
+      signal: abortSignal?.signal
     });
   }
 }
-async function command() {
+async function command({
+  abortSignal,
+  isWatch = false
+}) {
   try {
-    await generate();
-    console.log(chalk__default.default.green("Generated all files."));
+    await generate(abortSignal);
+    console.log(chalk__default.default.green("Generated server files."));
   } catch (err) {
-    console.log(chalk__default.default.red(`OpenAPI server stub generation failed.`));
-    console.log(err.message);
-    process.exit(1);
+    if (err.name === "AbortError") {
+      console.debug("Server generation aborted.");
+      return;
+    }
+    if (isWatch) {
+      console.log(chalk__default.default.red(`Server generation failed:`));
+      console.group();
+      console.log(chalk__default.default.red(err.message));
+      console.groupEnd();
+    } else {
+      console.log(chalk__default.default.red(err.message));
+      console.log(chalk__default.default.red(`OpenAPI server stub generation failed.`));
+    }
   }
 }
 

package/dist/commands/repo/schema/openapi/verify.cjs.js

@@ -1,11 +1,9 @@
 'use strict';
 
 var fs = require('fs-extra');
-var YAML = require('js-yaml');
 var lodash = require('lodash');
 var path = require('path');
 var chalk = require('chalk');
-var Parser = require('@apidevtools/swagger-parser');
 var runner = require('../../../../lib/runner.cjs.js');
 var paths = require('../../../../lib/paths.cjs.js');
 var constants = require('../../../../lib/openapi/constants.cjs.js');
@@ -14,9 +12,7 @@ var helpers = require('../../../../lib/openapi/helpers.cjs.js');
 function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
 
 var fs__default = /*#__PURE__*/_interopDefaultCompat(fs);
-var YAML__default = /*#__PURE__*/_interopDefaultCompat(YAML);
 var chalk__default = /*#__PURE__*/_interopDefaultCompat(chalk);
-var Parser__default = /*#__PURE__*/_interopDefaultCompat(Parser);
 
 async function verify(directoryPath) {
   let openapiPath = "";
@@ -25,8 +21,7 @@ async function verify(directoryPath) {
   } catch {
     return;
   }
-  const yaml = YAML__default.default.load(await fs__default.default.readFile(openapiPath, "utf8"));
-  await Parser__default.default.validate(lodash.cloneDeep(yaml));
+  const yaml = await helpers.loadAndValidateOpenApiYaml(openapiPath);
   const schemaPath = path.join(directoryPath, constants.TS_SCHEMA_PATH);
   if (!await fs__default.default.pathExists(schemaPath)) {
     throw new Error(`No \`${constants.TS_SCHEMA_PATH}\` file found.`);

package/dist/lib/openapi/helpers.cjs.js

@@ -4,6 +4,15 @@ var fs = require('fs-extra');
 var paths = require('../paths.cjs.js');
 var constants = require('./constants.cjs.js');
 var path = require('path');
+var YAML = require('js-yaml');
+var lodash = require('lodash');
+var Parser = require('@apidevtools/swagger-parser');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+var fs__default = /*#__PURE__*/_interopDefaultCompat(fs);
+var YAML__default = /*#__PURE__*/_interopDefaultCompat(YAML);
+var Parser__default = /*#__PURE__*/_interopDefaultCompat(Parser);
 
 const getPathToFile = async (directory, filename) => {
   return path.resolve(directory, filename);
@@ -23,10 +32,16 @@ const getPathToOpenApiSpec = async (directory) => {
 const getPathToCurrentOpenApiSpec = async () => {
   return await assertExists(await getRelativePathToFile(constants.YAML_SCHEMA_PATH));
 };
+async function loadAndValidateOpenApiYaml(path) {
+  const yaml = YAML__default.default.load(await fs__default.default.readFile(path, "utf8"));
+  await Parser__default.default.validate(lodash.cloneDeep(yaml));
+  return yaml;
+}
 
 exports.assertExists = assertExists;
 exports.getPathToCurrentOpenApiSpec = getPathToCurrentOpenApiSpec;
 exports.getPathToFile = getPathToFile;
 exports.getPathToOpenApiSpec = getPathToOpenApiSpec;
 exports.getRelativePathToFile = getRelativePathToFile;
+exports.loadAndValidateOpenApiYaml = loadAndValidateOpenApiYaml;
 //# sourceMappingURL=helpers.cjs.js.map

package/dist/lib/runner.cjs.js

@@ -43,6 +43,11 @@ async function runner(paths$1, command, options) {
   );
   return resultsList;
 }
+async function block() {
+  return new Promise(() => {
+  });
+}
 
+exports.block = block;
 exports.runner = runner;
 //# sourceMappingURL=runner.cjs.js.map

package/dist/package.json.cjs.js

@@ -1,6 +1,6 @@
 'use strict';
 
-var version = "0.10.0-next.2";
+var version = "0.11.0-next.0";
 
 exports.version = version;
 //# sourceMappingURL=package.json.cjs.js.map

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@backstage/repo-tools",
-  "version": "0.10.0-next.2",
+  "version": "0.11.0-next.0",
   "description": "CLI for Backstage repo tooling ",
   "backstage": {
     "role": "cli"
@@ -43,10 +43,10 @@
   "dependencies": {
     "@apidevtools/swagger-parser": "^10.1.0",
     "@apisyouwonthate/style-guide": "^1.4.0",
-    "@backstage/backend-plugin-api": "1.0.1-next.1",
+    "@backstage/backend-plugin-api": "1.0.2-next.0",
     "@backstage/catalog-model": "1.7.0",
     "@backstage/cli-common": "0.1.14",
-    "@backstage/cli-node": "0.2.9-next.0",
+    "@backstage/cli-node": "0.2.9",
     "@backstage/config-loader": "1.9.1",
     "@backstage/errors": "1.2.4",
     "@manypkg/get-packages": "^1.1.3",
@@ -62,6 +62,7 @@
     "@stoplight/types": "^14.0.0",
     "@useoptic/openapi-utilities": "^0.55.0",
     "chalk": "^4.0.0",
+    "chokidar": "^3.5.3",
     "codeowners-utils": "^1.0.2",
     "command-exists": "^1.2.9",
     "commander": "^12.0.0",
@@ -77,8 +78,8 @@
     "yaml-diff-patch": "^2.0.0"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "1.0.1-next.2",
-    "@backstage/cli": "0.28.0-next.2",
+    "@backstage/backend-test-utils": "1.0.3-next.0",
+    "@backstage/cli": "0.29.0-next.0",
     "@backstage/types": "1.1.1",
     "@types/is-glob": "^4.0.2",
     "@types/node": "^18.17.8",
@@ -88,7 +89,7 @@
     "@microsoft/api-extractor-model": "*",
     "@microsoft/tsdoc": "*",
     "@microsoft/tsdoc-config": "*",
-    "@useoptic/optic": "^0.50.7",
+    "@useoptic/optic": "^1.0.0",
     "prettier": "^2.8.1",
     "typescript": "> 3.0.0"
   },