@backstage/repo-tools 0.6.0-next.1 → 0.6.0-next.3

package/CHANGELOG.md

@@ -1,5 +1,47 @@
 # @backstage/repo-tools
 
+## 0.6.0-next.3
+
+### Patch Changes
+
+- 60a68f1: Introduced `knip` to the `knip-reports` command, which generates a `knip-report.md` file for your packages with dependency warnings, if any.
+- Updated dependencies
+  - @backstage/backend-common@0.21.0-next.3
+  - @backstage/cli-node@0.2.3-next.0
+  - @backstage/catalog-model@1.4.4-next.0
+  - @backstage/cli-common@0.1.13
+  - @backstage/errors@1.2.3
+
+## 0.6.0-next.2
+
+### Minor Changes
+
+- 4c62935: **BREAKING**: The `schema openapi *` commands are now renamed into `package schema openapi *` and `repo schema openapi *`. The aim is to make it more clear what the command is operating on, the entire repo or just a single package.
+
+  The following commands now live under the `package` namespace,
+
+  - `schema openapi generate` is now `package schema openapi generate --server`
+  - `schema openapi generate-client` is now `package schema openapi generate --client-package`
+  - `schema openapi init` is now `package schema openapi init`
+
+  And these commands live under the new `repo` namespace,
+
+  - `schema openapi lint` is now `repo schema openapi lint`
+  - `schema openapi test` is now `repo schema openapi test`
+  - `schema openapi verify` is now `repo schema openapi verify`
+
+  The `package schema openapi generate` now supports defining both `--server` and `--client-package` to generate both at once.This update also reworks the `--client-package` flag to accept only an output directory as the input directory can now be inferred.
+
+### Patch Changes
+
+- aa91cd6: Resolved an issue with generate-catalog-info where it was replacing upper case characters with -.
+- Updated dependencies
+  - @backstage/backend-common@0.21.0-next.2
+  - @backstage/catalog-model@1.4.4-next.0
+  - @backstage/cli-common@0.1.13
+  - @backstage/cli-node@0.2.2
+  - @backstage/errors@1.2.3
+
 ## 0.6.0-next.1
 
 ### Patch Changes

package/dist/cjs/{api-reports-143209ff.cjs.js → api-reports-ebc5b5dd.cjs.js}

@@ -2,7 +2,6 @@
 
 var lodash = require('lodash');
 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');
@@ -16,6 +15,8 @@ var CustomMarkdownEmitter = require('@microsoft/api-documenter/lib/markdown/Cust
 var paths = require('./paths-9ab9b8a8.cjs.js');
 var minimatch = require('minimatch');
 var entryPoints = require('./entryPoints-c9b88245.cjs.js');
+var util = require('./util-40303646.cjs.js');
+var child_process = require('child_process');
 require('@backstage/cli-common');
 require('@backstage/cli-node');
 
@@ -207,10 +208,10 @@ function logApiReportInstructions() {
     "*************************************************************************************"
   );
   console.log(
-    "* You have uncommitted changes to the public API of a package.                      *"
+    "* You have uncommitted changes to the public API or reports of a package.           *"
   );
   console.log(
-    "* To solve this, run `yarn build:api-reports` and commit all api-report.md changes. *"
+    "* To solve this, run `yarn build:api-reports` and commit all md file changes.       *"
   );
   console.log(
     "*************************************************************************************"
@@ -921,30 +922,6 @@ async function categorizePackageDirs(packageDirs) {
   );
   return { tsPackageDirs, cliPackageDirs };
 }
-function createBinRunner(cwd, path) {
-  return async (...command) => new Promise((resolve, reject) => {
-    child_process.execFile(
-      "node",
-      [path, ...command],
-      {
-        cwd,
-        shell: true,
-        timeout: 6e4,
-        maxBuffer: 1024 * 1024
-      },
-      (err, stdout, stderr) => {
-        if (err) {
-          reject(new Error(`${err.message}
-${stderr}`));
-        } else if (stderr) {
-          reject(new Error(`Command printed error output: ${stderr}`));
-        } else {
-          resolve(stdout);
-        }
-      }
-    );
-  });
-}
 function parseHelpPage(helpPageContent) {
   var _a;
   const [, usage] = (_a = helpPageContent.match(/^\s*Usage: (.*)$/im)) != null ? _a : [];
@@ -1044,12 +1021,12 @@ async function runCliExtraction({
     }
     const models = new Array();
     if (typeof pkgJson.bin === "string") {
-      const run = createBinRunner(fullDir, pkgJson.bin);
+      const run = util.createBinRunner(fullDir, pkgJson.bin);
       const helpPages = await exploreCliHelpPages(run);
       models.push({ name: path.basename(pkgJson.bin), helpPages });
     } else {
       for (const [name, path] of Object.entries(pkgJson.bin)) {
-        const run = createBinRunner(fullDir, path);
+        const run = util.createBinRunner(fullDir, path);
         const helpPages = await exploreCliHelpPages(run);
         models.push({ name, helpPages });
       }
@@ -1178,4 +1155,4 @@ function parseArrayOption(value) {
 }
 
 exports.buildApiReports = buildApiReports;
-//# sourceMappingURL=api-reports-143209ff.cjs.js.map
+//# sourceMappingURL=api-reports-ebc5b5dd.cjs.js.map

package/dist/cjs/{generate-catalog-info-c0260878.cjs.js → generate-catalog-info-e7071c1c.cjs.js}

@@ -25,6 +25,12 @@ function isBackstagePackage(packageJson) {
 }
 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(
@@ -139,7 +145,7 @@ async function fixCatalogInfoYaml(options) {
     codeowners,
     path.relative(".", yamlPath)
   );
-  const safeName = packageJson.name.replace(/[^a-z0-9_\-\.]+/g, "-").replace(/^[^a-z0-9]|[^a-z0-9]$/g, "");
+  const safeName = safeEntityName(packageJson.name);
   let yamlJson;
   try {
     yamlJson = YAML__default["default"].load(yamlString);
@@ -189,7 +195,7 @@ async function fixCatalogInfoYaml(options) {
 }
 function createOrMergeEntity(packageJson, owner, existingEntity = {}) {
   var _a;
-  const safeEntityName = packageJson.name.replace(/[^a-z0-9_\-\.]+/g, "-").replace(/^[^a-z0-9]|[^a-z0-9]$/g, "");
+  const entityName = safeEntityName(packageJson.name);
   return {
     ...existingEntity,
     apiVersion: "backstage.io/v1alpha1",
@@ -197,7 +203,7 @@ function createOrMergeEntity(packageJson, owner, existingEntity = {}) {
     metadata: {
       ...existingEntity.metadata,
       // Provide default name/title/description values.
-      name: safeEntityName,
+      name: entityName,
       title: packageJson.name,
       ...packageJson.description && !((_a = existingEntity.metadata) == null ? void 0 : _a.description) ? { description: packageJson.description } : void 0
     },
@@ -211,4 +217,4 @@ function createOrMergeEntity(packageJson, owner, existingEntity = {}) {
 }
 
 exports["default"] = generateCatalogInfo;
-//# sourceMappingURL=generate-catalog-info-c0260878.cjs.js.map
+//# sourceMappingURL=generate-catalog-info-e7071c1c.cjs.js.map

package/dist/cjs/{constants-10c5aa52.cjs.js → helpers-712dfada.cjs.js}

@@ -1,5 +1,9 @@
 'use strict';
 
+var fs = require('fs-extra');
+var paths = require('./paths-9ab9b8a8.cjs.js');
+var path = require('path');
+
 const YAML_SCHEMA_PATH = "src/schema/openapi.yaml";
 const TS_MODULE = "src/schema/openapi.generated";
 const TS_SCHEMA_PATH = `${TS_MODULE}.ts`;
@@ -36,9 +40,31 @@ const OPENAPI_IGNORE_FILES = [
   "tsconfig.json"
 ];
 
+const getPathToFile = async (directory, filename) => {
+  return path.resolve(directory, filename);
+};
+const getRelativePathToFile = async (filename) => {
+  return await getPathToFile(paths.paths.targetDir, filename);
+};
+const assertExists = async (path) => {
+  if (!await fs.pathExists(path)) {
+    throw new Error(`Could not find ${path}.`);
+  }
+  return path;
+};
+const getPathToOpenApiSpec = async (directory) => {
+  return await assertExists(await getPathToFile(directory, YAML_SCHEMA_PATH));
+};
+const getPathToCurrentOpenApiSpec = async () => {
+  return await assertExists(await getRelativePathToFile(YAML_SCHEMA_PATH));
+};
+
 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-10c5aa52.cjs.js.map
+exports.getPathToCurrentOpenApiSpec = getPathToCurrentOpenApiSpec;
+exports.getPathToOpenApiSpec = getPathToOpenApiSpec;
+exports.getRelativePathToFile = getRelativePathToFile;
+//# sourceMappingURL=helpers-712dfada.cjs.js.map

package/dist/cjs/index-c6ffc4f4.cjs.js

@@ -0,0 +1,142 @@
+'use strict';
+
+var chalk = require('chalk');
+var path = require('path');
+var helpers = require('./helpers-712dfada.cjs.js');
+var paths = require('./paths-9ab9b8a8.cjs.js');
+var fs = require('fs-extra');
+var exec$1 = require('./exec-7bf444eb.cjs.js');
+var backendCommon = require('@backstage/backend-common');
+var YAML = require('js-yaml');
+var util = require('util');
+var child_process = require('child_process');
+require('@backstage/cli-common');
+require('@backstage/cli-node');
+require('minimatch');
+
+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);
+var YAML__default = /*#__PURE__*/_interopDefaultLegacy(YAML);
+
+async function generate$1(outputDirectory) {
+  const resolvedOpenapiPath = await helpers.getPathToCurrentOpenApiSpec();
+  const resolvedOutputDirectory = paths.paths.resolveTargetRoot(
+    outputDirectory,
+    helpers.OUTPUT_PATH
+  );
+  fs.mkdirpSync(resolvedOutputDirectory);
+  await fs__default["default"].mkdirp(resolvedOutputDirectory);
+  await fs__default["default"].writeFile(
+    path.resolve(resolvedOutputDirectory, ".openapi-generator-ignore"),
+    helpers.OPENAPI_IGNORE_FILES.join("\n")
+  );
+  await exec$1.exec(
+    "node",
+    [
+      backendCommon.resolvePackagePath("@openapitools/openapi-generator-cli", "main.js"),
+      "generate",
+      "-i",
+      resolvedOpenapiPath,
+      "-o",
+      resolvedOutputDirectory,
+      "-g",
+      "typescript",
+      "-c",
+      backendCommon.resolvePackagePath(
+        "@backstage/repo-tools",
+        "templates/typescript-backstage.yaml"
+      ),
+      "--generator-key",
+      "v3.0"
+    ],
+    {
+      maxBuffer: Number.MAX_VALUE,
+      cwd: backendCommon.resolvePackagePath("@backstage/repo-tools"),
+      env: {
+        ...process.env
+      }
+    }
+  );
+  await exec$1.exec(
+    `yarn backstage-cli package lint --fix ${resolvedOutputDirectory}`
+  );
+  const prettier = paths.paths.resolveTargetRoot("node_modules/.bin/prettier");
+  if (prettier) {
+    await exec$1.exec(`${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 command$2(outputPackage) {
+  try {
+    await generate$1(outputPackage);
+    console.log(
+      chalk__default["default"].green(`Generated client in ${outputPackage}/${helpers.OUTPUT_PATH}`)
+    );
+  } catch (err) {
+    console.log();
+    console.log(chalk__default["default"].red(`Client generation failed:`));
+    console.log(err);
+    process.exit(1);
+  }
+}
+
+const exec = util.promisify(child_process.exec);
+async function generate() {
+  const openapiPath = await helpers.getPathToCurrentOpenApiSpec();
+  const yaml = YAML__default["default"].load(await fs__default["default"].readFile(openapiPath, "utf8"));
+  const tsPath = paths.paths.resolveTarget(helpers.TS_SCHEMA_PATH);
+  await fs__default["default"].writeFile(
+    tsPath,
+    `//
+
+// ******************************************************************
+// * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
+// ******************************************************************
+import {createValidatedOpenApiRouter} from '@backstage/backend-openapi-utils';
+export const spec = ${JSON.stringify(yaml, null, 2)} as const;
+export const createOpenApiRouter = async (
+  options?: Parameters<typeof createValidatedOpenApiRouter>['1'],
+) => createValidatedOpenApiRouter<typeof spec>(spec, options);
+`
+  );
+  await exec(`yarn backstage-cli package lint --fix ${tsPath}`);
+  if (await paths.paths.resolveTargetRoot("node_modules/.bin/prettier")) {
+    await exec(`yarn prettier --write ${tsPath}`, {
+      cwd: paths.paths.targetRoot
+    });
+  }
+}
+async function command$1() {
+  try {
+    await generate();
+    console.log(chalk__default["default"].green("Generated all files."));
+  } catch (err) {
+    console.log(chalk__default["default"].red(`OpenAPI server stub generation failed.`));
+    console.log(err.message);
+    process.exit(1);
+  }
+}
+
+async function command(opts) {
+  if (!opts.clientPackage && !opts.server) {
+    console.log(
+      chalk__default["default"].red("Either --client-package or --server must be defined.")
+    );
+    process.exit(1);
+  }
+  if (opts.clientPackage) {
+    await command$2(opts.clientPackage);
+  }
+  if (opts.server) {
+    await command$1();
+  }
+}
+
+exports.command = command;
+//# sourceMappingURL=index-c6ffc4f4.cjs.js.map

package/dist/cjs/{init-1a079f00.cjs.js → init-3d29e55d.cjs.js}

@@ -1,17 +1,14 @@
 'use strict';
 
 var fs = require('fs-extra');
-var path = require('path');
-var constants = require('./constants-10c5aa52.cjs.js');
+var helpers = require('./helpers-712dfada.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('path');
 require('@backstage/cli-common');
 require('@backstage/cli-node');
 require('minimatch');
-require('p-limit');
-require('portfinder');
 require('util');
 require('child_process');
 
@@ -24,14 +21,15 @@ const ROUTER_TEST_PATHS = [
   "src/service/router.test.ts",
   "src/service/createRouter.test.ts"
 ];
-async function init(directoryPath) {
-  const openapiPath = path.join(directoryPath, constants.YAML_SCHEMA_PATH);
-  if (!await fs__default["default"].pathExists(openapiPath)) {
+async function init() {
+  try {
+    await helpers.getPathToCurrentOpenApiSpec();
+  } catch (err) {
     throw new Error(
-      `You do not have an OpenAPI YAML file at ${openapiPath}. Please create one and retry this command. If you already have existing test cases for your router, see 'backstage-repo-tools schema openapi test --update'`
+      `OpenAPI.yaml not found in ${helpers.YAML_SCHEMA_PATH}. Please create one and retry this command.`
     );
   }
-  const opticConfigFilePath = path.join(directoryPath, "optic.yml");
+  const opticConfigFilePath = await helpers.getRelativePathToFile("optic.yml");
   if (await fs__default["default"].pathExists(opticConfigFilePath)) {
     throw new Error(`This directory already has an optic.yml file. Exiting.`);
   }
@@ -40,9 +38,9 @@ async function init(directoryPath) {
     `ruleset:
     - breaking-changes
 capture:
-    ${constants.YAML_SCHEMA_PATH}:
+    ${helpers.YAML_SCHEMA_PATH}:
         # \u{1F527} Runnable example with simple get requests.
-        # Run with "PORT=3000 optic capture ${constants.YAML_SCHEMA_PATH} --update interactive" in '${directoryPath}'
+        # Run with "PORT=3000 optic capture ${helpers.YAML_SCHEMA_PATH} --update interactive" in '${paths.paths.targetDir}'
         # You can change the server and the 'requests' section to experiment
         server:
             # This will not be used by 'backstage-repo-tools schema openapi test', but may be useful for interactive updates.
@@ -60,27 +58,16 @@ capture:
     await exec.exec(`yarn prettier`, ["--write", opticConfigFilePath]);
   }
 }
-async function initCommand(paths = []) {
-  const resultsList = await runner.runner(paths, (dir) => init(dir), {
-    concurrencyLimit: 5
-  });
-  let failed = false;
-  for (const { relativeDir, resultText } of resultsList) {
-    if (resultText) {
-      console.log();
-      console.log(
-        chalk__default["default"].red(`Failed to initialize ${relativeDir} for OpenAPI commands.`)
-      );
-      console.log(resultText.trimStart());
-      failed = true;
-    }
-  }
-  if (failed) {
+async function singleCommand() {
+  try {
+    await init();
+    console.log(chalk__default["default"].green(`Successfully configured.`));
+  } catch (err) {
+    console.log(chalk__default["default"].red(`OpenAPI tooling initialization failed.`));
+    console.log(err.message);
     process.exit(1);
-  } else {
-    console.log(chalk__default["default"].green(`All directories have already been configured.`));
   }
 }
 
-exports["default"] = initCommand;
-//# sourceMappingURL=init-1a079f00.cjs.js.map
+exports.singleCommand = singleCommand;
+//# sourceMappingURL=init-3d29e55d.cjs.js.map

package/dist/cjs/knip-reports-1871d475.cjs.js

@@ -0,0 +1,185 @@
+'use strict';
+
+var paths = require('./paths-9ab9b8a8.cjs.js');
+var pLimit = require('p-limit');
+var os = require('os');
+var path = require('path');
+var fs = require('fs-extra');
+var util = require('./util-40303646.cjs.js');
+require('@backstage/cli-common');
+require('@backstage/cli-node');
+require('minimatch');
+require('child_process');
+
+function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
+
+var pLimit__default = /*#__PURE__*/_interopDefaultLegacy(pLimit);
+var os__default = /*#__PURE__*/_interopDefaultLegacy(os);
+var fs__default = /*#__PURE__*/_interopDefaultLegacy(fs);
+
+const ignoredPackages = ["packages/techdocs-cli-embedded-app"];
+function logKnipReportInstructions() {
+  console.log("");
+  console.log(
+    "*************************************************************************************"
+  );
+  console.log(
+    "* You have uncommitted changes to the knip reports of a package.                    *"
+  );
+  console.log(
+    "* To solve this, run `yarn build:knip-reports` and commit all md file changes.      *"
+  );
+  console.log(
+    "*************************************************************************************"
+  );
+  console.log("");
+}
+async function generateKnipConfig({ packageDir }) {
+  const knipConfig = {
+    entry: [
+      "dev/index.{ts,tsx}",
+      "src/index.{ts,tsx}",
+      "src/alpha.{ts,tsx}",
+      "src/routes.ts",
+      "src/run.ts"
+    ],
+    jest: {
+      entry: ["src/setupTests.ts", "**/*.test.{ts,tsx}"]
+    },
+    storybook: { entry: "src/components/**/*.stories.tsx" },
+    ignore: [
+      ".eslintrc.js",
+      "config.d.ts",
+      "knexfile.js",
+      "node_modules/**",
+      "dist/**",
+      "{fixtures,migrations,templates}/**"
+    ],
+    ignoreDependencies: [
+      "@backstage/cli",
+      // everything depends on this for its package.json commands
+      "@backstage/theme"
+      // this uses `declare module` in .d.ts so is implicitly used whenever extensions are needed
+    ]
+  };
+  await fs__default["default"].writeFile(
+    `${packageDir}/knip.json`,
+    JSON.stringify(knipConfig, null, 2)
+  );
+}
+function cleanKnipConfig({ packageDir }) {
+  if (fs__default["default"].existsSync(`${packageDir}/knip.json`)) {
+    fs__default["default"].rmSync(`${packageDir}/knip.json`);
+  }
+}
+async function handlePackage({
+  packageDir,
+  knipDir,
+  isLocalBuild
+}) {
+  console.log(`## Processing ${packageDir}`);
+  if (ignoredPackages.includes(packageDir)) {
+    console.log(`Skipping ${packageDir}`);
+    return;
+  }
+  const fullDir = paths.paths.resolveTargetRoot(packageDir);
+  const reportPath = path.resolve(fullDir, "knip-report.md");
+  const run = util.createBinRunner(fullDir, "");
+  await generateKnipConfig({ packageDir: fullDir });
+  const report = await run(
+    `${knipDir}/knip.js`,
+    `--directory ${fullDir}`,
+    // Run in the package directory
+    "--config knip.json",
+    "--no-exit-code",
+    // Removing this will end the process in case there are findings by knip
+    "--no-progress",
+    // Remove unnecessary debugging from output
+    // TODO: Add more checks when dependencies start to look ok, see https://knip.dev/reference/cli#--include
+    "--include dependencies,unlisted",
+    "--reporter markdown"
+  );
+  cleanKnipConfig({ packageDir: fullDir });
+  const existingReport = await fs__default["default"].readFile(reportPath, "utf8").catch((error) => {
+    if (error.code === "ENOENT") {
+      return void 0;
+    }
+    throw error;
+  });
+  if (existingReport !== report) {
+    if (isLocalBuild) {
+      console.warn(`Knip report changed for ${packageDir}`);
+      await fs__default["default"].writeFile(reportPath, report);
+    } else {
+      logKnipReportInstructions();
+      if (existingReport) {
+        console.log("");
+        console.log(
+          `The conflicting file is ${path.relative(
+            paths.paths.targetRoot,
+            reportPath
+          )}, expecting the following content:`
+        );
+        console.log("");
+        console.log(report);
+        logKnipReportInstructions();
+      }
+      throw new Error(`Knip report changed for ${packageDir}, `);
+    }
+  }
+}
+async function runKnipReports({
+  packageDirs,
+  isLocalBuild
+}) {
+  const knipDir = paths.paths.resolveTargetRoot("./node_modules/knip/bin/");
+  const limiter = pLimit__default["default"](os__default["default"].cpus().length);
+  try {
+    await Promise.all(
+      packageDirs.map(
+        (packageDir) => limiter(
+          async () => handlePackage({ packageDir, knipDir, isLocalBuild })
+        )
+      )
+    );
+  } catch (e) {
+    console.log(
+      `Error occurred during knip reporting: ${e}, cleaning knip configs`
+    );
+    packageDirs.map((packageDir) => {
+      const fullDir = paths.paths.resolveTargetRoot(packageDir);
+      cleanKnipConfig({ packageDir: fullDir });
+    });
+  }
+}
+
+const buildKnipReports = async (paths$1 = [], opts) => {
+  const isCiBuild = opts.ci;
+  const isAllPackages = !(paths$1 == null ? void 0 : paths$1.length);
+  const selectedPackageDirs = await paths.resolvePackagePaths({
+    paths: paths$1,
+    include: opts.include,
+    exclude: opts.exclude
+  });
+  if (isAllPackages && !isCiBuild) {
+    console.log("");
+    console.log(
+      "TIP: You can generate knip-reports for select packages by passing package paths:"
+    );
+    console.log("");
+    console.log(
+      "       yarn build:knip-reports packages/config packages/core-plugin-api plugins/*"
+    );
+    console.log("");
+  }
+  if (selectedPackageDirs.length > 0) {
+    console.log("# Generating package knip reports");
+    await runKnipReports({
+      packageDirs: selectedPackageDirs,
+      isLocalBuild: !isCiBuild
+    });
+  }
+};
+
+exports.buildKnipReports = buildKnipReports;
+//# sourceMappingURL=knip-reports-1871d475.cjs.js.map

package/dist/cjs/{lint-4f8f9fee.cjs.js → lint-5433166f.cjs.js}

@@ -5,16 +5,16 @@ var spectralParsers = require('@stoplight/spectral-parsers');
 var ruleset = require('@apisyouwonthate/style-guide');
 var fs = require('fs-extra');
 var chalk = require('chalk');
-var path = require('path');
-var runner = require('./runner-0e5fc9a8.cjs.js');
-var constants = require('./constants-10c5aa52.cjs.js');
+var runner = require('./runner-d5b73286.cjs.js');
 var spectralRulesets = require('@stoplight/spectral-rulesets');
 var types = require('@stoplight/types');
 var spectralFormatters = require('@stoplight/spectral-formatters');
+var helpers = require('./helpers-712dfada.cjs.js');
 require('./paths-9ab9b8a8.cjs.js');
 require('@backstage/cli-common');
 require('@backstage/cli-node');
 require('minimatch');
+require('path');
 require('p-limit');
 require('portfinder');
 
@@ -25,13 +25,12 @@ var fs__default = /*#__PURE__*/_interopDefaultLegacy(fs);
 var chalk__default = /*#__PURE__*/_interopDefaultLegacy(chalk);
 
 async function lint(directoryPath, config) {
-  const { skipMissingYamlFile, strict } = 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 a file at ${openapiPath}.`);
+  const { strict } = config != null ? config : {};
+  let openapiPath = "";
+  try {
+    openapiPath = await helpers.getPathToOpenApiSpec(directoryPath);
+  } catch {
+    return;
   }
   const openapiFileContent = await fs__default["default"].readFile(openapiPath, "utf8");
   const document = new spectralCore.Document(openapiFileContent, spectralParsers.Yaml, openapiPath);
@@ -72,7 +71,7 @@ async function lint(directoryPath, config) {
 async function bulkCommand(paths = [], options) {
   const resultsList = await runner.runner(
     paths,
-    (dir) => lint(dir, { skipMissingYamlFile: true, strict: !!options.strict })
+    (dir) => lint(dir, { strict: !!options.strict })
   );
   let failed = false;
   for (const { relativeDir, resultText } of resultsList) {
@@ -93,4 +92,4 @@ async function bulkCommand(paths = [], options) {
 }
 
 exports.bulkCommand = bulkCommand;
-//# sourceMappingURL=lint-4f8f9fee.cjs.js.map
+//# sourceMappingURL=lint-5433166f.cjs.js.map

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

@@ -46,4 +46,4 @@ async function runner(paths$1, command, options) {
 }
 
 exports.runner = runner;
-//# sourceMappingURL=runner-0e5fc9a8.cjs.js.map
+//# sourceMappingURL=runner-d5b73286.cjs.js.map

package/dist/cjs/{index-33bf032f.cjs.js → test-df73bb76.cjs.js}

@@ -3,8 +3,8 @@
 var fs = require('fs-extra');
 var path = require('path');
 var chalk = require('chalk');
-var runner = require('./runner-0e5fc9a8.cjs.js');
-var constants = require('./constants-10c5aa52.cjs.js');
+var runner = require('./runner-d5b73286.cjs.js');
+var helpers = require('./helpers-712dfada.cjs.js');
 var paths = require('./paths-9ab9b8a8.cjs.js');
 var exec = require('./exec-7bf444eb.cjs.js');
 require('p-limit');
@@ -21,8 +21,10 @@ var fs__default = /*#__PURE__*/_interopDefaultLegacy(fs);
 var chalk__default = /*#__PURE__*/_interopDefaultLegacy(chalk);
 
 async function test(directoryPath, { port }, options) {
-  const openapiPath = path.join(directoryPath, constants.YAML_SCHEMA_PATH);
-  if (!await fs__default["default"].pathExists(openapiPath)) {
+  let openapiPath = path.join(directoryPath, helpers.YAML_SCHEMA_PATH);
+  try {
+    openapiPath = await helpers.getPathToOpenApiSpec(directoryPath);
+  } catch {
     return;
   }
   const opticConfigFilePath = path.join(directoryPath, "optic.yml");
@@ -41,7 +43,7 @@ async function test(directoryPath, { port }, options) {
     await exec.exec(
       `${opticLocation.trim()} capture`,
       [
-        constants.YAML_SCHEMA_PATH,
+        helpers.YAML_SCHEMA_PATH,
         "--server-override",
         `http://localhost:${port}`,
         (options == null ? void 0 : options.update) ? "--update" : ""
@@ -93,4 +95,4 @@ async function bulkCommand(paths = [], options) {
 }
 
 exports.bulkCommand = bulkCommand;
-//# sourceMappingURL=index-33bf032f.cjs.js.map
+//# sourceMappingURL=test-df73bb76.cjs.js.map

package/dist/cjs/util-40303646.cjs.js

@@ -0,0 +1,31 @@
+'use strict';
+
+var child_process = require('child_process');
+
+function createBinRunner(cwd, path) {
+  return async (...command) => new Promise((resolve, reject) => {
+    child_process.execFile(
+      "node",
+      [path, ...command],
+      {
+        cwd,
+        shell: true,
+        timeout: 6e4,
+        maxBuffer: 1024 * 1024
+      },
+      (err, stdout, stderr) => {
+        if (err) {
+          reject(new Error(`${err.message}
+${stderr}`));
+        } else if (stderr) {
+          reject(new Error(`Command printed error output: ${stderr}`));
+        } else {
+          resolve(stdout);
+        }
+      }
+    );
+  });
+}
+
+exports.createBinRunner = createBinRunner;
+//# sourceMappingURL=util-40303646.cjs.js.map

package/dist/cjs/{verify-8c205e6a.cjs.js → verify-dad6101f.cjs.js}

@@ -6,9 +6,9 @@ var lodash = require('lodash');
 var path = require('path');
 var chalk = require('chalk');
 var Parser = require('@apidevtools/swagger-parser');
-var runner = require('./runner-0e5fc9a8.cjs.js');
+var runner = require('./runner-d5b73286.cjs.js');
 var paths = require('./paths-9ab9b8a8.cjs.js');
-var constants = require('./constants-10c5aa52.cjs.js');
+var helpers = require('./helpers-712dfada.cjs.js');
 require('p-limit');
 require('portfinder');
 require('@backstage/cli-common');
@@ -41,24 +41,26 @@ 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)) {
+  let openapiPath = "";
+  try {
+    openapiPath = await helpers.getPathToOpenApiSpec(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 schemaPath = path.join(directoryPath, constants.TS_SCHEMA_PATH);
+  const schemaPath = path.join(directoryPath, helpers.TS_SCHEMA_PATH);
   if (!await fs__default["default"].pathExists(schemaPath)) {
-    throw new Error(`No \`${constants.TS_SCHEMA_PATH}\` file found.`);
+    throw new Error(`No \`${helpers.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)));
+  const schema = await (function (t) { return Promise.resolve().then(function () { return /*#__PURE__*/_interopNamespace(require(t)); }); })(path.resolve(path.join(directoryPath, helpers.TS_MODULE)));
   if (!schema.spec) {
-    throw new Error(`\`${constants.TS_SCHEMA_PATH}\` needs to have a 'spec' export.`);
+    throw new Error(`\`${helpers.TS_SCHEMA_PATH}\` needs to have a 'spec' export.`);
   }
   if (!lodash.isEqual(schema.spec, 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}\`.`
+      `\`${helpers.YAML_SCHEMA_PATH}\` and \`${helpers.TS_SCHEMA_PATH}\` do not match. Please run \`yarn backstage-repo-tools package schema openapi generate\` from '${path$1}' to regenerate \`${helpers.TS_SCHEMA_PATH}\`.`
     );
   }
 }
@@ -81,4 +83,4 @@ async function bulkCommand(paths = []) {
 }
 
 exports.bulkCommand = bulkCommand;
-//# sourceMappingURL=verify-8c205e6a.cjs.js.map
+//# sourceMappingURL=verify-dad6101f.cjs.js.map

package/dist/index.cjs.js

@@ -44,29 +44,49 @@ ${chalk__default["default"].red(`${error}`)}
   }
 }
 
-function registerSchemaCommand(program) {
-  const command = program.command("schema [command]").description("Various tools for working with API schema");
-  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."
+function registerPackageCommand(program) {
+  const command = program.command("package [command]").description("Various tools for working with specific packages.");
+  const schemaCommand = command.command("schema [command]").description(
+    "Various tools for working with specific packages' API schema"
+  );
+  const openApiCommand = schemaCommand.command("openapi [command]").description("Tooling for OpenAPI schema");
+  openApiCommand.command("init").description(
+    "Initialize any required files to use the OpenAPI tooling for this package."
   ).action(
-    lazy(() => Promise.resolve().then(function () { return require('./cjs/verify-8c205e6a.cjs.js'); }).then((m) => m.bulkCommand))
+    lazy(
+      () => Promise.resolve().then(function () { return require('./cjs/init-3d29e55d.cjs.js'); }).then((m) => m.singleCommand)
+    )
   );
-  openApiCommand.command("generate [paths...]").description(
-    "Generates a Typescript file from an OpenAPI yaml spec. For use with the `@backstage/backend-openapi-utils` ApiRouter type."
+  openApiCommand.command("generate").option(
+    "--client-package [package]",
+    "Top-level path to where the client should be generated, ie packages/catalog-client."
+  ).option("--server").description(
+    "Command to generate a client and/or a server stub from an OpenAPI spec."
   ).action(
-    lazy(() => Promise.resolve().then(function () { return require('./cjs/generate-55ff9dff.cjs.js'); }).then((m) => m.bulkCommand))
+    lazy(
+      () => Promise.resolve().then(function () { return require('./cjs/index-c6ffc4f4.cjs.js'); }).then((m) => m.command)
+    )
+  );
+}
+function registerRepoCommand(program) {
+  const command = program.command("repo [command]").description("Tools for working across your entire repository.");
+  const schemaCommand = command.command("schema [command]").description("Various tools for working with API schema");
+  const openApiCommand = schemaCommand.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-dad6101f.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-4f8f9fee.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-33bf032f.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-1a079f00.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-4e227b44.cjs.js'); }).then((m) => m.singleCommand)
-    )
+  ).action(
+    lazy(() => Promise.resolve().then(function () { return require('./cjs/lint-5433166f.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/test-df73bb76.cjs.js'); }).then((m) => m.bulkCommand))
   );
 }
 function registerCommands(program) {
@@ -93,7 +113,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-143209ff.cjs.js'); }).then((m) => m.buildApiReports)
+      () => Promise.resolve().then(function () { return require('./cjs/api-reports-ebc5b5dd.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)));
@@ -105,12 +125,18 @@ function registerCommands(program) {
     "CI run checks that there are no changes to catalog-info.yaml files"
   ).description("Create or fix info yaml files for all backstage packages").action(
     lazy(
-      () => Promise.resolve().then(function () { return require('./cjs/generate-catalog-info-c0260878.cjs.js'); }).then(
+      () => Promise.resolve().then(function () { return require('./cjs/generate-catalog-info-e7071c1c.cjs.js'); }).then(
         (m) => m.default
       )
     )
   );
-  registerSchemaCommand(program);
+  program.command("knip-reports [paths...]").option("--ci", "CI run checks that there is no changes on knip reports").description("Generate a knip report for selected packages").action(
+    lazy(
+      () => Promise.resolve().then(function () { return require('./cjs/knip-reports-1871d475.cjs.js'); }).then((m) => m.buildKnipReports)
+    )
+  );
+  registerPackageCommand(program);
+  registerRepoCommand(program);
 }
 function lazy(getActionFunc) {
   return async (...args) => {
@@ -125,7 +151,7 @@ function lazy(getActionFunc) {
   };
 }
 
-var version = "0.6.0-next.1";
+var version = "0.6.0-next.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.6.0-next.1",
+  "version": "0.6.0-next.3",
   "publishConfig": {
     "access": "public"
   },
@@ -32,10 +32,10 @@
   "dependencies": {
     "@apidevtools/swagger-parser": "^10.1.0",
     "@apisyouwonthate/style-guide": "^1.4.0",
-    "@backstage/backend-common": "^0.21.0-next.1",
+    "@backstage/backend-common": "^0.21.0-next.3",
     "@backstage/catalog-model": "^1.4.4-next.0",
     "@backstage/cli-common": "^0.1.13",
-    "@backstage/cli-node": "^0.2.2",
+    "@backstage/cli-node": "^0.2.3-next.0",
     "@backstage/errors": "^1.2.3",
     "@manypkg/get-packages": "^1.1.3",
     "@microsoft/api-documenter": "^7.22.33",
@@ -63,8 +63,8 @@
     "yaml-diff-patch": "^2.0.0"
   },
   "devDependencies": {
-    "@backstage/backend-test-utils": "^0.3.0-next.1",
-    "@backstage/cli": "^0.25.2-next.1",
+    "@backstage/backend-test-utils": "^0.3.0-next.3",
+    "@backstage/cli": "^0.25.2-next.3",
     "@backstage/types": "^1.1.1",
     "@types/is-glob": "^4.0.2",
     "@types/node": "^18.17.8",

package/dist/cjs/generate-4e227b44.cjs.js

@@ -1,86 +0,0 @@
-'use strict';
-
-var chalk = require('chalk');
-var path = require('path');
-var constants = require('./constants-10c5aa52.cjs.js');
-var paths = require('./paths-9ab9b8a8.cjs.js');
-var fs = require('fs-extra');
-var exec = require('./exec-7bf444eb.cjs.js');
-var backendCommon = require('@backstage/backend-common');
-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(
-    "node",
-    [
-      backendCommon.resolvePackagePath("@openapitools/openapi-generator-cli", "main.js"),
-      "generate",
-      "-i",
-      resolvedOpenapiPath,
-      "-o",
-      resolvedOutputDirectory,
-      "-g",
-      "typescript",
-      "-c",
-      backendCommon.resolvePackagePath(
-        "@backstage/repo-tools",
-        "templates/typescript-backstage.yaml"
-      ),
-      "--generator-key",
-      "v3.0"
-    ],
-    {
-      maxBuffer: Number.MAX_VALUE,
-      cwd: backendCommon.resolvePackagePath("@backstage/repo-tools"),
-      env: {
-        ...process.env
-      }
-    }
-  );
-  await exec.exec(
-    `yarn backstage-cli package lint --fix ${resolvedOutputDirectory}`
-  );
-  const prettier = paths.paths.resolveTargetRoot("node_modules/.bin/prettier");
-  if (prettier) {
-    await exec.exec(`${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-4e227b44.cjs.js.map

package/dist/cjs/generate-55ff9dff.cjs.js

@@ -1,81 +0,0 @@
-'use strict';
-
-var fs = require('fs-extra');
-var YAML = require('js-yaml');
-var chalk = require('chalk');
-var path = require('path');
-var paths = require('./paths-9ab9b8a8.cjs.js');
-var runner = require('./runner-0e5fc9a8.cjs.js');
-var constants = require('./constants-10c5aa52.cjs.js');
-var util = require('util');
-var child_process = require('child_process');
-require('@backstage/cli-common');
-require('@backstage/cli-node');
-require('minimatch');
-require('p-limit');
-require('portfinder');
-
-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,
-    `//
-
-// ******************************************************************
-// * THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. *
-// ******************************************************************
-import {createValidatedOpenApiRouter} from '@backstage/backend-openapi-utils';
-export const spec = ${JSON.stringify(yaml, null, 2)} as const;
-export const createOpenApiRouter = async (
-  options?: Parameters<typeof createValidatedOpenApiRouter>['1'],
-) => createValidatedOpenApiRouter<typeof spec>(spec, options);
-`
-  );
-  await exec(`yarn backstage-cli package lint --fix ${tsPath}`);
-  if (await paths.paths.resolveTargetRoot("node_modules/.bin/prettier")) {
-    await exec(`yarn prettier --write ${tsPath}`);
-  }
-}
-async function bulkCommand(paths = []) {
-  const resultsList = await runner.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-55ff9dff.cjs.js.map