@backstage/repo-tools 0.1.4-next.1 → 0.2.0-next.2

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @backstage/repo-tools
 
+## 0.2.0-next.2
+
+### Minor Changes
+
+- a876e69b20e: Adding two new commands to support OpenAPI spec writing, `schema:openapi:generate` to generate the Typescript file that `@backstage/backend-openapi-utils` needs for typing and `schema:openapi:verify` to verify that this file exists and matches your `src/schema/openapi.yaml` file.
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/cli-common@0.1.12
+  - @backstage/errors@1.1.5
+
 ## 0.1.4-next.1
 
 ### Patch Changes

package/dist/cjs/{api-reports-f39f7b2c.cjs.js → api-reports-6ef2363c.cjs.js}

@@ -1,8 +1,8 @@
 'use strict';
 
-var fs = require('fs-extra');
 var path = require('path');
 var child_process = require('child_process');
+var fs = require('fs-extra');
 var apiExtractor = require('@microsoft/api-extractor');
 var tsdoc = require('@microsoft/tsdoc');
 var tsdocConfig = require('@microsoft/tsdoc-config');
@@ -12,52 +12,19 @@ var DocTable = require('@microsoft/api-documenter/lib/nodes/DocTable');
 var DocTableRow = require('@microsoft/api-documenter/lib/nodes/DocTableRow');
 var DocHeading = require('@microsoft/api-documenter/lib/nodes/DocHeading');
 var CustomMarkdownEmitter = require('@microsoft/api-documenter/lib/markdown/CustomMarkdownEmitter');
-var cliCommon = require('@backstage/cli-common');
-var g = require('glob');
-var isGlob = require('is-glob');
-var util = require('util');
+var paths = require('./paths-5e048aab.cjs.js');
 var minimatch = require('minimatch');
 var entryPoints = require('./entryPoints-c9b88245.cjs.js');
+require('@backstage/cli-common');
+require('glob');
+require('is-glob');
+require('util');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
 var fs__default = /*#__PURE__*/_interopDefaultLegacy(fs);
-var g__default = /*#__PURE__*/_interopDefaultLegacy(g);
-var isGlob__default = /*#__PURE__*/_interopDefaultLegacy(isGlob);
 var minimatch__default = /*#__PURE__*/_interopDefaultLegacy(minimatch);
 
-const glob = util.promisify(g__default["default"]);
-const paths = cliCommon.findPaths(__dirname);
-async function resolvePackagePath(packagePath) {
-  const fullPackageDir = paths.resolveTargetRoot(packagePath);
-  try {
-    const stat = await fs__default["default"].stat(fullPackageDir);
-    if (!stat.isDirectory()) {
-      return void 0;
-    }
-    const packageJsonPath = path.join(fullPackageDir, "package.json");
-    await fs__default["default"].access(packageJsonPath);
-  } catch (e) {
-    console.log(`folder omitted: ${fullPackageDir}, cause: ${e}`);
-    return void 0;
-  }
-  return path.relative(paths.targetRoot, fullPackageDir);
-}
-async function findPackageDirs(selectedPaths = []) {
-  const packageDirs = new Array();
-  for (const packageRoot of selectedPaths) {
-    const dirs = isGlob__default["default"](packageRoot) ? await glob(packageRoot, { cwd: paths.targetRoot }) : [packageRoot];
-    for (const dir of dirs) {
-      const packageDir = await resolvePackagePath(dir);
-      if (!packageDir) {
-        continue;
-      }
-      packageDirs.push(packageDir);
-    }
-  }
-  return packageDirs;
-}
-
 var __accessCheck = (obj, member, msg) => {
   if (!member.has(obj))
     throw TypeError("Cannot " + msg);
@@ -77,7 +44,7 @@ var __privateSet = (obj, member, value, setter) => {
   return value;
 };
 var _tokens;
-const tmpDir = paths.resolveTargetRoot(
+const tmpDir = paths.paths.resolveTargetRoot(
   "./node_modules/.cache/api-extractor"
 );
 const {
@@ -161,7 +128,7 @@ ApiReportGenerator.generateReviewFileContent = function decoratedGenerateReviewF
   );
   try {
     const prettier = require("prettier");
-    const config = (_a = prettier.resolveConfig.sync(paths.targetRoot)) != null ? _a : {};
+    const config = (_a = prettier.resolveConfig.sync(paths.paths.targetRoot)) != null ? _a : {};
     return prettier.format(content, {
       ...config,
       parser: "markdown"
@@ -171,7 +138,7 @@ ApiReportGenerator.generateReviewFileContent = function decoratedGenerateReviewF
   }
 };
 async function createTemporaryTsConfig(includedPackageDirs) {
-  const path$1 = paths.resolveTargetRoot("tsconfig.tmp.json");
+  const path$1 = paths.paths.resolveTargetRoot("tsconfig.tmp.json");
   process.once("exit", () => {
     fs__default["default"].removeSync(path$1);
   });
@@ -250,7 +217,7 @@ async function findPackageEntryPoints(packageDirs) {
     packageDirs.map(async (packageDir) => {
       var _a, _b, _c, _d;
       const pkg = await fs__default["default"].readJson(
-        paths.resolveTargetRoot(packageDir, "package.json")
+        paths.paths.resolveTargetRoot(packageDir, "package.json")
       );
       return (_d = (_a = entryPoints.getPackageExportNames(pkg)) == null ? void 0 : _a.map((name) => ({ packageDir, name }))) != null ? _d : {
         packageDir,
@@ -274,7 +241,7 @@ async function runApiExtraction({
   await fs__default["default"].remove(outputDir);
   const packageEntryPoints = await findPackageEntryPoints(packageDirs);
   const entryPoints = packageEntryPoints.map(({ packageDir, name }) => {
-    return paths.resolveTargetRoot(
+    return paths.paths.resolveTargetRoot(
       `./dist-types/${packageDir}/src/${name}.d.ts`
     );
   });
@@ -294,8 +261,8 @@ async function runApiExtraction({
   } of packageEntryPoints) {
     console.log(`## Processing ${packageDir}`);
     const noBail = Array.isArray(allowWarnings) ? allowWarnings.some((aw) => aw === packageDir || minimatch__default["default"](packageDir, aw)) : allowWarnings;
-    const projectFolder = paths.resolveTargetRoot(packageDir);
-    const packageFolder = paths.resolveTargetRoot(
+    const projectFolder = paths.paths.resolveTargetRoot(packageDir);
+    const packageFolder = paths.paths.resolveTargetRoot(
       "./dist-types",
       packageDir
     );
@@ -908,7 +875,7 @@ async function categorizePackageDirs(packageDirs) {
         if (!dir) {
           return;
         }
-        const pkgJson = await fs__default["default"].readJson(paths.resolveTargetRoot(dir, "package.json")).catch((error) => {
+        const pkgJson = await fs__default["default"].readJson(paths.paths.resolveTargetRoot(dir, "package.json")).catch((error) => {
           if (error.code === "ENOENT") {
             return void 0;
           }
@@ -1044,7 +1011,7 @@ async function runCliExtraction({
 }) {
   for (const packageDir of packageDirs) {
     console.log(`## Processing ${packageDir}`);
-    const fullDir = paths.resolveTargetRoot(packageDir);
+    const fullDir = paths.paths.resolveTargetRoot(packageDir);
     const pkgJson = await fs__default["default"].readJson(path.resolve(fullDir, "package.json"));
     if (!pkgJson.bin) {
       throw new Error(`CLI Package in ${packageDir} has no bin field`);
@@ -1079,7 +1046,7 @@ async function runCliExtraction({
           console.log("");
           console.log(
             `The conflicting file is ${path.relative(
-              paths.targetRoot,
+              paths.paths.targetRoot,
               reportPath
             )}, expecting the following content:`
           );
@@ -1094,7 +1061,7 @@ async function runCliExtraction({
 }
 
 async function generateTypeDeclarations(tsconfigFilePath) {
-  await fs__default["default"].remove(paths.resolveTargetRoot("dist-types"));
+  await fs__default["default"].remove(paths.paths.resolveTargetRoot("dist-types"));
   const { status } = child_process.spawnSync(
     "yarn",
     [
@@ -1106,7 +1073,7 @@ async function generateTypeDeclarations(tsconfigFilePath) {
     {
       stdio: "inherit",
       shell: true,
-      cwd: paths.targetRoot
+      cwd: paths.paths.targetRoot
     }
   );
   if (status !== 0) {
@@ -1115,7 +1082,7 @@ async function generateTypeDeclarations(tsconfigFilePath) {
 }
 
 const buildApiReports = async (paths$1 = [], opts) => {
-  const tmpDir = paths.resolveTargetRoot(
+  const tmpDir = paths.paths.resolveTargetRoot(
     "./node_modules/.cache/api-extractor"
   );
   const isCiBuild = opts.ci;
@@ -1125,8 +1092,7 @@ const buildApiReports = async (paths$1 = [], opts) => {
   const allowAllWarnings = opts.allowAllWarnings;
   const omitMessages = parseArrayOption(opts.omitMessages);
   const isAllPackages = !(paths$1 == null ? void 0 : paths$1.length);
-  const selectedPaths = isAllPackages ? await getWorkspacePackagePathPatterns() : paths$1;
-  const selectedPackageDirs = await findPackageDirs(selectedPaths);
+  const selectedPackageDirs = await paths.getMatchingWorkspacePaths(paths$1);
   if (isAllPackages && !isCiBuild && !isDocsBuild) {
     console.log("");
     console.log(
@@ -1142,7 +1108,7 @@ const buildApiReports = async (paths$1 = [], opts) => {
   if (!isAllPackages) {
     temporaryTsConfigPath = await createTemporaryTsConfig(selectedPackageDirs);
   }
-  const tsconfigFilePath = temporaryTsConfigPath != null ? temporaryTsConfigPath : paths.resolveTargetRoot("tsconfig.json");
+  const tsconfigFilePath = temporaryTsConfigPath != null ? temporaryTsConfigPath : paths.paths.resolveTargetRoot("tsconfig.json");
   if (runTsc) {
     console.log("# Compiling TypeScript");
     await generateTypeDeclarations(tsconfigFilePath);
@@ -1173,24 +1139,13 @@ const buildApiReports = async (paths$1 = [], opts) => {
     console.log("# Generating package documentation");
     await buildDocs({
       inputDir: tmpDir,
-      outputDir: paths.resolveTargetRoot("docs/reference")
+      outputDir: paths.paths.resolveTargetRoot("docs/reference")
     });
   }
 };
-async function getWorkspacePackagePathPatterns() {
-  var _a;
-  const pkgJson = await fs__default["default"].readJson(paths.resolveTargetRoot("package.json")).catch((error) => {
-    if (error.code === "ENOENT") {
-      return void 0;
-    }
-    throw error;
-  });
-  const workspaces = (_a = pkgJson == null ? void 0 : pkgJson.workspaces) == null ? void 0 : _a.packages;
-  return workspaces;
-}
 function parseArrayOption(value) {
   return value ? value.split(",").map((s) => s.trim()) : [];
 }
 
 exports.buildApiReports = buildApiReports;
-//# sourceMappingURL=api-reports-f39f7b2c.cjs.js.map
+//# sourceMappingURL=api-reports-6ef2363c.cjs.js.map

package/dist/cjs/constants-a9b2f484.cjs.js

@@ -0,0 +1,42 @@
+'use strict';
+
+var paths = require('./paths-5e048aab.cjs.js');
+var pLimit = require('p-limit');
+var path = require('path');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var pLimit__default = /*#__PURE__*/_interopDefaultLegacy(pLimit);
+
+async function runner(paths$1, command) {
+  const packages = await paths.getMatchingWorkspacePaths(paths$1);
+  const limit = pLimit__default["default"](5);
+  const resultsList = await Promise.all(
+    packages.map(
+      (pkg) => limit(async () => {
+        let resultText = "";
+        try {
+          console.log(`## Processing ${pkg}`);
+          await command(pkg);
+        } catch (err) {
+          resultText = err.message;
+        }
+        return {
+          relativeDir: path.relative(paths.paths.targetRoot, pkg),
+          resultText
+        };
+      })
+    )
+  );
+  return resultsList;
+}
+
+const YAML_SCHEMA_PATH = "src/schema/openapi.yaml";
+const TS_MODULE = "src/schema/openapi";
+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-a9b2f484.cjs.js.map

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

@@ -0,0 +1,66 @@
+'use strict';
+
+var fs = require('fs-extra');
+var YAML = require('js-yaml');
+var chalk = require('chalk');
+var path = require('path');
+var constants = require('./constants-a9b2f484.cjs.js');
+var util = require('util');
+var child_process = require('child_process');
+require('./paths-5e048aab.cjs.js');
+require('@backstage/cli-common');
+require('glob');
+require('is-glob');
+require('p-limit');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var fs__default = /*#__PURE__*/_interopDefaultLegacy(fs);
+var YAML__default = /*#__PURE__*/_interopDefaultLegacy(YAML);
+var chalk__default = /*#__PURE__*/_interopDefaultLegacy(chalk);
+
+const exec = util.promisify(child_process.exec);
+async function generate(directoryPath, config) {
+  const { skipMissingYamlFile } = config != null ? config : {};
+  const openapiPath = path.resolve(directoryPath, constants.YAML_SCHEMA_PATH);
+  if (!await fs__default["default"].pathExists(openapiPath)) {
+    if (skipMissingYamlFile) {
+      return;
+    }
+    throw new Error(`Could not find ${constants.YAML_SCHEMA_PATH} in root of directory.`);
+  }
+  const yaml = YAML__default["default"].load(await fs__default["default"].readFile(openapiPath, "utf8"));
+  const tsPath = path.resolve(directoryPath, constants.TS_SCHEMA_PATH);
+  await fs__default["default"].writeFile(
+    tsPath,
+    `export default ${JSON.stringify(yaml, null, 2)} as const`
+  );
+  await exec(`yarn backstage-cli package lint --fix ${tsPath}`);
+}
+async function bulkCommand(paths = []) {
+  const resultsList = await constants.runner(
+    paths,
+    (dir) => generate(dir, { skipMissingYamlFile: true })
+  );
+  let failed = false;
+  for (const { relativeDir, resultText } of resultsList) {
+    if (resultText) {
+      console.log();
+      console.log(
+        chalk__default["default"].red(
+          `OpenAPI yaml to Typescript generation failed in ${relativeDir}:`
+        )
+      );
+      console.log(resultText.trimStart());
+      failed = true;
+    }
+  }
+  if (failed) {
+    process.exit(1);
+  } else {
+    console.log(chalk__default["default"].green("Generated all files."));
+  }
+}
+
+exports.bulkCommand = bulkCommand;
+//# sourceMappingURL=generate-d9406b4d.cjs.js.map

package/dist/cjs/paths-5e048aab.cjs.js

@@ -0,0 +1,66 @@
+'use strict';
+
+var cliCommon = require('@backstage/cli-common');
+var path = require('path');
+var fs = require('fs-extra');
+var g = require('glob');
+var isGlob = require('is-glob');
+var util = require('util');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var fs__default = /*#__PURE__*/_interopDefaultLegacy(fs);
+var g__default = /*#__PURE__*/_interopDefaultLegacy(g);
+var isGlob__default = /*#__PURE__*/_interopDefaultLegacy(isGlob);
+
+const glob = util.promisify(g__default["default"]);
+const paths = cliCommon.findPaths(__dirname);
+async function resolvePackagePath(packagePath) {
+  const fullPackageDir = paths.resolveTargetRoot(packagePath);
+  try {
+    const stat = await fs__default["default"].stat(fullPackageDir);
+    if (!stat.isDirectory()) {
+      return void 0;
+    }
+    const packageJsonPath = path.join(fullPackageDir, "package.json");
+    await fs__default["default"].access(packageJsonPath);
+  } catch (e) {
+    console.log(`folder omitted: ${fullPackageDir}, cause: ${e}`);
+    return void 0;
+  }
+  return path.relative(paths.targetRoot, fullPackageDir);
+}
+async function findPackageDirs(selectedPaths = []) {
+  const packageDirs = new Array();
+  for (const packageRoot of selectedPaths) {
+    const dirs = isGlob__default["default"](packageRoot) ? await glob(packageRoot, { cwd: paths.targetRoot }) : [packageRoot];
+    for (const dir of dirs) {
+      const packageDir = await resolvePackagePath(dir);
+      if (!packageDir) {
+        continue;
+      }
+      packageDirs.push(packageDir);
+    }
+  }
+  return packageDirs;
+}
+async function getWorkspacePackagePathPatterns() {
+  var _a;
+  const pkgJson = await fs__default["default"].readJson(paths.resolveTargetRoot("package.json")).catch((error) => {
+    if (error.code === "ENOENT") {
+      return void 0;
+    }
+    throw error;
+  });
+  const workspaces = (_a = pkgJson == null ? void 0 : pkgJson.workspaces) == null ? void 0 : _a.packages;
+  return workspaces;
+}
+async function getMatchingWorkspacePaths(cliPaths) {
+  const isAllPackages = !(cliPaths == null ? void 0 : cliPaths.length);
+  const selectedPaths = isAllPackages ? await getWorkspacePackagePathPatterns() : cliPaths;
+  return await findPackageDirs(selectedPaths);
+}
+
+exports.getMatchingWorkspacePaths = getMatchingWorkspacePaths;
+exports.paths = paths;
+//# sourceMappingURL=paths-5e048aab.cjs.js.map

package/dist/cjs/verify-47d1fef6.cjs.js

@@ -0,0 +1,83 @@
+'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 constants = require('./constants-a9b2f484.cjs.js');
+var paths = require('./paths-5e048aab.cjs.js');
+require('p-limit');
+require('@backstage/cli-common');
+require('glob');
+require('is-glob');
+require('util');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+function _interopNamespace(e) {
+  if (e && e.__esModule) return e;
+  var n = Object.create(null);
+  if (e) {
+    Object.keys(e).forEach(function (k) {
+      if (k !== 'default') {
+        var d = Object.getOwnPropertyDescriptor(e, k);
+        Object.defineProperty(n, k, d.get ? d : {
+          enumerable: true,
+          get: function () { return e[k]; }
+        });
+      }
+    });
+  }
+  n["default"] = e;
+  return Object.freeze(n);
+}
+
+var fs__default = /*#__PURE__*/_interopDefaultLegacy(fs);
+var YAML__default = /*#__PURE__*/_interopDefaultLegacy(YAML);
+var chalk__default = /*#__PURE__*/_interopDefaultLegacy(chalk);
+var Parser__default = /*#__PURE__*/_interopDefaultLegacy(Parser);
+
+async function verify(directoryPath) {
+  const openapiPath = path.join(directoryPath, constants.YAML_SCHEMA_PATH);
+  if (!await fs__default["default"].pathExists(openapiPath)) {
+    return;
+  }
+  const yaml = YAML__default["default"].load(await fs__default["default"].readFile(openapiPath, "utf8"));
+  await Parser__default["default"].validate(lodash.cloneDeep(yaml));
+  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.`);
+  }
+  const schema = await (function (t) { return Promise.resolve().then(function () { return /*#__PURE__*/_interopNamespace(require(t)); }); })(path.resolve(path.join(directoryPath, constants.TS_MODULE)));
+  if (!schema.default) {
+    throw new Error(`\`${constants.TS_SCHEMA_PATH}\` needs to have a default export.`);
+  }
+  if (!lodash.isEqual(schema.default, yaml)) {
+    const path$1 = path.relative(paths.paths.targetRoot, directoryPath);
+    throw new Error(
+      `\`${constants.YAML_SCHEMA_PATH}\` and \`${constants.TS_SCHEMA_PATH}\` do not match. Please run \`yarn backstage-repo-tools schema:openapi:generate ${path$1}\` to regenerate \`${constants.TS_SCHEMA_PATH}\`.`
+    );
+  }
+}
+async function bulkCommand(paths = []) {
+  const resultsList = await constants.runner(paths, (dir) => verify(dir));
+  let failed = false;
+  for (const { relativeDir, resultText } of resultsList) {
+    if (resultText) {
+      console.log();
+      console.log(chalk__default["default"].red(`OpenAPI validation failed in ${relativeDir}:`));
+      console.log(resultText.trimStart());
+      failed = true;
+    }
+  }
+  if (failed) {
+    process.exit(1);
+  } else {
+    console.log(chalk__default["default"].green("Verified all files."));
+  }
+}
+
+exports.bulkCommand = bulkCommand;
+//# sourceMappingURL=verify-47d1fef6.cjs.js.map

package/dist/index.cjs.js

@@ -53,10 +53,16 @@ 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-f39f7b2c.cjs.js'); }).then((m) => m.buildApiReports)
+      () => Promise.resolve().then(function () { return require('./cjs/api-reports-6ef2363c.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)));
+  program.command("schema:openapi:verify [paths...]").description(
+    "Verify that all OpenAPI schemas are valid and have a matching `schemas/openapi.ts` file."
+  ).action(lazy(() => Promise.resolve().then(function () { return require('./cjs/verify-47d1fef6.cjs.js'); }).then((m) => m.bulkCommand)));
+  program.command("schema:openapi: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-d9406b4d.cjs.js'); }).then((m) => m.bulkCommand)));
 }
 function lazy(getActionFunc) {
   return async (...args) => {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@backstage/repo-tools",
   "description": "CLI for Backstage repo tooling ",
-  "version": "0.1.4-next.1",
+  "version": "0.2.0-next.2",
   "publishConfig": {
     "access": "public"
   },
@@ -30,6 +30,7 @@
     "backstage-repo-tools": "bin/backstage-repo-tools"
   },
   "dependencies": {
+    "@apidevtools/swagger-parser": "^10.1.0",
     "@backstage/cli-common": "^0.1.12",
     "@backstage/errors": "^1.1.5",
     "@manypkg/get-packages": "^1.1.3",
@@ -40,11 +41,14 @@
     "fs-extra": "10.1.0",
     "glob": "^8.0.3",
     "is-glob": "^4.0.3",
+    "js-yaml": "^4.1.0",
+    "lodash": "^4.17.21",
     "minimatch": "^5.1.1",
+    "p-limit": "^3.0.2",
     "ts-node": "^10.0.0"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.22.6-next.1",
+    "@backstage/cli": "^0.22.6-next.3",
     "@backstage/types": "^1.0.2",
     "@types/is-glob": "^4.0.2",
     "@types/mock-fs": "^4.13.0",