@backstage/repo-tools 0.1.2 → 0.1.3-next.0

package/CHANGELOG.md

@@ -1,5 +1,15 @@
 # @backstage/repo-tools
 
+## 0.1.3-next.0
+
+### Patch Changes
+
+- 32a4a05838: Tweaked type dependency check to trim wildcard type imports.
+- 6ba8faf22a: The API report generation process is now able to detect and generate reports for additional entry points declared in the package `"exports"` field.
+- Updated dependencies
+  - @backstage/cli-common@0.1.11
+  - @backstage/errors@1.1.4
+
 ## 0.1.2
 
 ### Patch Changes

package/dist/cjs/{api-reports-a8ff4901.cjs.js → index/api-reports-a4583315.cjs.js}

@@ -17,6 +17,7 @@ var g = require('glob');
 var isGlob = require('is-glob');
 var util = require('util');
 var minimatch = require('minimatch');
+var entryPoints = require('./entryPoints-c420d90d.cjs.js');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
@@ -193,10 +194,9 @@ async function createTemporaryTsConfig(includedPackageDirs) {
   });
   return path$1;
 }
-async function countApiReportWarnings(projectFolder) {
-  const path$1 = path.resolve(projectFolder, "api-report.md");
+async function countApiReportWarnings(reportPath) {
   try {
-    const content = await fs__default["default"].readFile(path$1, "utf8");
+    const content = await fs__default["default"].readFile(reportPath, "utf8");
     const lines = content.split("\n");
     const lineWarnings = lines.filter(
       (line) => line.includes("// Warning:")
@@ -245,18 +245,37 @@ function logApiReportInstructions() {
   );
   console.log("");
 }
+async function findPackageEntryPoints(packageDirs) {
+  return Promise.all(
+    packageDirs.map(async (packageDir) => {
+      var _a, _b, _c, _d;
+      const pkg = await fs__default["default"].readJson(
+        paths.resolveTargetRoot(packageDir, "package.json")
+      );
+      return (_d = (_a = entryPoints.getPackageExportNames(pkg)) == null ? void 0 : _a.map((name) => ({ packageDir, name }))) != null ? _d : {
+        packageDir,
+        name: "index",
+        usesExperimentalTypeBuild: (_c = (_b = pkg.scripts) == null ? void 0 : _b.build) == null ? void 0 : _c.includes(
+          "--experimental-type-build"
+        )
+      };
+    })
+  ).then((results) => results.flat());
+}
 async function runApiExtraction({
   packageDirs,
   outputDir,
   isLocalBuild,
   tsconfigFilePath,
   allowWarnings = false,
-  omitMessages = []
+  omitMessages = [],
+  validateReleaseTags = false
 }) {
   await fs__default["default"].remove(outputDir);
-  const entryPoints = packageDirs.map((packageDir) => {
+  const packageEntryPoints = await findPackageEntryPoints(packageDirs);
+  const entryPoints = packageEntryPoints.map(({ packageDir, name }) => {
     return paths.resolveTargetRoot(
-      `./dist-types/${packageDir}/src/index.d.ts`
+      `./dist-types/${packageDir}/src/${name}.d.ts`
     );
   });
   let compilerState = void 0;
@@ -268,7 +287,11 @@ async function runApiExtraction({
     };
   }
   const warnings = new Array();
-  for (const packageDir of packageDirs) {
+  for (const {
+    packageDir,
+    name,
+    usesExperimentalTypeBuild
+  } of packageEntryPoints) {
     console.log(`## Processing ${packageDir}`);
     const noBail = Array.isArray(allowWarnings) ? allowWarnings.some((aw) => aw === packageDir || minimatch__default["default"](packageDir, aw)) : allowWarnings;
     const projectFolder = paths.resolveTargetRoot(packageDir);
@@ -276,25 +299,33 @@ async function runApiExtraction({
       "./dist-types",
       packageDir
     );
-    const warningCountBefore = await countApiReportWarnings(projectFolder);
+    const prefix = name === "index" ? "" : `${name}-`;
+    const reportFileName = `${prefix}api-report.md`;
+    const reportPath = path.resolve(projectFolder, reportFileName);
+    const warningCountBefore = await countApiReportWarnings(reportPath);
     const extractorConfig = apiExtractor.ExtractorConfig.prepare({
       configObject: {
-        mainEntryPointFilePath: path.resolve(packageFolder, "src/index.d.ts"),
+        mainEntryPointFilePath: path.resolve(packageFolder, `src/${name}.d.ts`),
         bundledPackages: [],
         compiler: {
           tsconfigFilePath
         },
         apiReport: {
           enabled: true,
-          reportFileName: "api-report.md",
+          reportFileName,
           reportFolder: projectFolder,
-          reportTempFolder: path.resolve(outputDir, "<unscopedPackageName>")
+          reportTempFolder: path.resolve(
+            outputDir,
+            `${prefix}<unscopedPackageName>`
+          )
         },
         docModel: {
-          enabled: true,
+          // TODO(Rugvip): This skips docs for non-index entry points. We can try to work around it, but
+          //               most likely it makes sense to wait for API Extractor to natively support exports.
+          enabled: name === "index",
           apiJsonFilePath: path.resolve(
             outputDir,
-            "<unscopedPackageName>.api.json"
+            `${prefix}<unscopedPackageName>.api.json`
           )
         },
         dtsRollup: {
@@ -363,6 +394,28 @@ async function runApiExtraction({
       },
       compilerState
     });
+    if (validateReleaseTags && !usesExperimentalTypeBuild) {
+      if (["index", "alpha", "beta"].includes(name)) {
+        const report = await fs__default["default"].readFile(
+          extractorConfig.reportFilePath,
+          "utf8"
+        );
+        const lines = report.split(/\r?\n/);
+        const expectedTag = name === "index" ? "public" : name;
+        for (let i = 0; i < lines.length; i += 1) {
+          const line = lines[i];
+          const match = line.match(/^\/\/ @(alpha|beta|public)/);
+          if (match && match[1] !== expectedTag) {
+            if (expectedTag !== "public" && match[1] === "public") {
+              continue;
+            }
+            throw new Error(
+              `Unexpected release tag ${match[1]} in ${extractorConfig.reportFilePath} at line ${i + 1}`
+            );
+          }
+        }
+      }
+    }
     if (!extractorResult.succeeded) {
       if (shouldLogInstructions) {
         logApiReportInstructions();
@@ -384,7 +437,7 @@ async function runApiExtraction({
         `API Extractor completed with ${extractorResult.errorCount} errors and ${extractorResult.warningCount} warnings`
       );
     }
-    const warningCountAfter = await countApiReportWarnings(projectFolder);
+    const warningCountAfter = await countApiReportWarnings(reportPath);
     if (noBail) {
       console.log(`Skipping warnings check for ${packageDir}`);
     }
@@ -1102,7 +1155,8 @@ const buildApiReports = async (paths$1 = [], opts) => {
       isLocalBuild: !isCiBuild,
       tsconfigFilePath,
       allowWarnings: allowAllWarnings || allowWarnings,
-      omitMessages: Array.isArray(omitMessages) ? omitMessages : []
+      omitMessages: Array.isArray(omitMessages) ? omitMessages : [],
+      validateReleaseTags: opts.validateReleaseTags
     });
   }
   if (cliPackageDirs.length > 0) {
@@ -1136,4 +1190,4 @@ function parseArrayOption(value) {
 }
 
 exports.buildApiReports = buildApiReports;
-//# sourceMappingURL=api-reports-a8ff4901.cjs.js.map
+//# sourceMappingURL=api-reports-a4583315.cjs.js.map

package/dist/cjs/index/entryPoints-c420d90d.cjs.js

@@ -0,0 +1,26 @@
+'use strict';
+
+var path = require('path');
+
+function getPackageExportNames(pkg) {
+  if (pkg.exports && typeof pkg.exports !== "string") {
+    return Object.entries(pkg.exports).flatMap(([mount, path$1]) => {
+      const ext = path.extname(String(path$1));
+      if (![".ts", ".tsx", ".cts", ".mts"].includes(ext)) {
+        return [];
+      }
+      let name = mount;
+      if (name.startsWith("./")) {
+        name = name.slice(2);
+      }
+      if (!name || name === ".") {
+        return ["index"];
+      }
+      return [name];
+    });
+  }
+  return void 0;
+}
+
+exports.getPackageExportNames = getPackageExportNames;
+//# sourceMappingURL=entryPoints-c420d90d.cjs.js.map

package/dist/cjs/{type-deps-fba15630.cjs.js → index/type-deps-db1fb735.cjs.js}

@@ -4,6 +4,7 @@ var fs = require('fs');
 var path = require('path');
 var chalk = require('chalk');
 var getPackages = require('@manypkg/get-packages');
+var entryPoints = require('./entryPoints-c420d90d.cjs.js');
 
 function _interopDefaultLegacy (e) { return e && typeof e === 'object' && 'default' in e ? e : { 'default': e }; }
 
@@ -63,15 +64,22 @@ function findAllDeps(declSrc) {
   return Array.from(/* @__PURE__ */ new Set([...importedDeps, ...referencedDeps]));
 }
 function checkTypes(pkg) {
-  const typeDecl = fs__default["default"].readFileSync(
-    path.resolve(pkg.dir, "dist/index.d.ts"),
-    "utf8"
-  );
-  const allDeps = findAllDeps(typeDecl);
+  var _a;
+  const entryPointNames = (_a = entryPoints.getPackageExportNames(pkg.packageJson)) != null ? _a : ["index"];
+  const allDeps = entryPointNames.flatMap((name) => {
+    const typeDecl = fs__default["default"].readFileSync(
+      path.resolve(pkg.dir, `dist/${name}.d.ts`),
+      "utf8"
+    );
+    return findAllDeps(typeDecl);
+  });
   const deps = Array.from(new Set(allDeps));
   const errors = [];
   const typeDeps = [];
-  for (const dep of deps) {
+  for (let dep of deps) {
+    if (dep.endsWith("/*")) {
+      dep = dep.slice(0, -2);
+    }
     try {
       const typeDep = findTypesPackage(dep, pkg);
       if (typeDep) {
@@ -166,4 +174,4 @@ function mkErr(name, msg, extra) {
 }
 
 exports["default"] = typeDeps;
-//# sourceMappingURL=type-deps-fba15630.cjs.js.map
+//# sourceMappingURL=type-deps-db1fb735.cjs.js.map

package/dist/index.cjs.js

@@ -48,12 +48,15 @@ function registerCommands(program) {
   ).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 )"
+  ).option(
+    "--validate-release-tags",
+    "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-a8ff4901.cjs.js'); }).then((m) => m.buildApiReports)
+      () => Promise.resolve().then(function () { return require('./cjs/index/api-reports-a4583315.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)));
+  program.command("type-deps").description("Find inconsistencies in types of all packages and plugins").action(lazy(() => Promise.resolve().then(function () { return require('./cjs/index/type-deps-db1fb735.cjs.js'); }).then((m) => m.default)));
 }
 function lazy(getActionFunc) {
   return async (...args) => {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@backstage/repo-tools",
   "description": "CLI for Backstage repo tooling ",
-  "version": "0.1.2",
+  "version": "0.1.3-next.0",
   "publishConfig": {
     "access": "public"
   },
@@ -44,7 +44,8 @@
     "ts-node": "^10.0.0"
   },
   "devDependencies": {
-    "@backstage/cli": "^0.22.2",
+    "@backstage/cli": "^0.22.4-next.0",
+    "@backstage/types": "^1.0.2",
     "@types/is-glob": "^4.0.2",
     "@types/mock-fs": "^4.13.0",
     "mock-fs": "^5.1.0"