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

package/CHANGELOG.md

@@ -1,5 +1,22 @@
 # @backstage/repo-tools
 
+## 0.2.0
+
+### 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
+
+- f59041a3c07: Package paths provided to `api-reports` and OpenAPI commands will now match any path within the target package.
+- f59041a3c07: Added `--include <patterns>` and `--exclude <patterns>` options for `api-reports` command that work based on package names.
+- 9129ca8cabb: Log API report instructions when api-report is missing.
+- e0c6e8b9c3c: Update peer dependencies
+- Updated dependencies
+  - @backstage/cli-node@0.1.0
+  - @backstage/cli-common@0.1.12
+  - @backstage/errors@1.1.5
+
 ## 0.2.0-next.2
 
 ### Minor Changes

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

@@ -12,13 +12,11 @@ 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-5e048aab.cjs.js');
+var paths = require('./paths-9ab9b8a8.cjs.js');
 var minimatch = require('minimatch');
 var entryPoints = require('./entryPoints-c9b88245.cjs.js');
 require('@backstage/cli-common');
-require('glob');
-require('is-glob');
-require('util');
+require('@backstage/cli-node');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
@@ -1092,7 +1090,11 @@ 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 selectedPackageDirs = await paths.getMatchingWorkspacePaths(paths$1);
+  const selectedPackageDirs = await paths.resolvePackagePaths({
+    paths: paths$1,
+    include: opts.include,
+    exclude: opts.exclude
+  });
   if (isAllPackages && !isCiBuild && !isDocsBuild) {
     console.log("");
     console.log(
@@ -1148,4 +1150,4 @@ function parseArrayOption(value) {
 }
 
 exports.buildApiReports = buildApiReports;
-//# sourceMappingURL=api-reports-6ef2363c.cjs.js.map
+//# sourceMappingURL=api-reports-c4f9a18d.cjs.js.map

package/dist/cjs/{constants-a9b2f484.cjs.js → constants-d6934676.cjs.js}

@@ -1,6 +1,6 @@
 'use strict';
 
-var paths = require('./paths-5e048aab.cjs.js');
+var paths = require('./paths-9ab9b8a8.cjs.js');
 var pLimit = require('p-limit');
 var path = require('path');
 
@@ -9,7 +9,7 @@ function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'defau
 var pLimit__default = /*#__PURE__*/_interopDefaultLegacy(pLimit);
 
 async function runner(paths$1, command) {
-  const packages = await paths.getMatchingWorkspacePaths(paths$1);
+  const packages = await paths.resolvePackagePaths({ paths: paths$1 });
   const limit = pLimit__default["default"](5);
   const resultsList = await Promise.all(
     packages.map(
@@ -39,4 +39,4 @@ 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
+//# sourceMappingURL=constants-d6934676.cjs.js.map

package/dist/cjs/{generate-d9406b4d.cjs.js → generate-9b41d8d7.cjs.js}

@@ -4,13 +4,13 @@ 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 constants = require('./constants-d6934676.cjs.js');
 var util = require('util');
 var child_process = require('child_process');
-require('./paths-5e048aab.cjs.js');
+require('./paths-9ab9b8a8.cjs.js');
 require('@backstage/cli-common');
-require('glob');
-require('is-glob');
+require('@backstage/cli-node');
+require('minimatch');
 require('p-limit');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
@@ -63,4 +63,4 @@ async function bulkCommand(paths = []) {
 }
 
 exports.bulkCommand = bulkCommand;
-//# sourceMappingURL=generate-d9406b4d.cjs.js.map
+//# sourceMappingURL=generate-9b41d8d7.cjs.js.map

package/dist/cjs/paths-9ab9b8a8.cjs.js

@@ -0,0 +1,49 @@
+'use strict';
+
+var cliCommon = require('@backstage/cli-common');
+var cliNode = require('@backstage/cli-node');
+var minimatch = require('minimatch');
+var path = require('path');
+
+const paths = cliCommon.findPaths(__dirname);
+async function resolvePackagePaths(options = {}) {
+  const { paths: providedPaths, include, exclude } = options;
+  let packages = await cliNode.PackageGraph.listTargetPackages();
+  if (providedPaths && providedPaths.length > 0) {
+    packages = packages.filter(
+      ({ dir }) => providedPaths.some(
+        (path$1) => new minimatch.Minimatch(path$1).match(path.relative(paths.targetRoot, dir)) || isChildPath(dir, path$1)
+      )
+    );
+  }
+  if (include) {
+    packages = packages.filter(
+      (pkg) => include.some(
+        (pattern) => new minimatch.Minimatch(pattern).match(path.relative(paths.targetRoot, pkg.dir))
+      )
+    );
+  }
+  if (exclude) {
+    packages = packages.filter(
+      (pkg) => exclude.some(
+        (pattern) => !new minimatch.Minimatch(pattern).match(
+          path.relative(paths.targetRoot, pkg.dir)
+        )
+      )
+    );
+  }
+  return packages.map((pkg) => path.relative(paths.targetRoot, pkg.dir));
+}
+function isChildPath(base, path$1) {
+  const relative = path.relative(base, path$1);
+  if (relative === "") {
+    return true;
+  }
+  const outsideBase = relative.startsWith("..");
+  const differentDrive = path.isAbsolute(relative);
+  return !outsideBase && !differentDrive;
+}
+
+exports.paths = paths;
+exports.resolvePackagePaths = resolvePackagePaths;
+//# sourceMappingURL=paths-9ab9b8a8.cjs.js.map

package/dist/cjs/{verify-47d1fef6.cjs.js → verify-be04e091.cjs.js}

@@ -6,13 +6,12 @@ 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');
+var constants = require('./constants-d6934676.cjs.js');
+var paths = require('./paths-9ab9b8a8.cjs.js');
 require('p-limit');
 require('@backstage/cli-common');
-require('glob');
-require('is-glob');
-require('util');
+require('@backstage/cli-node');
+require('minimatch');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
@@ -80,4 +79,4 @@ async function bulkCommand(paths = []) {
 }
 
 exports.bulkCommand = bulkCommand;
-//# sourceMappingURL=verify-47d1fef6.cjs.js.map
+//# sourceMappingURL=verify-be04e091.cjs.js.map

package/dist/index.cjs.js

@@ -39,6 +39,14 @@ ${chalk__default["default"].red(`${error}`)}
 
 function registerCommands(program) {
   program.command("api-reports [paths...]").option("--ci", "CI run checks that there is no changes on API reports").option("--tsc", "executes the tsc compilation before extracting the APIs").option("--docs", "generates the api documentation").option(
+    "--include <pattern>",
+    "Only include packages matching the provided patterns",
+    (opt, opts = []) => [...opts, ...opt.split(",")]
+  ).option(
+    "--exclude <pattern>",
+    "Exclude package matching the provided patterns",
+    (opt, opts = []) => [...opts, ...opt.split(",")]
+  ).option(
     "-a, --allow-warnings <allowWarningsPaths>",
     "continue processing packages after getting errors on selected packages Allows glob patterns and comma separated values (i.e. packages/core,plugins/core-*)"
   ).option(
@@ -53,16 +61,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-6ef2363c.cjs.js'); }).then((m) => m.buildApiReports)
+      () => Promise.resolve().then(function () { return require('./cjs/api-reports-c4f9a18d.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)));
+  ).action(lazy(() => Promise.resolve().then(function () { return require('./cjs/verify-be04e091.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)));
+  ).action(lazy(() => Promise.resolve().then(function () { return require('./cjs/generate-9b41d8d7.cjs.js'); }).then((m) => m.bulkCommand)));
 }
 function lazy(getActionFunc) {
   return async (...args) => {
@@ -77,8 +85,10 @@ function lazy(getActionFunc) {
   };
 }
 
+var version = "0.2.0";
+
 const main = (argv) => {
-  commander.program.name("backstage-repo-tools").version("1.0");
+  commander.program.name("backstage-repo-tools").version(version);
   registerCommands(commander.program);
   commander.program.on("command:*", () => {
     console.log();

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@backstage/repo-tools",
   "description": "CLI for Backstage repo tooling ",
-  "version": "0.2.0-next.2",
+  "version": "0.2.0",
   "publishConfig": {
     "access": "public"
   },
@@ -32,6 +32,7 @@
   "dependencies": {
     "@apidevtools/swagger-parser": "^10.1.0",
     "@backstage/cli-common": "^0.1.12",
+    "@backstage/cli-node": "^0.1.0",
     "@backstage/errors": "^1.1.5",
     "@manypkg/get-packages": "^1.1.3",
     "@microsoft/api-documenter": "^7.19.27",
@@ -48,7 +49,7 @@
     "ts-node": "^10.0.0"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.22.6-next.3",
+    "@backstage/cli": "^0.22.6",
     "@backstage/types": "^1.0.2",
     "@types/is-glob": "^4.0.2",
     "@types/mock-fs": "^4.13.0",

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

@@ -1,66 +0,0 @@
-'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