@backstage/repo-tools 0.1.0-next.1 → 0.1.0-next.2

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @backstage/repo-tools
 
+## 0.1.0-next.2
+
+### Patch Changes
+
+- a8611bcac4: Add new command options to the `api-report`
+
+  - added `--allow-warnings`, `-a` to continue processing packages if selected packages have warnings
+  - added `--allow-all-warnings` to continue processing packages any packages have warnings
+  - added `--omit-messages`, `-o` to pass some warnings messages code to be omitted from the api-report.md files
+  - The `paths` argument for this command now takes as default the value on `workspaces.packages` inside the root package.json
+  - change the path resolution to use the `@backstage/cli-common` packages instead
+
+- Updated dependencies
+  - @backstage/cli-common@0.1.11-next.0
+  - @backstage/errors@1.1.4-next.1
+
 ## 0.1.0-next.1
 
 ### Minor Changes

package/dist/cjs/{api-reports-b4f0424b.cjs.js → api-reports-bc48eddc.cjs.js}

@@ -1,7 +1,7 @@
 'use strict';
 
-var path = require('path');
 var fs = require('fs-extra');
+var path = require('path');
 var child_process = require('child_process');
 var prettier = require('prettier');
 var apiExtractor = require('@microsoft/api-extractor');
@@ -13,11 +13,52 @@ 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 minimatch = require('minimatch');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
 var fs__default = /*#__PURE__*/_interopDefaultLegacy(fs);
 var prettier__default = /*#__PURE__*/_interopDefaultLegacy(prettier);
+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 fullPath = paths.resolveTargetRoot(packageRoot);
+    const dirs = isGlob__default["default"](fullPath) ? await glob(fullPath) : [fullPath];
+    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))
@@ -38,8 +79,7 @@ var __privateSet = (obj, member, value, setter) => {
   return value;
 };
 var _tokens;
-const tmpDir = path.resolve(
-  process.cwd(),
+const tmpDir = paths.resolveTargetRoot(
   "./node_modules/.cache/api-extractor"
 );
 const {
@@ -131,61 +171,8 @@ ApiReportGenerator.generateReviewFileContent = function decoratedGenerateReviewF
     parser: "markdown"
   });
 };
-const PACKAGE_ROOTS = ["packages", "plugins"];
-const ALLOW_WARNINGS = [
-  "packages/core-components",
-  "plugins/catalog",
-  "plugins/catalog-import",
-  "plugins/git-release-manager",
-  "plugins/jenkins",
-  "plugins/kubernetes"
-];
-async function resolvePackagePath(packagePath) {
-  const projectRoot = path.resolve(process.cwd());
-  const fullPackageDir = path.resolve(projectRoot, packagePath);
-  const stat = await fs__default["default"].stat(fullPackageDir);
-  if (!stat.isDirectory()) {
-    return void 0;
-  }
-  try {
-    const packageJsonPath = path.join(fullPackageDir, "package.json");
-    await fs__default["default"].access(packageJsonPath);
-  } catch (_) {
-    return void 0;
-  }
-  return path.relative(projectRoot, fullPackageDir);
-}
-async function findSpecificPackageDirs(unresolvedPackageDirs) {
-  const packageDirs = new Array();
-  for (const unresolvedPackageDir of unresolvedPackageDirs) {
-    const packageDir = await resolvePackagePath(unresolvedPackageDir);
-    if (!packageDir) {
-      throw new Error(`'${unresolvedPackageDir}' is not a valid package path`);
-    }
-    packageDirs.push(packageDir);
-  }
-  if (packageDirs.length === 0) {
-    return void 0;
-  }
-  return packageDirs;
-}
-async function findPackageDirs() {
-  const packageDirs = new Array();
-  const projectRoot = path.resolve(process.cwd());
-  for (const packageRoot of PACKAGE_ROOTS) {
-    const dirs = await fs__default["default"].readdir(path.resolve(projectRoot, packageRoot));
-    for (const dir of dirs) {
-      const packageDir = await resolvePackagePath(path.join(packageRoot, dir));
-      if (!packageDir) {
-        continue;
-      }
-      packageDirs.push(packageDir);
-    }
-  }
-  return packageDirs;
-}
 async function createTemporaryTsConfig(includedPackageDirs) {
-  const path$1 = path.resolve(process.cwd(), "tsconfig.tmp.json");
+  const path$1 = paths.resolveTargetRoot("tsconfig.tmp.json");
   process.once("exit", () => {
     fs__default["default"].removeSync(path$1);
   });
@@ -254,22 +241,30 @@ async function runApiExtraction({
   packageDirs,
   outputDir,
   isLocalBuild,
-  tsconfigFilePath
+  tsconfigFilePath,
+  allowWarnings = false,
+  omitMessages = []
 }) {
   await fs__default["default"].remove(outputDir);
   const entryPoints = packageDirs.map((packageDir) => {
-    return path.resolve(
-      process.cwd(),
+    return paths.resolveTargetRoot(
       `./dist-types/${packageDir}/src/index.d.ts`
     );
   });
   let compilerState = void 0;
+  const allowWarningPkg = Array.isArray(allowWarnings) ? allowWarnings : [];
+  const messagesConf = {};
+  for (const messageCode of omitMessages) {
+    messagesConf[messageCode] = {
+      logLevel: "none"
+    };
+  }
   const warnings = new Array();
   for (const packageDir of packageDirs) {
     console.log(`## Processing ${packageDir}`);
-    const projectFolder = path.resolve(process.cwd(), packageDir);
-    const packageFolder = path.resolve(
-      process.cwd(),
+    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(
       "./dist-types",
       packageDir
     );
@@ -310,7 +305,8 @@ async function runApiExtraction({
             default: {
               logLevel: "warning",
               addToApiReportFile: true
-            }
+            },
+            ...messagesConf
           },
           tsdocMessageReporting: {
             default: {
@@ -377,12 +373,15 @@ async function runApiExtraction({
       );
     }
     const warningCountAfter = await countApiReportWarnings(projectFolder);
-    if (warningCountAfter > 0 && !ALLOW_WARNINGS.includes(packageDir)) {
+    if (noBail) {
+      console.log(`Skipping warnings check for ${packageDir}`);
+    }
+    if (warningCountAfter > 0 && !noBail) {
       throw new Error(
         `The API Report for ${packageDir} is not allowed to have warnings`
       );
     }
-    if (warningCountAfter === 0 && ALLOW_WARNINGS.includes(packageDir)) {
+    if (warningCountAfter === 0 && allowWarningPkg.includes(packageDir)) {
       console.log(
         `No need to allow warnings for ${packageDir}, it does not have any`
       );
@@ -816,7 +815,7 @@ async function buildDocs({
   await fs__default["default"].ensureDir(outputDir);
   documenter.generateFiles();
 }
-async function categorizePackageDirs(projectRoot, packageDirs) {
+async function categorizePackageDirs(packageDirs) {
   const dirs = packageDirs.slice();
   const tsPackageDirs = new Array();
   const cliPackageDirs = new Array();
@@ -828,7 +827,7 @@ async function categorizePackageDirs(projectRoot, packageDirs) {
         if (!dir) {
           return;
         }
-        const pkgJson = await fs__default["default"].readJson(path.resolve(projectRoot, dir, "package.json")).catch((error) => {
+        const pkgJson = await fs__default["default"].readJson(paths.resolveTargetRoot(dir, "package.json")).catch((error) => {
           if (error.code === "ENOENT") {
             return void 0;
           }
@@ -878,6 +877,7 @@ function parseHelpPage(helpPageContent) {
   const lines = helpPageContent.split(/\r?\n/);
   let options = new Array();
   let commands = new Array();
+  let commandArguments = new Array();
   while (lines.length > 0) {
     while (lines.length > 0 && !lines[0].endsWith(":")) {
       lines.shift();
@@ -897,6 +897,8 @@ function parseHelpPage(helpPageContent) {
         options = sectionItems;
       } else if ((sectionName == null ? void 0 : sectionName.toLocaleLowerCase("en-US")) === "commands:") {
         commands = sectionItems;
+      } else if ((sectionName == null ? void 0 : sectionName.toLocaleLowerCase("en-US")) === "arguments:") {
+        commandArguments = sectionItems;
       } else {
         throw new Error(`Unknown CLI section: ${sectionName}`);
       }
@@ -905,7 +907,8 @@ function parseHelpPage(helpPageContent) {
   return {
     usage,
     options,
-    commands
+    commands,
+    commandArguments
   };
 }
 async function exploreCliHelpPages(run) {
@@ -955,13 +958,12 @@ function generateCliReport(name, models) {
   return content.join("\n");
 }
 async function runCliExtraction({
-  projectRoot,
   packageDirs,
   isLocalBuild
 }) {
   for (const packageDir of packageDirs) {
     console.log(`## Processing ${packageDir}`);
-    const fullDir = path.resolve(projectRoot, packageDir);
+    const fullDir = 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`);
@@ -996,7 +998,7 @@ async function runCliExtraction({
           console.log("");
           console.log(
             `The conflicting file is ${path.relative(
-              projectRoot,
+              paths.targetRoot,
               reportPath
             )}, expecting the following content:`
           );
@@ -1010,29 +1012,48 @@ async function runCliExtraction({
   }
 }
 
-var apiReports = async (paths, opts) => {
-  const tmpDir = path.resolve(
-    process.cwd(),
+async function generateTypeDeclarations(tsconfigFilePath) {
+  await fs__default["default"].remove(paths.resolveTargetRoot("dist-types"));
+  const { status } = child_process.spawnSync(
+    "yarn",
+    [
+      "tsc",
+      ["--project", tsconfigFilePath],
+      ["--skipLibCheck", "false"],
+      ["--incremental", "false"]
+    ].flat(),
+    {
+      stdio: "inherit",
+      shell: true,
+      cwd: paths.targetRoot
+    }
+  );
+  if (status !== 0) {
+    process.exit(status || void 0);
+  }
+}
+
+const buildApiReports = async (paths$1 = [], opts) => {
+  const tmpDir = paths.resolveTargetRoot(
     "./node_modules/.cache/api-extractor"
   );
-  const projectRoot = path.resolve(process.cwd());
   const isCiBuild = opts.ci;
   const isDocsBuild = opts.docs;
   const runTsc = opts.tsc;
-  const selectedPackageDirs = await findSpecificPackageDirs(paths);
-  if (selectedPackageDirs && isCiBuild) {
-    throw new Error(
-      "Package path arguments are not supported together with the --ci flag"
-    );
-  }
-  if (!selectedPackageDirs && !isCiBuild && !isDocsBuild) {
+  const allowWarnings = parseArrayOption(opts.allowWarnings);
+  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);
+  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"
+      "       yarn build:api-reports packages/config packages/core-plugin-api plugins/*"
     );
     console.log("");
   }
@@ -1040,31 +1061,13 @@ var apiReports = async (paths, opts) => {
   if (selectedPackageDirs) {
     temporaryTsConfigPath = await createTemporaryTsConfig(selectedPackageDirs);
   }
-  const tsconfigFilePath = temporaryTsConfigPath != null ? temporaryTsConfigPath : path.resolve(projectRoot, "tsconfig.json");
+  const tsconfigFilePath = temporaryTsConfigPath != null ? temporaryTsConfigPath : paths.resolveTargetRoot("tsconfig.json");
   if (runTsc) {
-    await fs__default["default"].remove(path.resolve(projectRoot, "dist-types"));
-    const { status } = child_process.spawnSync(
-      "yarn",
-      [
-        "tsc",
-        ["--project", tsconfigFilePath],
-        ["--skipLibCheck", "false"],
-        ["--incremental", "false"]
-      ].flat(),
-      {
-        stdio: "inherit",
-        shell: true,
-        cwd: projectRoot
-      }
-    );
-    if (status !== 0) {
-      process.exit(status || void 0);
-    }
+    console.log("# Compiling TypeScript");
+    await generateTypeDeclarations(tsconfigFilePath);
   }
-  const packageDirs = selectedPackageDirs != null ? selectedPackageDirs : await findPackageDirs();
   const { tsPackageDirs, cliPackageDirs } = await categorizePackageDirs(
-    projectRoot,
-    packageDirs
+    selectedPackageDirs
   );
   if (tsPackageDirs.length > 0) {
     console.log("# Generating package API reports");
@@ -1072,13 +1075,14 @@ var apiReports = async (paths, opts) => {
       packageDirs: tsPackageDirs,
       outputDir: tmpDir,
       isLocalBuild: !isCiBuild,
-      tsconfigFilePath
+      tsconfigFilePath,
+      allowWarnings: allowAllWarnings || allowWarnings,
+      omitMessages: Array.isArray(omitMessages) ? omitMessages : []
     });
   }
   if (cliPackageDirs.length > 0) {
     console.log("# Generating package CLI reports");
     await runCliExtraction({
-      projectRoot,
       packageDirs: cliPackageDirs,
       isLocalBuild: !isCiBuild
     });
@@ -1087,10 +1091,24 @@ var apiReports = async (paths, opts) => {
     console.log("# Generating package documentation");
     await buildDocs({
       inputDir: tmpDir,
-      outputDir: path.resolve(projectRoot, "docs/reference")
+      outputDir: 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["default"] = apiReports;
-//# sourceMappingURL=api-reports-b4f0424b.cjs.js.map
+exports.buildApiReports = buildApiReports;
+//# sourceMappingURL=api-reports-bc48eddc.cjs.js.map

package/dist/index.cjs.js

@@ -38,8 +38,20 @@ ${chalk__default["default"].red(`${error}`)}
 }
 
 function registerCommands(program) {
-  program.command("api-reports [path...]").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").description("Generate an API report for selected packages").action(
-    lazy(() => Promise.resolve().then(function () { return require('./cjs/api-reports-b4f0424b.cjs.js'); }).then((m) => m.default))
+  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(
+    "-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(
+    "--allow-all-warnings",
+    "continue processing packages after getting errors on all packages",
+    false
+  ).option(
+    "-o, --omit-messages <messageCodes>",
+    "select some message code to be omited on the API Extractor (comma separated values i.e ae-cyclic-inherit-doc,ae-missing-getter )"
+  ).description("Generate an API report for selected packages").action(
+    lazy(
+      () => Promise.resolve().then(function () { return require('./cjs/api-reports-bc48eddc.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-fba15630.cjs.js'); }).then((m) => m.default)));
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@backstage/repo-tools",
   "description": "CLI for Backstage repo tooling ",
-  "version": "0.1.0-next.1",
+  "version": "0.1.0-next.2",
   "publishConfig": {
     "access": "public"
   },
@@ -30,6 +30,7 @@
     "backstage-repo-tools": "bin/backstage-repo-tools"
   },
   "dependencies": {
+    "@backstage/cli-common": "^0.1.11-next.0",
     "@backstage/errors": "^1.1.4-next.1",
     "@manypkg/get-packages": "^1.1.3",
     "@microsoft/api-documenter": "^7.17.11",
@@ -39,8 +40,17 @@
     "chalk": "^4.0.0",
     "commander": "^9.1.0",
     "fs-extra": "10.1.0",
+    "glob": "^8.0.3",
+    "is-glob": "^4.0.3",
+    "minimatch": "^5.1.1",
     "ts-node": "^10.0.0"
   },
+  "devDependencies": {
+    "@backstage/cli": "^0.22.0-next.4",
+    "@types/is-glob": "^4.0.2",
+    "@types/mock-fs": "^4.13.0",
+    "mock-fs": "^5.1.0"
+  },
   "files": [
     "bin",
     "dist/**/*.js"