@backstage/repo-tools 0.3.3-next.0 → 0.3.3

package/CHANGELOG.md

@@ -1,5 +1,27 @@
 # @backstage/repo-tools
 
+## 0.3.3
+
+### Patch Changes
+
+- 75702e85862a: Bumped `@microsoft/api-extractor` dependency to `^7.36.4`, and `@microsoft/api-documenter` to `^7.22.33`.
+- 1f3337ebc707: Introducing a new, experimental command `backstage-repo-tools generate-catalog-info`, which can be used to create standardized `catalog-info.yaml` files for each Backstage package in a Backstage monorepo. It can also be used to automatically fix existing `catalog-info.yaml` files with the correct metadata (including `metadata.name`, `metadata.title`, and `metadata.description` introspected from the package's `package.json`, as well as `spec.owner` introspected from `CODEOWNERS`), e.g. in a post-commit hook.
+- ebeb77586975: Update `schema openapi generate` command to now create a default router that can be imported and used directly.
+- Updated dependencies
+  - @backstage/cli-node@0.1.3
+  - @backstage/catalog-model@1.4.1
+  - @backstage/cli-common@0.1.12
+  - @backstage/errors@1.2.1
+
+## 0.3.3-next.1
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/cli-node@0.1.3-next.0
+  - @backstage/cli-common@0.1.12
+  - @backstage/errors@1.2.1
+
 ## 0.3.3-next.0
 
 ### Patch Changes

package/dist/cjs/generate-catalog-info-84fe20dd.cjs.js

@@ -0,0 +1,163 @@
+'use strict';
+
+var YAML = require('js-yaml');
+var pLimit = require('p-limit');
+var path = require('path');
+var yamlDiffPatch = require('yaml-diff-patch');
+var chalk = require('chalk');
+var cliNode = require('@backstage/cli-node');
+var codeownersUtils = require('codeowners-utils');
+var fs = require('fs');
+var util = require('util');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var YAML__default = /*#__PURE__*/_interopDefaultLegacy(YAML);
+var pLimit__default = /*#__PURE__*/_interopDefaultLegacy(pLimit);
+var chalk__default = /*#__PURE__*/_interopDefaultLegacy(chalk);
+var fs__default = /*#__PURE__*/_interopDefaultLegacy(fs);
+
+const readFile = util.promisify(fs__default["default"].readFile);
+const writeFile = util.promisify(fs__default["default"].writeFile);
+function isBackstagePackage(packageJson) {
+  var _a;
+  return packageJson && packageJson.hasOwnProperty("backstage") && ((_a = packageJson == null ? void 0 : packageJson.backstage) == null ? void 0 : _a.role) !== "undefined";
+}
+
+async function loadCodeowners() {
+  const maybeFiles = await Promise.allSettled(
+    codeownersUtils.CODEOWNERS_PATHS.map(
+      async (path$1) => readFile(path.resolve(".", path$1), { encoding: "utf-8" })
+    )
+  );
+  const file = maybeFiles.find(
+    (maybeFile) => maybeFile.status === "fulfilled"
+  );
+  if (!file) {
+    throw new Error(
+      "This utility expects a CODEOWNERS file, but no such file was found."
+    );
+  }
+  return codeownersUtils.parse(file.value);
+}
+function getPossibleCodeowners(codeowners, relPath) {
+  const codeownerMaybe = codeownersUtils.matchFile(relPath, codeowners);
+  return codeownerMaybe ? codeownerMaybe.owners.map(
+    (owner) => (owner.match(/(?:\@[^\/]+\/)?([^\@\/]*)$/) || [])[1]
+  ) : [];
+}
+function getOwnerFromCodeowners(codeowners, absPath) {
+  const relPath = path.relative(".", absPath);
+  const possibleOwners = getPossibleCodeowners(codeowners, relPath);
+  const owner = possibleOwners.slice(-1)[0];
+  if (!owner) {
+    throw new Error(`${relPath} isn't owned by anyone in CODEOWNERS`);
+  }
+  return owner;
+}
+
+var generateCatalogInfo = async (opts) => {
+  const { dryRun = false } = opts;
+  const packages = await cliNode.PackageGraph.listTargetPackages();
+  const codeowners = await loadCodeowners();
+  const limit = pLimit__default["default"](10);
+  const results = await Promise.allSettled(
+    packages.map(
+      ({ packageJson, dir }) => limit(async () => {
+        if (!isBackstagePackage(packageJson)) {
+          return;
+        }
+        const infoYamlPath = path.resolve(dir, "catalog-info.yaml");
+        let yamlString = "";
+        try {
+          yamlString = await readFile(infoYamlPath, { encoding: "utf-8" });
+        } catch (e) {
+          if (e.code === "ENOENT") {
+            await createCatalogInfoYaml({
+              yamlPath: infoYamlPath,
+              packageJson,
+              codeowners,
+              dryRun
+            });
+            return;
+          }
+          throw e;
+        }
+        await fixCatalogInfoYaml({
+          yamlPath: infoYamlPath,
+          packageJson,
+          codeowners,
+          yamlString,
+          dryRun
+        });
+      })
+    )
+  );
+  const rejects = results.filter(
+    (r) => r.status === "rejected"
+  );
+  if (rejects.length > 0) {
+    console.error(
+      chalk__default["default"].red("Unable to create or fix catalog-info.yaml files\n")
+    );
+    rejects.forEach((reject) => console.error(`  ${reject.reason}`));
+    console.error();
+    process.exit(1);
+  }
+};
+function createCatalogInfoYaml(options) {
+  const { codeowners, dryRun, packageJson, yamlPath } = options;
+  const owner = getOwnerFromCodeowners(codeowners, yamlPath);
+  const entity = createOrMergeEntity(packageJson, owner);
+  return dryRun ? Promise.resolve(console.error(`Create ${path.relative(".", yamlPath)}`)) : writeFile(yamlPath, YAML__default["default"].dump(entity));
+}
+function fixCatalogInfoYaml(options) {
+  var _a, _b, _c;
+  const { codeowners, dryRun, packageJson, yamlPath, yamlString } = options;
+  const possibleOwners = getPossibleCodeowners(
+    codeowners,
+    path.relative(".", yamlPath)
+  );
+  const safeName = packageJson.name.replace(/[^a-z0-9_\-\.]+/g, "-").replace(/^[^a-z0-9]|[^a-z0-9]$/g, "");
+  let yamlJson;
+  try {
+    yamlJson = YAML__default["default"].load(yamlString);
+  } catch (e) {
+    throw new Error(`Unable to parse ${path.relative(".", yamlPath)}: ${e}`);
+  }
+  const badOwner = !possibleOwners.includes((_a = yamlJson.spec) == null ? void 0 : _a.owner);
+  const badTitle = yamlJson.metadata.title !== packageJson.name;
+  const badName = yamlJson.metadata.name !== safeName;
+  const badType = ((_b = yamlJson.spec) == null ? void 0 : _b.type) !== `backstage-${packageJson.backstage.role}`;
+  const badDesc = yamlJson.metadata.description !== packageJson.description;
+  if (badOwner || badTitle || badName || badType || badDesc) {
+    const owner = badOwner ? getOwnerFromCodeowners(codeowners, yamlPath) : (_c = yamlJson.spec) == null ? void 0 : _c.owner;
+    const newJson = createOrMergeEntity(packageJson, owner, yamlJson);
+    return dryRun ? Promise.resolve(console.error(`Update ${path.relative(".", yamlPath)}`)) : writeFile(yamlPath, yamlDiffPatch.yamlOverwrite(yamlString, newJson));
+  }
+  return Promise.resolve();
+}
+function createOrMergeEntity(packageJson, owner, existingEntity = {}) {
+  const safeEntityName = packageJson.name.replace(/[^a-z0-9_\-\.]+/g, "-").replace(/^[^a-z0-9]|[^a-z0-9]$/g, "");
+  return {
+    ...existingEntity,
+    apiVersion: "backstage.io/v1alpha1",
+    kind: "Component",
+    metadata: {
+      ...existingEntity.metadata,
+      // Provide default name/title/description values.
+      name: safeEntityName,
+      title: packageJson.name,
+      ...packageJson.description ? { description: packageJson.description } : void 0
+    },
+    spec: {
+      lifecycle: "experimental",
+      ...existingEntity.spec,
+      type: `backstage-${packageJson.backstage.role}`,
+      owner
+    }
+  };
+}
+
+exports["default"] = generateCatalogInfo;
+//# sourceMappingURL=generate-catalog-info-84fe20dd.cjs.js.map

package/dist/index.cjs.js

@@ -86,6 +86,16 @@ function registerCommands(program) {
     )
   );
   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("generate-catalog-info").option(
+    "--dry-run",
+    "Shows what would happen without actually writing any yaml."
+  ).description("Create or fix info yaml files for all backstage packages").action(
+    lazy(
+      () => Promise.resolve().then(function () { return require('./cjs/generate-catalog-info-84fe20dd.cjs.js'); }).then(
+        (m) => m.default
+      )
+    )
+  );
   registerSchemaCommand(program);
 }
 function lazy(getActionFunc) {
@@ -101,7 +111,7 @@ function lazy(getActionFunc) {
   };
 }
 
-var version = "0.3.3-next.0";
+var version = "0.3.3";
 
 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.3.3-next.0",
+  "version": "0.3.3",
   "publishConfig": {
     "access": "public"
   },
@@ -32,12 +32,13 @@
   "dependencies": {
     "@apidevtools/swagger-parser": "^10.1.0",
     "@apisyouwonthate/style-guide": "^1.4.0",
+    "@backstage/catalog-model": "^1.4.1",
     "@backstage/cli-common": "^0.1.12",
-    "@backstage/cli-node": "^0.1.2",
+    "@backstage/cli-node": "^0.1.3",
     "@backstage/errors": "^1.2.1",
     "@manypkg/get-packages": "^1.1.3",
-    "@microsoft/api-documenter": "^7.19.27",
-    "@microsoft/api-extractor": "^7.33.7",
+    "@microsoft/api-documenter": "^7.22.33",
+    "@microsoft/api-extractor": "^7.36.4",
     "@stoplight/spectral-core": "^1.18.0",
     "@stoplight/spectral-formatters": "^1.1.0",
     "@stoplight/spectral-functions": "^1.7.2",
@@ -46,6 +47,7 @@
     "@stoplight/spectral-runtime": "^1.1.2",
     "@stoplight/types": "^13.14.0",
     "chalk": "^4.0.0",
+    "codeowners-utils": "^1.0.2",
     "commander": "^9.1.0",
     "fs-extra": "10.1.0",
     "glob": "^8.0.3",
@@ -54,10 +56,11 @@
     "lodash": "^4.17.21",
     "minimatch": "^5.1.1",
     "p-limit": "^3.0.2",
-    "ts-node": "^10.0.0"
+    "ts-node": "^10.0.0",
+    "yaml-diff-patch": "^2.0.0"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.22.10-next.0",
+    "@backstage/cli": "^0.22.10",
     "@backstage/types": "^1.1.0",
     "@types/is-glob": "^4.0.2",
     "@types/mock-fs": "^4.13.0",