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

package/CHANGELOG.md

@@ -1,5 +1,34 @@
 # @backstage/repo-tools
 
+## 0.10.0-next.2
+
+### Patch Changes
+
+- Updated dependencies
+  - @backstage/cli-node@0.2.9-next.0
+  - @backstage/backend-plugin-api@1.0.1-next.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.1
+
+### Minor Changes
+
+- 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
+- Updated dependencies
+  - @backstage/backend-plugin-api@1.0.1-next.0
+  - @backstage/catalog-model@1.7.0
+  - @backstage/cli-common@0.1.14
+  - @backstage/cli-node@0.2.8
+  - @backstage/config-loader@1.9.1
+  - @backstage/errors@1.2.4
+
 ## 0.10.0-next.0
 
 ### Minor Changes

package/dist/{cjs/api-reports-B3Gt_Fej.cjs.js → commands/api-reports/api-extractor.cjs.js}

@@ -12,15 +12,10 @@ 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 paths = require('./paths-BvbxdT_S.cjs.js');
+var paths = require('../../lib/paths.cjs.js');
 var minimatch = require('minimatch');
-var getPackageExportDetails = require('./getPackageExportDetails-FkT40JIH.cjs.js');
-var util = require('./util-BhlP_S3V.cjs.js');
-var child_process = require('child_process');
-require('@backstage/cli-common');
-require('@backstage/cli-node');
-require('os');
-require('p-limit');
+var getPackageExportDetails = require('../../lib/getPackageExportDetails.cjs.js');
+var util = require('../util.cjs.js');
 
 function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
 
@@ -344,11 +339,11 @@ async function runApiExtraction({
             shouldLogInstructions = true;
           }
           if (message.text.includes(
-            "You have changed the public API signature for this project."
+            "You have changed the API signature for this project."
           )) {
             shouldLogInstructions = true;
             const match = message.text.match(
-              /Please copy the file "(.*)" to "api-report\.api\.md"/
+              /Please copy the file "(.*)" to "report\.api\.md"/
             );
             if (match) {
               conflictingFile = match[1];
@@ -1036,96 +1031,11 @@ async function runCliExtraction({
   }
 }
 
-async function generateTypeDeclarations(tsconfigFilePath) {
-  await fs__default.default.remove(paths.paths.resolveTargetRoot("dist-types"));
-  const { status } = child_process.spawnSync(
-    "yarn",
-    [
-      "tsc",
-      ["--project", tsconfigFilePath],
-      ["--skipLibCheck", "false"],
-      ["--incremental", "false"]
-    ].flat(),
-    {
-      stdio: "inherit",
-      shell: true,
-      cwd: paths.paths.targetRoot
-    }
-  );
-  if (status !== 0) {
-    process.exit(status || void 0);
-  }
-}
-
-const buildApiReports = async (paths$1 = [], opts) => {
-  const tmpDir = paths.paths.resolveTargetRoot(
-    "./node_modules/.cache/api-extractor"
-  );
-  const isCiBuild = opts.ci;
-  const isDocsBuild = opts.docs;
-  const runTsc = opts.tsc;
-  const allowWarnings = parseArrayOption(opts.allowWarnings);
-  const allowAllWarnings = opts.allowAllWarnings;
-  const omitMessages = parseArrayOption(opts.omitMessages);
-  const isAllPackages = !paths$1?.length;
-  const selectedPackageDirs = await paths.resolvePackagePaths({
-    paths: paths$1,
-    include: opts.include,
-    exclude: opts.exclude
-  });
-  if (isAllPackages && !isCiBuild && !isDocsBuild) {
-    console.log("");
-    console.log(
-      "TIP: You can generate api-reports for select packages by passing package paths:"
-    );
-    console.log("");
-    console.log(
-      "       yarn build:api-reports packages/config packages/core-plugin-api plugins/*"
-    );
-    console.log("");
-  }
-  let temporaryTsConfigPath;
-  if (!isAllPackages) {
-    temporaryTsConfigPath = await createTemporaryTsConfig(selectedPackageDirs);
-  }
-  const tsconfigFilePath = temporaryTsConfigPath ?? paths.paths.resolveTargetRoot("tsconfig.json");
-  if (runTsc) {
-    console.log("# Compiling TypeScript");
-    await generateTypeDeclarations(tsconfigFilePath);
-  }
-  const { tsPackageDirs, cliPackageDirs } = await categorizePackageDirs(
-    selectedPackageDirs
-  );
-  if (tsPackageDirs.length > 0) {
-    console.log("# Generating package API reports");
-    await runApiExtraction({
-      packageDirs: tsPackageDirs,
-      outputDir: tmpDir,
-      isLocalBuild: !isCiBuild,
-      tsconfigFilePath,
-      allowWarnings: allowAllWarnings || allowWarnings,
-      omitMessages: Array.isArray(omitMessages) ? omitMessages : [],
-      validateReleaseTags: opts.validateReleaseTags
-    });
-  }
-  if (cliPackageDirs.length > 0) {
-    console.log("# Generating package CLI reports");
-    await runCliExtraction({
-      packageDirs: cliPackageDirs,
-      isLocalBuild: !isCiBuild
-    });
-  }
-  if (isDocsBuild) {
-    console.log("# Generating package documentation");
-    await buildDocs({
-      inputDir: tmpDir,
-      outputDir: paths.paths.resolveTargetRoot("docs/reference")
-    });
-  }
-};
-function parseArrayOption(value) {
-  return value ? value.split(",").map((s) => s.trim()) : [];
-}
-
-exports.buildApiReports = buildApiReports;
-//# sourceMappingURL=api-reports-B3Gt_Fej.cjs.js.map
+exports.buildDocs = buildDocs;
+exports.categorizePackageDirs = categorizePackageDirs;
+exports.countApiReportWarnings = countApiReportWarnings;
+exports.createTemporaryTsConfig = createTemporaryTsConfig;
+exports.getTsDocConfig = getTsDocConfig;
+exports.runApiExtraction = runApiExtraction;
+exports.runCliExtraction = runCliExtraction;
+//# sourceMappingURL=api-extractor.cjs.js.map

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

@@ -0,0 +1,78 @@
+'use strict';
+
+var apiExtractor = require('./api-extractor.cjs.js');
+var paths = require('../../lib/paths.cjs.js');
+var generateTypeDeclarations = require('./generateTypeDeclarations.cjs.js');
+
+const buildApiReports = async (paths$1 = [], opts) => {
+  const tmpDir = paths.paths.resolveTargetRoot(
+    "./node_modules/.cache/api-extractor"
+  );
+  const isCiBuild = opts.ci;
+  const isDocsBuild = opts.docs;
+  const runTsc = opts.tsc;
+  const allowWarnings = parseArrayOption(opts.allowWarnings);
+  const allowAllWarnings = opts.allowAllWarnings;
+  const omitMessages = parseArrayOption(opts.omitMessages);
+  const isAllPackages = !paths$1?.length;
+  const selectedPackageDirs = await paths.resolvePackagePaths({
+    paths: paths$1,
+    include: opts.include,
+    exclude: opts.exclude
+  });
+  if (isAllPackages && !isCiBuild && !isDocsBuild) {
+    console.log("");
+    console.log(
+      "TIP: You can generate api-reports for select packages by passing package paths:"
+    );
+    console.log("");
+    console.log(
+      "       yarn build:api-reports packages/config packages/core-plugin-api plugins/*"
+    );
+    console.log("");
+  }
+  let temporaryTsConfigPath;
+  if (!isAllPackages) {
+    temporaryTsConfigPath = await apiExtractor.createTemporaryTsConfig(selectedPackageDirs);
+  }
+  const tsconfigFilePath = temporaryTsConfigPath ?? paths.paths.resolveTargetRoot("tsconfig.json");
+  if (runTsc) {
+    console.log("# Compiling TypeScript");
+    await generateTypeDeclarations.generateTypeDeclarations(tsconfigFilePath);
+  }
+  const { tsPackageDirs, cliPackageDirs } = await apiExtractor.categorizePackageDirs(
+    selectedPackageDirs
+  );
+  if (tsPackageDirs.length > 0) {
+    console.log("# Generating package API reports");
+    await apiExtractor.runApiExtraction({
+      packageDirs: tsPackageDirs,
+      outputDir: tmpDir,
+      isLocalBuild: !isCiBuild,
+      tsconfigFilePath,
+      allowWarnings: allowAllWarnings || allowWarnings,
+      omitMessages: Array.isArray(omitMessages) ? omitMessages : [],
+      validateReleaseTags: opts.validateReleaseTags
+    });
+  }
+  if (cliPackageDirs.length > 0) {
+    console.log("# Generating package CLI reports");
+    await apiExtractor.runCliExtraction({
+      packageDirs: cliPackageDirs,
+      isLocalBuild: !isCiBuild
+    });
+  }
+  if (isDocsBuild) {
+    console.log("# Generating package documentation");
+    await apiExtractor.buildDocs({
+      inputDir: tmpDir,
+      outputDir: paths.paths.resolveTargetRoot("docs/reference")
+    });
+  }
+};
+function parseArrayOption(value) {
+  return value ? value.split(",").map((s) => s.trim()) : [];
+}
+
+exports.buildApiReports = buildApiReports;
+//# sourceMappingURL=api-reports.cjs.js.map

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

@@ -0,0 +1,33 @@
+'use strict';
+
+var fs = require('fs-extra');
+var child_process = require('child_process');
+var paths = require('../../lib/paths.cjs.js');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+var fs__default = /*#__PURE__*/_interopDefaultCompat(fs);
+
+async function generateTypeDeclarations(tsconfigFilePath) {
+  await fs__default.default.remove(paths.paths.resolveTargetRoot("dist-types"));
+  const { status } = child_process.spawnSync(
+    "yarn",
+    [
+      "tsc",
+      ["--project", tsconfigFilePath],
+      ["--skipLibCheck", "false"],
+      ["--incremental", "false"]
+    ].flat(),
+    {
+      stdio: "inherit",
+      shell: true,
+      cwd: paths.paths.targetRoot
+    }
+  );
+  if (status !== 0) {
+    process.exit(status || void 0);
+  }
+}
+
+exports.generateTypeDeclarations = generateTypeDeclarations;
+//# sourceMappingURL=generateTypeDeclarations.cjs.js.map

package/dist/commands/generate-catalog-info/codeowners.cjs.js

@@ -0,0 +1,42 @@
+'use strict';
+
+var codeownersUtils = require('codeowners-utils');
+var path = require('path');
+var utils = require('./utils.cjs.js');
+
+async function loadCodeowners() {
+  const maybeFiles = await Promise.allSettled(
+    codeownersUtils.CODEOWNERS_PATHS.map(
+      async (path$1) => utils.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[0];
+  if (!owner) {
+    throw new Error(`${relPath} isn't owned by anyone in CODEOWNERS`);
+  }
+  return owner;
+}
+
+exports.getOwnerFromCodeowners = getOwnerFromCodeowners;
+exports.getPossibleCodeowners = getPossibleCodeowners;
+exports.loadCodeowners = loadCodeowners;
+//# sourceMappingURL=codeowners.cjs.js.map

package/dist/{cjs/generate-catalog-info-DxKb-9Wh.cjs.js → commands/generate-catalog-info/generate-catalog-info.cjs.js}

@@ -1,91 +1,45 @@
 'use strict';
 
+Object.defineProperty(exports, '__esModule', { value: true });
+
 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');
+var codeowners = require('./codeowners.cjs.js');
+var utils = require('./utils.cjs.js');
 
 function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
 
 var YAML__default = /*#__PURE__*/_interopDefaultCompat(YAML);
 var pLimit__default = /*#__PURE__*/_interopDefaultCompat(pLimit);
 var chalk__default = /*#__PURE__*/_interopDefaultCompat(chalk);
-var fs__default = /*#__PURE__*/_interopDefaultCompat(fs);
-
-const readFile = util.promisify(fs__default.default.readFile);
-const writeFile = util.promisify(fs__default.default.writeFile);
-function isBackstagePackage(packageJson) {
-  return packageJson && packageJson.hasOwnProperty("backstage") && packageJson?.backstage?.role !== "undefined";
-}
-const isRejected = (input) => input.status === "rejected";
-const isFulfilled = (input) => input.status === "fulfilled";
-const safeEntityName = (packageName) => {
-  return packageName.replace(/^[^\w\s]|[^a-z0-9]$/g, "").replace(/[^A-Za-z0-9_\-.]+/g, "-").replace(
-    /([a-z])([A-Z])/g,
-    (_, a, b) => `${a}-${b.toLocaleLowerCase("en-US")}`
-  ).replace(/^(.)/, (_, a) => a.toLocaleLowerCase("en-US"));
-};
-
-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[0];
-  if (!owner) {
-    throw new Error(`${relPath} isn't owned by anyone in CODEOWNERS`);
-  }
-  return owner;
-}
 
 var generateCatalogInfo = async (opts) => {
   const { dryRun = false, ci = false } = opts;
   const packages = await cliNode.PackageGraph.listTargetPackages();
-  const codeowners = await loadCodeowners();
+  const codeowners$1 = await codeowners.loadCodeowners();
   const limit = pLimit__default.default(10);
   const isDryRun = ci ? true : dryRun;
   const checkForChanges = ci;
   const results = await Promise.allSettled(
     packages.map(
       ({ packageJson, dir }) => limit(async () => {
-        if (!isBackstagePackage(packageJson)) {
+        if (!utils.isBackstagePackage(packageJson)) {
           return "";
         }
         const infoYamlPath = path.resolve(dir, "catalog-info.yaml");
         let yamlString = "";
         try {
-          yamlString = await readFile(infoYamlPath, { encoding: "utf-8" });
+          yamlString = await utils.readFile(infoYamlPath, { encoding: "utf-8" });
         } catch (e) {
           if (e.code === "ENOENT") {
             return await createCatalogInfoYaml({
               yamlPath: infoYamlPath,
               packageJson,
-              codeowners,
+              codeowners: codeowners$1,
               dryRun: isDryRun
             });
           }
@@ -94,7 +48,7 @@ var generateCatalogInfo = async (opts) => {
         return await fixCatalogInfoYaml({
           yamlPath: infoYamlPath,
           packageJson,
-          codeowners,
+          codeowners: codeowners$1,
           yamlString,
           dryRun: isDryRun,
           ci
@@ -102,7 +56,7 @@ var generateCatalogInfo = async (opts) => {
       })
     )
   );
-  const rejects = results.filter(isRejected);
+  const rejects = results.filter(utils.isRejected);
   if (rejects.length > 0) {
     console.error(
       chalk__default.default.red("Unable to create or fix catalog-info.yaml files\n")
@@ -112,7 +66,7 @@ var generateCatalogInfo = async (opts) => {
     process.exit(1);
   }
   if (checkForChanges) {
-    const instructions = results.filter(isFulfilled).map((r) => r.value).filter((r) => r !== "");
+    const instructions = results.filter(utils.isFulfilled).map((r) => r.value).filter((r) => r !== "");
     if (instructions.length > 0) {
       console.error(
         "\ncatalog-info.yaml file(s) out of sync with CODEOWNERS and/or package.json (see instructions above)\n"
@@ -126,24 +80,24 @@ var generateCatalogInfo = async (opts) => {
   }
 };
 async function createCatalogInfoYaml(options) {
-  const { codeowners, dryRun, packageJson, yamlPath } = options;
+  const { codeowners: codeowners$1, dryRun, packageJson, yamlPath } = options;
   const instruction = `Create ${path.relative(".", yamlPath)}`;
-  const owner = getOwnerFromCodeowners(codeowners, yamlPath);
+  const owner = codeowners.getOwnerFromCodeowners(codeowners$1, yamlPath);
   const entity = createOrMergeEntity(packageJson, owner);
   if (dryRun) {
     console.error(instruction);
   } else {
-    await writeFile(yamlPath, YAML__default.default.dump(entity));
+    await utils.writeFile(yamlPath, YAML__default.default.dump(entity));
   }
   return instruction;
 }
 async function fixCatalogInfoYaml(options) {
-  const { ci, codeowners, dryRun, packageJson, yamlPath, yamlString } = options;
-  const possibleOwners = getPossibleCodeowners(
-    codeowners,
+  const { ci, codeowners: codeowners$1, dryRun, packageJson, yamlPath, yamlString } = options;
+  const possibleOwners = codeowners.getPossibleCodeowners(
+    codeowners$1,
     path.relative(".", yamlPath)
   );
-  const safeName = safeEntityName(packageJson.name);
+  const safeName = utils.safeEntityName(packageJson.name);
   let yamlJson;
   try {
     yamlJson = YAML__default.default.load(yamlString);
@@ -155,7 +109,7 @@ async function fixCatalogInfoYaml(options) {
   const badName = yamlJson.metadata.name !== safeName;
   const badType = yamlJson.spec?.type !== `backstage-${packageJson.backstage.role}`;
   if (badOwner || badTitle || badName || badType) {
-    const owner = badOwner ? getOwnerFromCodeowners(codeowners, yamlPath) : yamlJson.spec?.owner;
+    const owner = badOwner ? codeowners.getOwnerFromCodeowners(codeowners$1, yamlPath) : yamlJson.spec?.owner;
     const newJson = createOrMergeEntity(packageJson, owner, yamlJson);
     const instructions = [`Update ${path.relative(".", yamlPath)}`];
     if (ci) {
@@ -185,14 +139,14 @@ async function fixCatalogInfoYaml(options) {
     if (dryRun) {
       console.error(instructions.join("\n"));
     } else {
-      await writeFile(yamlPath, yamlDiffPatch.yamlOverwrite(yamlString, newJson));
+      await utils.writeFile(yamlPath, yamlDiffPatch.yamlOverwrite(yamlString, newJson));
     }
     return instructions.join("\n");
   }
   return "";
 }
 function createOrMergeEntity(packageJson, owner, existingEntity = {}) {
-  const entityName = safeEntityName(packageJson.name);
+  const entityName = utils.safeEntityName(packageJson.name);
   return {
     ...existingEntity,
     apiVersion: "backstage.io/v1alpha1",
@@ -214,4 +168,4 @@ function createOrMergeEntity(packageJson, owner, existingEntity = {}) {
 }
 
 exports.default = generateCatalogInfo;
-//# sourceMappingURL=generate-catalog-info-DxKb-9Wh.cjs.js.map
+//# sourceMappingURL=generate-catalog-info.cjs.js.map

package/dist/commands/generate-catalog-info/utils.cjs.js

@@ -0,0 +1,30 @@
+'use strict';
+
+var fs = require('fs');
+var util = require('util');
+
+function _interopDefaultCompat (e) { return e && typeof e === 'object' && 'default' in e ? e : { default: e }; }
+
+var fs__default = /*#__PURE__*/_interopDefaultCompat(fs);
+
+const readFile = util.promisify(fs__default.default.readFile);
+const writeFile = util.promisify(fs__default.default.writeFile);
+function isBackstagePackage(packageJson) {
+  return packageJson && packageJson.hasOwnProperty("backstage") && packageJson?.backstage?.role !== "undefined";
+}
+const isRejected = (input) => input.status === "rejected";
+const isFulfilled = (input) => input.status === "fulfilled";
+const safeEntityName = (packageName) => {
+  return packageName.replace(/^[^\w\s]|[^a-z0-9]$/g, "").replace(/[^A-Za-z0-9_\-.]+/g, "-").replace(
+    /([a-z])([A-Z])/g,
+    (_, a, b) => `${a}-${b.toLocaleLowerCase("en-US")}`
+  ).replace(/^(.)/, (_, a) => a.toLocaleLowerCase("en-US"));
+};
+
+exports.isBackstagePackage = isBackstagePackage;
+exports.isFulfilled = isFulfilled;
+exports.isRejected = isRejected;
+exports.readFile = readFile;
+exports.safeEntityName = safeEntityName;
+exports.writeFile = writeFile;
+//# sourceMappingURL=utils.cjs.js.map